d34d0s/Lotus

A light-weight, open-source, game engine focused on extendibility, written in pure C.

Relevant Links

[ Official Wiki | API Documentation | Lotus Examples | CBuild ]
[ Official Discord | Official Reddit | Lotus Discussions | Lotus FAQ ]

Building the Engine Source 🛠️

(NOTE): Using the CBuild CLI build-tool requires you to have python installed! More info can be found on the CBuild Repository

Lotus now includes pre-configured .cbuild files for easy setup and compilation! Users are encouraged to use the CBuild CLI tool, which is lightweight and tailored for projects like Lotus Core.

Option 1: Build with CBuild (Recommended)

1. Install CBuild:
   Install the tool via PyPI:

   pip install cbuild

2. Clone the Repository:

   git clone https://github.com/d34d0s/Lotus.git
   cd Lotus

3. Build the Engine:
   Use the provided .cbuild configuration to build Lotus:

   cbuild lotus.cbuild

4. Output:
   The compiled Lotus.dll will be located in the build/lotus.core directory.

Option 2: Manual Compilation

If you prefer manual setup, follow these steps:

1. Clone the Repository:

   git clone https://github.com/d34d0s/Lotus.git
   cd Lotus

2. Compile the Engine:
   Use GCC to build Lotus:

   gcc -c lotus/lotus.core/*.c -Ilotus/include -DLOTUS_EXPORT -o build/lotus.core/*.o
   gcc -shared build/lotus.core/*.o -lopengl32 -lgdi32 -o build/lotus.core/Lotus.dll

3. Install the Compiled Binaries:
   Move the compiled files to your project's directories as needed:

   cp build/lotus.core/Lotus.dll your_project/bin/

Building Projects with Lotus

1. Prepare Your Project:
   Set up your source files and include paths.

2. Compile with CBuild or GCC:

   • Example using GCC:

     gcc my_project.c -Ilotus/include -lLotus -o my_project.exe

🪷 Lotus' Contributors 🪷

🪷 License 🪷

Lotus is licensed under the Apache 2.0 license.