Usage docs

This commit is contained in:
Jakub 2026-05-17 11:35:01 +08:00
parent 41ac387ad0
commit 768fdf6700
3 changed files with 31 additions and 12 deletions

View file

@ -2,6 +2,25 @@
Imugi is a framework for building games (primarily tactics games) with Chicken Scheme and raylib. The end goal of this framework is to create a game, also called Imugi, and release to show the capability here.
* Installation & Usage
Raylib must first be installed before you can get started with Imugi.
Install raylib statically using the following commands:
#+begin_src shell
git clone --depth 1 https://github.com/raysan5/raylib.git raylib
cd raylib/src/
make PLATFORM=PLATFORM_DESKTOP
make install
#+end_src
The following dependencies are required on Debian:
#+begin_src shell
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
Once installed, you can import the Imugi modules required in your project.
When building, use the flags specified in ~all.options~ in this repository, which includes are the dependency links necessary.
* Architecture
Imugi is an ECS engine.

View file

@ -2,12 +2,12 @@
(import scheme
(chicken base)
raylib
(engine core)
(engine components core)
(engine math)
(engine input)
(engine drawing)
(engine scene)
(imugi core)
(imugi components core)
(imugi math)
(imugi input)
(imugi drawing)
(imugi scene)
(srfi 1)
(srfi 99))

View file

@ -2,12 +2,12 @@
(import scheme
(chicken base)
(chicken random)
(engine core)
(engine math)
(engine components core)
(engine drawing)
(engine input)
(engine scene)
(imugi core)
(imugi math)
(imugi components core)
(imugi drawing)
(imugi input)
(imugi scene)
raylib
(srfi 1)
(srfi 99))