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.

Lit Engine is in active development. Contributions and feedback are highly appreciated!

Quickstart

1. Clone the Repository

First, clone the repository and its submodules.

git clone --recurse-submodules --shallow-submodules -j2 https://github.com/luis605/Lit-Engine
cd Lit-Engine

If you cloned without --recurse-submodules, you can fetch them with:

git submodule update --init --recursive --depth 1

2. Install, Build, and Run

Linux

Choose the instructions for your operating system.

# 1. Install dependencies
cd Install
sudo ./install.sh
cd ..

# 2. Configure and build the project
mkdir build && cd build
cmake -DCMAKE_POLICY_VERSION_MINIMUM=3.5 ..
make -j4

# 3. Run the engine
make run

# Optional: To run the debugger
# First, build in debug mode: cmake .. -DCMAKE_BUILD_TYPE=Debug
# Then, run: make debug

# 1. Install dependencies
cd Install
.\install.bat
cd ..

# 2. Configure and build the project
mkdir build && cd build
cmake -DCMAKE_POLICY_VERSION_MINIMUM=3.5 .. # Both MinGW Makefiles and Microsoft Visual Studio are supported.
make -j4

# 3. Run the engine
make run

# Optional: If you are using MinGW Makefiles and you want to run the debugger (using GDB)
# First, build in debug mode: cmake .. -G "MinGW Makefiles" -DCMAKE_BUILD_TYPE=Debug
# Then, run: make debug

Screenshots

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.