为文档做贡献
你可以通过 GitHub 上的拉取请求(PR)为本文档做贡献。
原创说明图,依据 Forge 1.21.x 官方文档 绘制。
本文档旨在解释概念。请说明如何完成相应操作,并将内容拆分成合理的部分。我们另有一个 Wiki,可收录更全面的代码示例。
文档面向所有希望了解如何使用 Forge 构建模组的人。请不要将本文档变成 Java 开发教程;读者应当理解 Java 类的工作方式及其他基础结构。
风格指南
请使用两个空格缩进,不要使用制表符。
英文标题应遵循标准的标题大小写格式,例如:
- Guide For Contributing to This Documentation
- Building and Testing Your Mod
基本原则是将不重要的词以外的单词首字母大写。拼写、语法和句法应遵循美式英语,并优先使用完整词组而不是缩写形式,例如使用 are not 而不是 aren’t。
请使用等号和短横线下划线来表示标题,而不是 # 和 ##。三级及更低级标题可以使用 ### 等写法。本文件的源代码中有使用等号和短横线下划线的示例:等号创建一级标题,短横线创建二级标题。
在代码块之外引用字段和方法时,应使用 # 分隔,例如 ClassName#methodName。内部类应使用 $ 分隔,例如 ClassName$InnerClassName。
JSON 代码块应使用 js 语法高亮。所有链接的目标都应放在页面底部;内部链接应使用相对路径引用页面。
提示框(以 !!! <type> 表示)必须按照文档规定的格式编写,否则可能无法正确渲染。