The following dependencies need to be installed beforehand to bootstrap the build process:
- Python3 must be installed and on your path.
- Requests python module must be installed.
- Boost must be installed somewhere on your system.
- CMake must be installed.
There are two scripts you want to run first. First is download_deps.py
.
This pulls all the other dependencies from github and writes them to the
lib
folder. Git does not need to be installed, it just just making simple
GET requests on the project's build artifacts.
The second script is optional: WriteShaders.py
. This script takes the
shaders in the shaders
folder and writes them into c++ source files to
be used at runtime. Having the shader sources in program memory means
files don't need to be read at runtime. However, this means that whenever
changes are made to the shader files, this script must be run again!
This script is optional because the files WriteShaders.py
generates are
committed in git.
There is one CMake variable you will need to set, and that is BOOST_ROOT
.
This variable should point to the path where you installed Boost.
Once you have run the scripts and set the boost root CMake variable, you can now run CMake on the project like normal. There should not be any other CMake variables you need to set.
Here is a full example that works for me to get a running version of Blyss:
git clone https://github.com/MrZoraman/Blyss.git
cd Blyss
python download_deps.py
cd build
cmake -DBOOST_ROOT=C:\Lib\boost_1_71_0 ..
msbuild Blyss.sln /p:Configuration=Release
cd Release
blyss.exe