Lit Engine is an open-source high-level game engine powered by raylib. Made with the speed and portability of C++, Lit Engine allows you to build 3D experiences with minimal effort, and our intuitive interface will quickly launch you into the development world.

Give a ⭐ if you find the project useful! Your support helps the project to keep innovating and delivering exciting features.

---

Quickstart

Cloning the Repository

Do you want to give Lit Engine a quick run on your machine? You can clone the repository by running the following command on your terminal:

git clone --recurse-submodules -j8 https://github.com/luis605/Lit-Engine

If the submodules weren't downloaded, you can intialize them by running:

git submodule update --init --recursive

Building and Installing Dependencies

Linux

Before building the engine, ensure that you have all the dependencies installed. They can be installed by opening the install directory and running install.sh:

cd install
./install.sh

Then, you can build the remaining dependencies by running:

./build_dependencies.sh

Windows

Before building the engine, ensure that you have all the dependencies installed. They can be installed by opening the install directory and running install.sh:

cd install
.\install.bat

Then, you can build the remaining dependencies by running:

.\build_dependencies.bat

After successfully cloning the repository and setting up the project, you can build and run Lit Engine using our CMake setup:

mkdir build
cd build
cmake .. # Linux
cmake .. -G "MinGW Makefiles" --fresh # Windows 
make
make run

Debugging

If you encounter any strange behavior and need to debug the engine, you can start the debugger with the following command:

make debug

Make sure you have built the project in debug mode: cmake .. -DCMAKE_BUILD_TYPE=Debug

Documentation

Documentation is available at https://litengine.org/manual.

Note: Our documentation isn't yet finished!

Contributors

Socials

Find us here!

License

Check LICENSE.md for more information.