# ezgal

**Repository Path**: godothub/ezgal

## Basic Information

- **Project Name**: ezgal
- **Description**: 基于Godot Mono的文字冒险类游戏开发模板
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://godothub.com/oss/ezgal
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-07-29
- **Last Updated**: 2026-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center" style="display:grid;place-items:center;">
	<p>
	    <a href="https://atomgit.com/cryingn/ezgal" target="_blank"><img width="180" src="./docs/public/icon.svg" alt="ezgal logo"></a>
        <h1>ezgal</h1>
    <p>
    <img src="https://img.shields.io/badge/License-MIT--License-blue.svg?style=flat-square&logo=opensourceinitiative&logoSize=14" alt="License" height="20">
    <img src="https://img.shields.io/github/stars/godothub/ezgal?style=flat-square&logo=github&color=green&logoSize=14" alt="License" height="20">
	<img src="https://gitcode.com/godothub/ezgal/star/badge.svg?style=flat-square">
</div>

[English](./README.md)|中文|[日本語](./README.JP.md)

基于Godot Mono的文字冒险类游戏开发模板.

![](./docs/public/example.png)

## 描述

我们在2023年11月初步实现了godot3的**godot-ezgal**框架, 但是因为扩展问题放弃继续维护, 现在重新构建一套便于维护新增的文档, 以下是新**ezgal**框架的特性:

| 描述       | ezgal                                                                              | 说明人     |
| -------- | ---------------------------------------------------------------------------------- | ------- |
| godot版本  | Godot4(考虑持续兼容)                                                                     | cryingn |
| 开发语言     | C#(net8.0以上版本)                                                                     | cryingn |
| 开发模式     | 1. [深度嵌入](#深度嵌入)：使用框架进行二次开发, 可实现更多功能<br>2. [低代码开发](#低代码开发)：无需配置环境，下载编译文件作为开发程序进行开发 | cryingn |
| ezgal解释器 | 将剧本文件解释为json格式并逐段读取                                                                | cryingn |
| 剧本语法     | 为便于剧本写作与演出分离, ezgal支持的语法高度划分了台词与剧本演出                                               | cryingn |
| 剧本语言     | 中/英/日三语（支持在`./make/FlowData.cs`定制语言）                                               | cryingn |
| wiki语言   | 中/英/日三语                                                                            | cryingn |

## 使用

### 使用说明

我们整理了便于了解项目与使用开发的文档，您可以在wiki中找到相应的说明文档，我们一般从[目录](./docs/zh_CN/index.md)开始.

### 深度嵌入

您可以直接将源码克隆到项目中, 并将**ezgal**文件夹导入到godot中接着开发:

```bash
git clone https://atomgit.com/godothub/ezgal.git
cd ezgal/ezgal
```

或

```bash
git clone https://gitee.com/godothub/ezgal.git
cd ezgal/ezgal
```

首次开始编写脚本前需要将状态与编译语言进行初始化:
```bash
dotnet run --project make edit zh
```

在编写完成后想要打包为一个程序可以直接通过**make**文件夹打包进`./ezgal/code/FlowData.cs`文件夹进行编译, 打包方式如下：

```bash
dotnet run --project make build zh
```

godot编译的程序可以不依赖文件夹运行, 如果需要恢复到文件的编辑状态, 可以使用以下指令进行恢复:

```bash
dotnet run --project make edit zh
```

### 低代码开发

低代码开发无需配置godot与dotnet开发环境，原理是通过程序开放的接口对基础资源进行自定义, 需要下载预编译的初始ezgal创建目录进行开发.

### 参与贡献

欢迎使用项目，你可以参考[参与贡献](./docs/zh_CN/参与贡献.md)贡献源码，让ezgal变得更好。

## 致谢

* ezgal项目基于[Godot Engine](https://godotengine.org/)引擎.
* 感谢[100font](https://www.100font.com/)提供字体资源.
* godot-ezgal、ezgal项目最初由VYCMa开源中国社区监督.
* ezgal项目当前由[Godot Hub社区](https://godothub.com/)维护.
* 致谢参与贡献与设计的所有个人