Files
OpenMaidEngine/README.md
2026-08-03 14:37:58 -04:00

2.6 KiB

AGE engine reimplementation

Open reimplementation of Eushully's AGE engine with first-class modding. The first target is Himegari Dungeon Meister (SYS4, 2009); the runtime is Godot 4.7 .NET plus a platform-neutral C# VM.

This repository contains only authored engine, tooling, native-boundary, test, and documentation files. It does not contain the original game. Supply a legally obtained AGE installation separately; never copy original game data into this repository.

Start here

Prerequisites for the current Windows development workflow are Python 3.11, the .NET 8 SDK, Godot 4.7 .NET, and a Himegari install containing SYS4INI.BIN. Pass paths explicitly or configure AGE_GODOT_CONSOLE and AGE_GAME_ROOT.

# Verify and display the resolved development environment without launching.
.\run-godot.ps1 -Doctor -GodotConsole <godot-console.exe> -GameRoot <Himegari-install>

# Run source-only/core validation. The default validation level is the complete workspace/runtime suite.
py -3.11 -X utf8 tools\validate.py --level core

# Build and launch the natural SYSTEM4 → title → game route.
.\run-godot.ps1 -GodotConsole <godot-console.exe> -GameRoot <Himegari-install>

workspace and full validation additionally require the extracted script corpus and disposable derived inputs described by the tools reference. runtime and full require Godot plus a valid game root. A selected requirement that is unavailable is an error, not a silent skip.

Canonical references

Follow the repository's canonical-document map when recording new knowledge: extend the existing owner and cross-link it instead of duplicating facts here.

Generated data

build/ is disposable and ignored. Generated references identify their canonical source in their header; edit that source and run its owning generator rather than patching generated output. The original game install and extracted archives remain sibling directories outside this Git repository.