hl-yojimbo

THIS PROJECT IS IN PROGRESS - DO NOT CLONE, IT DOES NOT WORK

Build and Install

Note: Most of the following steps are common on windows, linux and mac. The only difference is in the build & install step.

1. Prerequisites:

1.1. Install haxe: (: https://haxe.org/download)
1.2. Install hashlink: (https://hashlink.haxe.org )
1.3. Install heaps: (For linux: https://heaps.io/documentation/installation.html )
1.4. Install the modified webidl from git:

haxelib git hl-idl https://github.com/onehundredfeet/hl-idl.git

2. Build

2.1. Clone this repo into a clean directory.

Open new terminal in this directory.

haxelib dev hl-yojimbo hl-yojimbo

This tells haxe to look for the library 'hl-yojimbo' in the directory 'hl-yojimbo'. The 'dev' keyword tells haxe that the library is local and will be directly referenced instead of being installed to the library cache.

2.2 Clone yojimbo c++ sources as a submodule in hl-yojimbo From the hl-yojimbo root, run

git submodule update --init --recursive

2.3 Generate the binding cpp file.

Change directory into the hl-yojimbo root.

.Open new terminal under and run

make genhl

This will generate src/yojimbo.cpp from yojimbo/yojimbo.idl

2.4 Generate cmake and build.
Note: At this step there are differences between platforms
Create new dir : HL-YOJIMBO-ROOT/build
Open new terminal in the directory HL-YOJIMBO-ROOT/build and run:

For linux:

    cmake ..
      -DYOJIMBO_SRC_DIR="ext/yojimbo" # This is the /src from step 2
      -DHL_INCLUDE_DIR="<path-to-hashlink headers>" # Path to where hashlink headers (hl.h, ...) are located. Usually under ...hashlink-x.xx/src 
      -DHL_LIB_DIR="<path-to-hashlink>" # Path to where hashlink binaries (libhl.so, ...) are located. Usually ...hashlink-x.xx
      -HDLL_DESTINATION="final/install/destination" #The path of all *hdll binaries, usually this is 'usr/lib' or 'usr/local/lib'

    make

    make install

DEVELOPER NOTE: YOJIMBO WILL REQUIRE MULTIPLE SOURCE DIRS. They have submodules netcode.io reliable.io

specific cmake command example on linux:

    cmake .. -DYOJIMBO_SRC_DIR="ext/yojimbo" -DHL_INCLUDE_DIR="/usr/local/include" -DHL_LIB_DIR="/usr/local/lib" -DHDLL_DESTINATION="/usr/local/lib"

For windows:

    cmake .. -A x64 -G "Visual Studio 15 2017" 
    -DYOJIMBO_SRC_DIR="<path-to-bullet3>/src" # This is the /src from step 2
      -DHL_INCLUDE_DIR="<path-to-hashlink>/include"
      -DHL_LIB_DIR="<path-to-hashlink>"  # Path to where hashlink binaries (libhl.lib, ...) are located
      -HDLL_DESTINATION="final/install/destination" # Usually <path-to-hashlink>

• Open and build build/Project.sln
• Copy ./build/Debug/bullet.hdll to ../path/to/HashLink/hdll/location/ # Just in case Visual Studio install step fails.

For UNIX (Mac / Linux):

• Note: Specify the hashlink directories on your system. On Mac, brew defaults /usr/local (lib/include).

    cmake ..  -GNinja -DYOJIMBO_SRC_DIR="ext/yojimbo" -DYOJIMBO_INC_DIR="ext" -DHL_LIB_DIR="/usr/local/lib" -DHL_INCLUDE_DIR="/usr/local/include" -DHDLL_DESTINATION="/usr/local/lib"

    make

    make install