ezgal

English|中文|日本語

A Rapid Development Framework for Text Adventure Games Based on Godot.Mono

Description

In November 2023, we initially implemented the godot-ezgal framework for Godot3 but abandoned further maintenance due to scalability issues. Now, we are rewriting the framework, and here are the features of the new ezgal framework:

Description	ezgal	Contributor
Godot Version	Godot4 (considering ongoing compatibility)	cryingn
Development Language	C# (version net8.0 and above)	cryingn
Development Modes	1. Deep ntegration: Use the framework for secondary development to achieve more functionalities. 2. Low-Code Development: No need to configure the environment; download the compiled files and use them as development programs.	cryingn
ezgal Interpreter	Interpret script files into JSON format and read them segment by segment.	cryingn
Script Syntax	To facilitate the separation of script writing and performance, ezgal supports syntax that highly divides dialogue from script performance.	cryingn
Script Languages	Chinese/English/Japanese (support customization in ./make/FlowData.cs)	cryingn
Wiki Languages	Chinese/English/Japanese	cryingn

Usage

Instructions

We have compiled documentation to facilitate understanding of the project and its development. You can find the corresponding instructional documents in the wiki, typically starting from the Table of Contents.

deep-integration

You can directly clone the source code into your project and import the ezgal folder into Godot for further development:

git clone https://github.com/GodotHub/ezgal.git
cd ezgal/ezgal

Before starting to write scripts for the first time, you need to initialize the state and compile the language:

dotnet run --project make edit en

After completing the script writing, if you want to package it into a program, you can directly compile it into the ./ezgal/code/FlowData.cs folder through the make folder. The packaging method is as follows:

dotnet run --project make build en

The Godot-compiled program can run independently of the folder. If you need to restore it to the file editing state, you can use the following command to restore:

dotnet run --project make edit en

Low-Code-Development

(This will be the mainstream development method for ezgal in the future, allowing development by simply modifying the content of folders outside the program.)

After obtaining the binary files, you can also modify script/illustration/dictionary/music and other resources by directly editing the content of folders outside the program.

Contributing

Welcome to use the project. You can refer to Contributing to contribute source code and make ezgal better.

Acknowledgments

• The ezgal project is based on the Godot Engine.
• Thanks to 100font for providing font resources.
• The godot-ezgal and ezgal projects were initially supervised by the VYCMa Open Source China Community.
• The ezgal project is currently maintained by the Godot Hub Community.
• Thanks to all individuals who have contributed and designed.