A minimalist game engine with essential tools for 3D game development.

Rust (stable channel) and cargo via rustup.

A C/C++ toolchain (e.g., gcc, clang, or MSVC).

Git for cloning the repository.

sudo apt update && \ sudo apt install build-essential git curl

https://www.rust-lang.org/tools/install

To get started, get all of the prerequisites (see above).

1. Clone the Repository

git clone [email protected]:joaodrumm/cephei.git
cd cephei

2. Build
Use cargo to build the engine:

cargo build --release

3. Run
After a successful build, execute the engine:

# Run in one step:
cargo run --release

# Separate build and run:
cargo build --release
./target/release/cephei

• Build Guide: Detailed instructions for compiling the engine from source.
• User Manual: Guidelines for effectively using Cephei.
• API Reference: Detailed documentation of the engine's APIs.

To generate and view docs locally:

cargo doc --open

• Inspired by Bevy, Fyrox, Piston, and Amethyst.