Prickle

模组

· 作者 Darkhax

Prickle 是一种基于 JSON 的配置文件格式,专为 Minecraft 打造。

2 本站下载 0 关注 更新于 1 个月前

最新 26.3.0.2 · 26.3 · NeoForge

一键开服(送7天)

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

常见问题

Prickle 提供哪些优势?
Prickle 基于 JSON,但增加了注释和装饰器(decorators)等实用功能。Prickle 与 JSON 完全向后兼容,并支持其所有特性、工具和语法高亮。

为什么叫 Prickle?
Prickle 是刺猬群的集体名词。刺猬是我最喜爱的动物之一,我认为它们是配置文件的一个恰当隐喻。例如,它们起初可能看起来令人生畏,但一旦你了解并理解它们,就会发现它们其实很友好。

为什么不使用现有的格式?
过去我曾为配置文件使用 JSON,但存在几个问题,比如缺少注释和默认值。Prickle 在保持与 JSON 100% 向后兼容的同时,添加了这些功能。我也尝试过其他格式如 TOML,但对它们的许多 Java 实现感到失望。它们往往缺乏我认为重要的功能,存在严重错误,且不再维护。Minecraft 已经对数据包和命令使用了 JSON,这对大多数玩家来说是一个熟悉的选择。

格式规范

在 Prickle 中,属性值被包裹在一个 JSON 对象内。这使得像注释这样的元数据可以归属于该属性。

例如,一个标准的 JSON 文件看起来是这样的:

{
  "database_host": "192.168.1.222"
}

同样的 JSON 作为 Prickle 文件看起来是这样的:

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

注释

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

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

装饰器

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

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

  • //default - 属性的默认值。
  • //reference - 可用于了解更多详情的资源,例如指向维基页面的链接。
  • //range - 值的可接受范围。例如 >=5。
  • //regex - 值必须匹配的正则表达式模式。
  • //empty-allowed - 值是否可以为空。(默认为 true)。

赞助商

本项目由 Nodecraft 赞助。使用代码 DARKHAX 可享受首月服务 30% 折扣!

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源