Prickle - Prickle（尖刺）

Prickle 是一种基于 JSON 的配置格式。这个模组允许该格式在 Minecraft 中使用！技术文档请参阅 GitHub 页面。

常见问题

Prickle 有什么优点？

Prickle 基于 JSON，但增加了若干实用功能，例如注释和装饰器。Prickle 与 JSON 100% 向后兼容，并支持其所有功能、工具和语法高亮。

为什么它叫 Prickle？

Prickle 是一群刺猬的集合名词。刺猬是我最喜欢的动物之一，我觉得它们很适合作为配置文件的隐喻。比如说，它们一开始看起来都可能有些让人望而生畏，但一旦你了解并理解它们之后，就会发现它们其实很好相处。

为什么不使用现有的格式？

过去我一直使用 JSON 作为配置文件格式，但它存在一些问题，比如缺少注释和默认值。Prickle 在保持 100% 向后兼容的同时，为 JSON 增加了这些功能。我也尝试过像 TOML 这样的其他格式，但对它们许多 Java 实现感到失望。它们往往缺少我认为重要的功能，存在严重 bug，而且已经不再维护。Minecraft 本身已经将 JSON 用于数据包和命令，因此对大多数玩家来说这是一个熟悉的选择。

格式规范

在 Prickle 中，属性值会被包裹在一个 JSON 对象里。这使得像注释这样的元数据可以附加到该属性上。

例如，一个标准的 JSON 文件会是这样。

{
  "database_host": "192.168.1.222"
}

而同样的内容写成 Prickle 文件则会是这样。

{
  "database_host": {
    "//": "要连接的数据库的 IP 地址。",
    "value": "192.168.1.222"
  }
}

注释

// 键被保留用于注释。注释仅用于向读者提供额外的上下文信息，不应影响文件的解析方式。注释可以是一个 JSON 字符串，也可以是一个字符串数组，用于多行注释。

{
  "database_host": {
    "//": [
      "要连接的数据库的 IP 地址。",
      "可以在末尾使用 : 来定义端口"
    ],
    "value": "192.168.1.222:1273"
  }
}

装饰器

装饰器是带名称的注释，用于传达属性的特定特征。装饰器的一个常见例子是 //default，它可用于显示该属性的默认值。与注释一样，装饰器不会影响文件的解析方式；它们只用于描述该属性将如何被解析。

你可能会在 prickle 文件中遇到以下一些装饰器。

• //default - 属性的默认值。
• //reference - 可用于了解更多信息的资源，例如 wiki 页面链接。
• //range - 值允许的范围。例如 >=5。
• //regex - 值必须匹配的正则表达式模式。
• //empty-allowed - 该值是否可以为空。（默认为 true）

赞助商

本项目由 Nodecraft 赞助。使用代码 DARKHAX 可享首月服务 7 折优惠！