BirDt/imugi
1
0
Fork 0
Code Issues 14 Pull requests Projects 1 Wiki Activity Actions

Usage docs #23

Merged
BirDt merged 2 commits from feature/usage-docs into master 2026-05-17 11:37:21 +08:00
Conversation 0 Commits 2 Files changed 3 +7 -2
1 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 9cf36ab12c - Show all commits

9
README.org
View file

@ -5,6 +5,8 @@ Imugi is a framework for building games (primarily tactics games) with Chicken S
* Installation & Usage * Installation & Usage
Raylib must first be installed before you can get started with Imugi. Raylib must first be installed before you can get started with Imugi.
Note: this guide assumes static linking for the Raylib library.
Install raylib statically using the following commands: Install raylib statically using the following commands:
#+begin_src shell #+begin_src shell
git clone --depth 1 https://github.com/raysan5/raylib.git raylib git clone --depth 1 https://github.com/raysan5/raylib.git raylib
@ -18,8 +20,11 @@ The following dependencies are required on Debian:
apt install -y libasound2-dev libx11-dev libxrandr-dev libxi-dev libgl1-mesa-dev libglu1-mesa-dev libxcursor-dev libxinerama-dev libwayland-dev libxkbcommon-dev apt install -y libasound2-dev libx11-dev libxrandr-dev libxi-dev libgl1-mesa-dev libglu1-mesa-dev libxcursor-dev libxinerama-dev libwayland-dev libxkbcommon-dev
#+end_src #+end_src
Once installed, you can import the Imugi modules required in your project. Once raylib is installed, run ~chicken-install -s~ in this directory to install all dependencies and the Imugi egg itself.
When building, use the flags specified in ~all.options~ in this repository, which includes are the dependency links necessary.
You can then import the Imugi modules required in your project.
When building your project, use the flags specified in ~all.options~ in this repository, which includes are the dependency links necessary.
* Architecture * Architecture
Imugi is an ECS engine. Imugi is an ECS engine.