Usage docs #23

Merged
BirDt merged 2 commits from feature/usage-docs into master 2026-05-17 11:37:21 +08:00
3 changed files with 31 additions and 12 deletions
Showing only changes of commit 768fdf6700 - Show all commits

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. 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 * Architecture
Imugi is an ECS engine. Imugi is an ECS engine.

View file

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

View file

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