Skip to content

README.md

Latest commit

 

History

History
82 lines (56 loc) · 2.11 KB

README.md

File metadata and controls

82 lines (56 loc) · 2.11 KB

White Bird Engine

Note: This repo is only the core layer of the engine. The full engine is still under development.

A free game engine built for rhythm game development.

Licensed under Apache License Version 2.0.

How to build

Clone the repository:

git clone https://github.com/OppositeNor/white-bird-engine.git --recursive
cd white-bird-engine

Or:

git clone https://github.com/OppositeNor/white-bird-engine.git
cd white-bird-engine
git submodule update --init --recursive

Install build dependencies:

sudo pacman -S cmake clang ninja

It is suggested to use Anaconda for setting up the build environment.

You can install Anaconda from here.

Setting up build environment

First create a conda environment.

conda env create -n white-bird-engine python=3.13
conda activate white-bird-engine

Install the dependencies from requirements.txt

pip install -r requirements.txt

Run the python script to build the project.

Build

python ./build.py

You can also indicate the build target.

python ./build.py -t debug          # Debug target
python ./build.py -t release        # Release target
python ./build.py -t deploy         # Deploy target (default)
python ./build.py -t debug-gcc      # Debug target with GCC compiler
python ./build.py -t release-gcc    # Release target with GCC compiler
python ./build.py -t deploy         # Deploy target with GCC compiler

Contribution

Use of AI

Use of AI assistants is allowed and encouraged for this project. At the start of every new AI session, please have the agent read CONVENTIONS_FOR_AI.md first. That file is a compact, high-density reference written specifically for AI agents and covers the project's layered architecture, build workflow, test layout, memory model, and naming rules.

After the AI finishes editing, carefully review every change and make sure you understand exactly what it did before committing.