5 个稳定版本

2.1.0 2022年6月5日
2.0.1 2022年6月5日
2.0.0 2022年6月4日
1.0.1 2022年6月1日
1.0.0 2022年5月29日

2133开发工具

GPL-2.0-only

175KB
3.5K SLoC

TrueGRF YAML to GRF 编译器(命令行和 NPM)

TrueGRF 是一个项目,旨在让任何人都能更容易地为 OpenTTD 创建 NewGRF。有关项目的更多详细信息,请访问 此处

此存储库是项目的 Rust 部分,它提供 YAML 到 GRF 编译器,既作为独立工具,也作为 npm 库(通过 WASM)。

安装/使用

命令行界面

cargo run --release -- --help

WASM

安装最新的 Rust,并安装 wasm-pack(使用 cargo install wasm-pack)。

wasm-pack build --release --target web

这将在 pkg 文件夹中提供所需的 WASM 文件。请查看 wasm-pack 了解如何在您的项目中使用它。

PS:在某些情况下,您可能需要在 pkg/package.json 中将 module 键替换为 main 并添加 "type": "module"

sed -i 's/"module": "truegrf.js",/"main": "truegrf.js",\n  "type": "module",/' pkg/package.json

当前支持

目前 TrueGRF 仅支持一小部分 GRF 规范

  • 货物
  • 行业
  • 行业图块

所有其他功能目前(尚)不支持。

文件系统布局

为了使 TrueGRF 能够编译 YAML 到 GRF,YAML 文件需要具有特定的结构。

  • truegrf.yaml:主文件,用于指示它是一个 TrueGRF 项目。
  • cargoes/<name>.yaml:一个货物定义。
  • industries/<name>.yaml:一个行业定义。

精灵可以引用根文件夹中的 PNG 文件。

YAML 的具体结构可以从 源文件 中推断出来。

依赖关系

~8.5MB
~147K SLoC