LYNX ENGINE

LYNX ENGINE // BUILD

Build the engine

Compile Lynx Engine from source with MinGW. Clone the repository, get CMake and the dependencies ready, then run the generate and build scripts. Debug and Release each have their own pair of scripts.

STEP 1

Requirements

Install these tools first and make sure they are available from a terminal:

  • Git, to clone the repository.
  • CMake, added to your PATH. Check it with cmake --version.
  • MinGW, the compiler used to build Lynx. Make sure gcc and g++ are in your PATH. Check it with g++ --version.

STEP 2

Clone the repository

git clone https://github.com/oscar-soirey/Lynx-Engine.git
cd Lynx-Engine

STEP 3

Dependencies

The easiest way to install the dependencies is through the Lynx launcher.

Lynx relies on open-source libraries: HRL, EnTT, QuickJS, GLFW, Dear ImGui, dr_libs, OpenAL, Tracy and cURL. See the Third-party page for what each library does.

STEP 4

Configure and build

Run the scripts from the root of the repository. Generate the CMake project first, then build it.

DEBUG

Debug build

The default configuration, for development.

generate-cmake-project.bat
build.bat
  • generate-cmake-project.bat configures the CMake project.
  • build.bat compiles it.

RELEASE

Release build

Optimized build, for shipping.

generate-release.bat
build-release.bat
  • generate-release.bat configures the CMake project.
  • build-release.bat compiles it.