Build

Github Actions

If you are familiar with Github Actions, the best way to build CatDogEngine is to follow according .yml script's steps to have a try. Actions make sure that according platforms succeed to build in Github cloud servers.

Network issues

If your location is in China, VPN is necessary because CatDogEngine contains many submodules to download. If VPN is on, please switch to global proxy to download or try to set git proxy in command line:

git config --global http.proxy 127.0.0.1:%YOUR_VPN_PROXY_PORT%
git config --global https.proxy 127.0.0.1:%YOUR_VPN_PROXY_PORT%

If you failed to download large files multiple times, try to use these settings:

git config --global core.compression 0
git config http.postbuffer 52428800

CMake

CMake is popular in many open source reposities. So it is required to setup CMake and make sure that cmake can be found in command line.

Premake

Premake is the build tool CatDogEngine is using now. All premake scripts and tools are placed at Engine/Auto directory.