• Forge论坛

导航页

  • 主页
  • 向文档做出贡献
    • 格式指南
  • 入门
    • 概述
    • 模组文件
    • 规划你的模组结构
    • 版本号
  • 核心概念
    • 注册表
    • 端位(Sides)
    • 事件
    • 模组生命周期
    • 资源
    • 国际化与本地化
  • 方块
    • 概述
    • 方块状态
  • 物品
    • 概述
    • BlockEntityWithoutLevelRenderer
  • 网络
    • 概述
    • SimpleImpl
    • 实体的同步
  • 方块实体
    • 概述
    • BlockEntityRenderer
  • 游戏特效
    • 粒子效果
    • 音效
  • 数据储存
    • Capabilities
    • Saved Data
    • 编解码器(Codecs)
  • 图形用户界面
    • 菜单(Menus)
    • 屏幕(Screens)
  • 渲染
    • 模型扩展
      • 概述
      • 根变换
      • 渲染类型
      • 部分可见度
      • 面数据
    • 模型加载器
      • 概述
      • 烘焙模型
      • 变换
      • 物品重载
  • 资源
    • 客户端资源(Assets)
      • 概述
      • 模型
        • 概述
        • 纹理色调
        • 物品属性
    • 服务端数据(Data)
      • 概述
      • 配方
        • 概述
        • 自定义配方
        • 原料
        • 非数据包配方
      • 战利品表
      • 全局战利品修改器
      • 标签
      • 进度
      • 条件性加载数据
  • 数据生成
    • 概述
    • 客户端资源(Assets)
      • 模型提供者
      • 语言提供者
      • 音效提供者
    • 服务端数据(Data)
      • 配方提供者
      • 战利品表提供者
      • 标签提供者
      • 进度提供者
      • 全局战利品修改器提供者
      • 数据包注册表对象提供者
  • 杂项功能
    • 配置
    • 键盘布局
    • 游戏测试
    • Forge更新检查器
    • 调试分析器
  • 进阶主题
    • 访问转换器
  • 向Forge做出贡献
    • 概述
    • Pull Request准则
  • 旧版本
    • 概述
    • 移植到当前版本

向这篇文档做出贡献

你可以通过在MinecraftForge的官方GitHub仓库提交PR来提交对这篇文档的贡献;若要对翻译文档提出修改,请访问中文翻译GitHub仓库。

本文档的宗旨是明理达意。因此在提交贡献时,请解释它的工作原理,并将其拆分为合理的部分。 我们在其他地方有一个wiki,可以展示更全面的代码示例(未指明具体地点——译者注)。

我们的受众是任何一位想要了解如何通过Forge来构筑模组的人。

请不要试图将这篇文档转变为一篇关于Java开发的教程——后者意在教导人们一个Java类是如何工作的,以及一些Java的其他基本架构。

格式指南

重要

请使用两个空格符来进行缩进,而不是制表符。

标题应该以标准的标题样式对首字母进行大写或小写。例如,

  • Guide For Contributing to This Documentation (中文:本文档贡献指南)
  • Building and Testing Your Mod (中文:构建并测试你的模组)

从本质上讲,除了不重要的单词外,所有单词都要大写。

拼写、语法和句法应遵循美式英语。此外,优先考虑使用用空格分割开的短语而不是缩写(例如“are not”而不是“aren’t”)。

请使用等号和短划线,而不要使用“#”和“##”。对于h3及以下字体大小,“###”等也可以。此文件的源文件包含一个等号和短划线的示例。等号下划线创建h1文本,短划线下划线创建h2文本。

当引用代码块片段之外的字段和方法时,它们应该使用#分隔符(例如ClassName#methodName)。内部类应该使用$分隔符(例如ClassName$InnerClassName)。

JSON代码块片段应该使用js语法高亮显示。

所有链接都应在页面底部指定其URL。任何本文档的内部链接都应该通过其相对路径引用对应的页面。

警告(用!!! <type>表示)必须按照该文档所示进行设置;否则,它们最终可能会渲染不正确。

Built with MkDocs using a custom theme. Hosted by Read the Docs.
Enable Dark Theme