Polymod 项目教程

Polymod 项目教程

polymod Atomic modding framework for Haxe 项目地址: https://gitcode.com/gh_mirrors/po/polymod

1. 项目的目录结构及介绍

Polymod 项目的目录结构如下：

polymod/
├── docs/
│   └── ...
├── polymod/
│   ├── classes/
│   │   └── ...
│   ├── data/
│   │   └── ...
│   ├── format/
│   │   └── ...
│   ├── mod/
│   │   └── ...
│   └── util/
│       └── ...
├── samples/
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── haxelib.json
├── hxformat.json
├── include.xml
├── logo.png
├── preview.gif
└── preview2.gif

目录结构介绍

• docs/: 包含项目的文档文件。
• polymod/: 核心代码目录，包含项目的各个模块。
  • classes/: 包含项目的类文件。
  • data/: 包含项目的数据文件。
  • format/: 包含项目的格式化文件。
  • mod/: 包含项目的模块文件。
  • util/: 包含项目的工具类文件。
• samples/: 包含项目的示例代码。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• haxelib.json: Haxe 库配置文件。
• hxformat.json: Haxe 格式化配置文件。
• include.xml: 项目包含文件配置。
• logo.png: 项目 Logo 图片。
• preview.gif: 项目预览图片。
• preview2.gif: 项目预览图片。

2. 项目的启动文件介绍

Polymod 项目的启动文件通常是 Main.hx 文件，该文件位于 polymod/classes/ 目录下。启动文件主要负责初始化项目，加载必要的模块和配置，并启动主程序。

启动文件示例

package polymod.classes;

import polymod.Polymod;

class Main {
    public static function main():Void {
        // 初始化 Polymod
        Polymod.init({
            modRoot: "mods/",
            dirs: ["default"],
            framework: OPENFL
        });

        // 启动主程序
        startGame();
    }

    private static function startGame():Void {
        // 游戏启动逻辑
    }
}

3. 项目的配置文件介绍

Polymod 项目的配置文件主要包括 haxelib.json 和 hxformat.json。

haxelib.json

haxelib.json 是 Haxe 库的配置文件，用于定义项目的依赖库、版本信息等。

{
    "name": "polymod",
    "url": "https://github.com/larsiusprime/polymod",
    "license": "MIT",
    "tags": ["modding", "framework", "haxe"],
    "description": "Atomic modding framework for Haxe",
    "version": "1.8.0",
    "classPath": "polymod/",
    "releasenote": "Initial release",
    "contributors": ["larsiusprime"],
    "dependencies": {}
}

hxformat.json

hxformat.json 是 Haxe 格式化配置文件，用于定义代码的格式化规则。

{
    "lineEnds": {
        "class": "lf",
        "function": "lf",
        "block": "lf"
    },
    "spaces": {
        "beforeParenthesis": true,
        "afterParenthesis": true
    },
    "indentation": {
        "size": 4,
        "character": " "
    }
}

通过以上配置文件，可以确保项目的代码风格一致，便于团队协作和代码维护。

polymod Atomic modding framework for Haxe 项目地址: https://gitcode.com/gh_mirrors/po/polymod