A 3D general-purpose game engine for Unix distributions, being used in the game Celestine.
To compile and run you need the following:
- A GPU with OpenGL 4.1 minimum support;
- CMake 3.10 To generate the documentation, you will need a recent version of Doxygen
Clone with git clone --recurse-submodules https://github.com/teoemeaesse/cobalt-engine.git
to include all the depency submodules.
Before anything else, run the setup script. This will get and install all the necessary dependencies.
./setup.sh
This project uses Doxygen to generate HTML docs. There is no hosted documentation (for now), so to generate it locally:
./build_docs.sh
Use the provided build scripts to build the editor.
./build_editor.sh
You can run the provided script on your machine or use the Docker image.
sudo docker build -t cobalt-tests .
sudo docker run cobalt-tests
Currently compatible with Linux distributions and MacOS on ARM. There are future plans for a Windows version. Mostly untested outside of Ubuntu 23.10 and MacOS Sonoma 14.1.
cobalt is divided into two main parts: