Skip to content

Latest commit

 

History

History
91 lines (60 loc) · 3.21 KB

INTEGRATION.md

File metadata and controls

91 lines (60 loc) · 3.21 KB

本项目为 TeaCon 2022 官方模组,提供了火焰作为道具的收集打卡机制。

我们鼓励参赛选手参与该打卡活动,向展馆内添加对应的小活动/闯关/解谜并给予对应的火焰道具。

火焰物品的名称需要表明这是一个火焰,同时可以表明参赛作品特色,如「XX 的 YY 之焰」、「即将消逝的火」都是可以的。

虽然不强制要求,但推荐在火焰物品提供一段简短的描述文字,以「即将消逝的火」为例:

即将消逝的火

即将在风中消散的火焰,蕴含着微弱的力量,
就算再微弱的火,也能点燃大树——
所以,去收集更多的火焰吧。

虽然不强制要求,但推荐一并提供一条简短的线索,指引玩家找到火焰,以「即将消逝的火」为例:

前往初始之地寻求火焰吧。

描述与线索均显示在物品的 Tooltip 上,因此请合理换行以控制一行最大长度。具体来说,最好控制在一行 20 个汉字以下。

你有两种方式进行集成。

模组中集成

你只需要在你的模组中创建对应物品后,为 nocaet:flames 这个物品 Tag 添加该物品:

src/main/resources 中创建 data/nocaet/tags/items/flames.json 并写入以下内容:

{
  "replace": false,
  "values": [
    "examplemod:item"
  ]
}

该文件也可以提交至 Puer

更多关于 Tag 的信息请参阅 Minecraft Wiki

描述

nocaet:flames Tag 下的物品可以在语言文件中提供 <物品翻译键>.tooltip,以 \n 换行,本模组会将其渲染在物品上。

例如,对于上面的「即将消逝的火」,则为:

{
  "item.nocaet.fading_flame": "即将消逝的火",
  "item.nocaet.fading_flame.tooltip": "即将在风中消散的火焰,蕴含着微弱的力量,\n就算再微弱的火,也能点燃大树——\n所以,去收集更多的火焰吧。"
}

线索

nocaet:flames Tag 下的物品可以在语言文件中提供 <物品翻译键>.clue,以 \n 换行。

例如,对于上面的「即将消逝的火」,则为:

{
  "item.nocaet.fading_flame.clue": "前往初始之地寻求火焰吧。"
}

线索中最好不出现直接的展馆名称(那样就无趣了);可以提供对于方位、主题或者其他作品相关的线索。

向 TeaCon 发起合并请求

如果参赛选手认为向作品中加入一个 TeaCon 专用任务道具不合适/很突兀,则可以向本仓库发起合并请求。

为确保我们可以自由分发你提供的资源,PR 发起者同意对本仓库提供的非代码资源自动进入公有领域(Public Domain)。

你需要在合并请求中包含以下内容:

  • 注册物品的代码
  • 贴图
  • 物品模型
  • 物品翻译
  • (可选)描述文本
  • (可选)线索文本

如果不想提供英文翻译,可直接将中文文本提交至 en_us.json

可参考示例 Pull Request

如果需要文案风格、贴图或其他方面的帮助,可以一并在 PR 内写出。