模块结构文档

模块结构文档

本文档描述了本资源包的“模块”结构。

概览

<root folder>/
|-module_manifest.json
|-add.json
|-remove.json
|-assets/
  |-<other content>...

各文件描述

module_manifest.json

必需。此文件用于描述整个模块的基本结构。

manifest.json的内容如下：

{
    "name": "<Awesome name>",
    "type": "(resource|collection)",
    "description": "<Extraordinary Resource>",
    "author": "<Unique author name>",
    "contains": ["<contains list>"],
    "incompatible_with": ["<incompatible list>"]
}

name是识别一个模块的唯一标识符。它可以是任何合法的字符，但梗中要求其小写，单词以_分割。根文件夹的名字必须与name相同。

type是模块的类型，只能是resource、language、mixed或collection。根据type的值，模块的结构会有所不同（见下）。

description是模块的描述，可以是任何合法的字符。

author是模块的作者名，请确保这里的名字是正确的。

contains是模块引用的其他模块，仅当type是collection时生效。引用的模块不能含有另一个collection模块。

incompatible_with是模块的不兼容/冲突列表，用于当其他模块和此模块在修改相同内容时注明。

add.json和remove.json

当manifest.json的type为language或mixed时生效。

add.json是用于向主文件zh_meme.json添加或更新字符串的文件，结构和zh_meme.json一致。

remove.json是从zh_meme.json移除字符串的文件，内容是所有要移除的字符串的键的列表。

assets/

当manifest.json的type为resource时生效。

用于添加除了主语言文件增补和删除以外的其他任何内容，文件夹结构（除了不能包含 pack.mcmeta ）保持和标准的Minecraft资源包一致。