原创 开源 工具 Gardin's Advancement-以placeholder表达式驱动的原生进度添加 0.6.0

[MD] # Gardin's Advancement  前置: - [URL='https://www.spigotmc.org/resources/ultimateadvancementapi-1-15-26-2.95585/']UltimateAdvancementAPI[/URL] - [URL='https://www.spigotmc.org/resources/placeholderapi.6245/']PlaceHolderAPI[/URL] # Gardin's Advancement  您不想写自己的数据包：那对于您来说太过复杂，所以您想要一个插件，通过更友善的yml将自定义的原生风格的进度添加进你的服务器。 但一直以来我们的进度都依赖于插件开发者制作的事件监听器，这实际上对用户产生了一些限制： 传统成就插件通常依赖事件监听器判断玩家行为。 这种方式存在一个问题: 当一个插件添加新的物品、技能或系统时，如果没有专门适配，系统无法识别这些数据。 现如今placeholder几乎充斥在所有的插件里，越来越多的插件选择它作为暴露内部状态的工具 所以使用它作为条件再好不过了，既能保持成就插件本身轻量，又能天然兼容所有提供 Placeholder 的插件。 ## Gardin's Advancement 正是基于这一理念设计的。 Gardin's Advancement 使用 PlaceholderAPI 作为统一数据接口。 插件本身不依赖大量事件监听器，而是使用 Placeholder 表达式作为统一的条件系统。只要某个插件提供了 Placeholder，就可以直接参与成就判定，无需等待额外的适配。 例如： ```yml - "placeholder: %player_level% >= 15 && %townyadvanced_player_jailed% == true" ``` 上面的配置表示： 玩家等级达到 15 级或以上； 玩家当前在 Towny 中处于监禁状态。 只有两个条件同时满足，玩家才会获得对应的成就。 由于采用了这种设计，理论上任何支持 PlaceholderAPI 的插件都可以直接成为成就条件来源。 我们还支持对进度条的支持，目前仅支持一个变量 ```yml progress: placeholder: '%player_level%' max: 10 ``` 这意味着显示成就进度条，当玩家等级达到10级时，成就会被完成。 请注意:受限于原版仅支持int类型数据 若您的placeholder传入非数值数据则永远被标记为0，若您传入浮点数则会被强行向下取整 这两种方式可以共存，也可以独立存在。 对于复杂逻辑，可以结合 PlaceholderAPI 的 JS 扩展或其他脚本插件进行封装。 我们支持如下表达式: - `!` - `<` - `>` - `==` - `!=` - `>=` - `<=` - `&&` - `||` - `()` 一个示例文件如下 ```yml tabs: novice_path: display-mode: direct background: "minecraft:textures/block/stone.png" advancements: novice_root: type: root conditions: - "placeholder: %player_level% >= 0" commands: - "say %player_name% 已解锁根成就 novice_root" - "tell %player_name% &a欢迎来到新手之路" data: title: "初入世界" icon: minecraft:acacia_door frame: task show_toast: true announce_chat: true x: 10 y: 20 description: - "这是新手线路的根节点" novice_step_one: type: common parent: novice_root progress: placeholder: '%%player_level%%' max: 10 data: title: "迈出第一步" icon: CE:customfishing:sturgeon_fish_golden_star frame: goal show_toast: true announce_chat: true x: 12 y: 20 description: - "&a这个普通节点绑定在 novice_root 下" ``` ## 分支系统 成就树不可避免地会随着编写而变得难以阅读，所以我制作了分支系统，您只需要编写如下的配置便可封装你的成就树 ```yaml branchs: mining_line: advancements: mining_branch_root: type: root conditions: - "placeholder: %player_level% >= 4" data: title: "&7采矿支线起点" icon: minecraft:stone_pickaxe frame: task show_toast: true announce_chat: false x: 3 y: 3 description: - "&7该 root 会在挂载时自动改为普通节点" - "&7并把 parent 绑定到引用它的进度" mining_branch_iron: type: common parent: mining_branch_root conditions: - "placeholder: %player_level% >= 8" branch: - mining_deep_line # other branch data: title: "&f冶炼铁锭" icon: minecraft:iron_ingot frame: goal show_toast: true announce_chat: true x: 5 y: 3 description: - "&7分支内节点也可以继续挂载其他分支" ``` 此时只需要在tabs的节点中这样编写就可以让那个分支以branch_anchor为父节点，生成在这个tab下！ ```yaml branch_anchor: type: common conditions: - "placeholder: %player_level% >= 0" parent: branch_demo_root branch: - mining_line data: title: "&e分支挂载点" icon: minecraft:cartography_table frame: task show_toast: true announce_chat: false x: 2 y: 2 description: - "&7在这个节点下挂载 mining_line" - "&7同一个 branch 不能在别处再次引用" ``` 注意:分支不可复用，分支内节点共享父节点的命名空间，所以避免同一tab内的进度id相同! ## Placeholder 我们也拥有自己的papi变量实现！ 您可以在游戏中使用 >/ga placeholder 来得知这些占位符和作用 # 请注意 如果您需要基于即时事件触发的成就系统（例如：玩家挖掘方块瞬间触发、击杀实体立即检测等），那么本插件可能不适合您的需求。 Gardin's Advancement 的设计目标并不是替代事件监听系统，而是提供一个基于 PlaceholderAPI 的通用条件检测框架。 ## 性能问题 本插件在启动时会预编译条件表达式并生成变量索引与成就一一对应，解析包含在表达式中的占位符,这样做避免了重复读取相同的占位符 我使用固定窗口作为轮询压力的解决方案之一，避免短时间检测过多玩家导致服务器tps的不稳定 每次进行占位符读取，仅当占位符内容与缓存内容不一致时才会进行和此变量相关联的进度的条件检测 当成就完成时，会自动检测占位符引用情况，当占位符再也不被需要，将被自动释放 所以多次相同变量的引用并不会造成重大的性能问题。面对阶梯式的成就：5级->10级->15级 这种成就并不会占用什么性能，您可以尽情这样做 当然，也因为这个机制，您无法热重载你的成就树，```reload ```指令唯一能做的就只有调整你的config设置里的检测频率和debug开关 # 目前支持的图标适配： - [CraftEngine](https://github.com/Xiao-MoMi/craft-engine) ## 测试环境 1.21.11-paper [/MD]
最后是附上几个图