ichiloto / engine
A simple game engine for making terminal based JRPGs, lovingly written in PHP.
Requires
- php: ^8.4.1
- amasiye/figlet: ^1.2.1
- assegaiphp/collections: ^0.3.2
- assegaiphp/util: ^0.4.3
- league/climate: ^3.9
- symfony/console: ^8.0
- voku/portable-ascii: ^2.0
Requires (Dev)
- pestphp/pest: ^5.1
- phpstan/phpstan: ^2.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
- dev-main
- 0.5.0
- 0.4.0
- 0.3.10
- 0.3.9
- 0.3.8
- 0.3.7
- 0.3.6
- 0.3.5
- 0.3.4
- 0.3.3
- 0.3.2
- 0.3.1
- 0.3.0
- 0.2.41
- 0.2.40
- 0.2.39
- 0.2.38
- 0.2.37
- 0.2.36
- 0.2.35
- 0.2.34
- 0.2.33
- 0.2.32
- 0.2.31
- 0.2.30
- 0.2.29
- 0.2.28
- 0.2.27
- 0.2.26
- 0.2.25
- 0.2.24
- 0.2.23
- 0.2.22
- 0.2.21
- 0.2.20
- 0.2.19
- 0.2.18
- 0.2.17
- 0.2.16
- 0.2.15
- 0.2.14
- 0.2.13
- 0.2.12
- 0.2.11
- 0.2.9
- 0.2.8
- 0.2.7
- 0.2.6
- 0.2.5
- 0.2.4
- 0.2.3
- 0.2.2
- 0.2.1
- dev-develop
- dev-release/0.5.0
- dev-release/0.4.0
This package is auto-updated.
Last update: 2026-09-20 10:19:34 UTC
README
Ichiloto 2D Game Engine
Ichiloto 2D Game Engine is a PHP-based engine for creating JRPG-style games, inspired by classics such as Final Fantasy 1-6 and Dragon Quest. Terminal presentation remains the default. An optional GPUI renderer is under development; PHP continues to own gameplay, input bindings, animation state and saves.
Features
- Terminal worlds: Styled text, retained-cell rendering, camera scrolling, notifications and HUD overlays.
- Battle systems: Traditional turn-based and active-time combat, with configurable battle-entry rules.
- Game systems: Maps, events, quests, dialogue, NPCs, inventory, equipment and character progression.
- Persistence and audio: Save/load support, music and sound effects; see their runtime requirements below.
- Optional graphical presentation: Sprite sheets, field tiles and a locally playtested graphical battle foundation. Native player distribution is not yet available.
Installation
The PHP package requires PHP 8.4.1 or later and Composer:
composer require ichiloto/engine
Project scaffolding and launch commands belong to Ichiloto Console; the editor is a separate package. Installing the PHP package does not install a native GPUI executable. See audio for sound playback requirements and local checks for contributor setup.
GPUI Availability
A clean Engine checkout is not a complete native-player installation.
resources/renderers/ contains its installation README.
Native executables and the generated installation manifest are ignored by Git.
There is currently no published renderer package or Console command to install
one. Selecting GPUI cannot provision a missing executable automatically.
Cargo instructions are for developers building the separate
ichiloto/gpui-renderer repository,
which contains Cargo.toml. Do not run them from this Engine repository or its
renderer resources folder. Players should receive compatible, verified platform
packages without installing Rust or build tools; that delivery work is unfinished.
The graphical battle foundation has been playtested on macOS/Apple Silicon. A subsequent, local and unpublished correction removes the Renderer window's blanket non-macOS rejection using shared GPUI maximize/restore handling. It has macOS validation only and is not delivered by pulling Engine. Linux/WSLg remains untested; WSLg uses Linux PHP and a Linux renderer. Native Windows additionally needs a correct process transport. Neither a portable API nor a matching platform identifier establishes complete platform support.
The integration roadmap separates accepted work from remaining animation, effects, graphical UI and platform delivery.
Documentation
- Continuous integration and local checks
- Maps, quests and story events
- Persistence, save compatibility and audio
- Battle-entry rules
- Renderer installation boundary
- Graphical battle foundation and validation
- Sprite sheets and field tiles
- Renderer process transport (S2)
- Pluggable input sources (S3)
- Presentation frames and Console snapshots (S4)
- Optional graphical sprite intent and Player projection (S5)
- Optional Game renderer runtime and project artwork (S6)