Iskandert's Library

Iskandert's Library

主要由Iskandert's Team模组使用的一系列函数库

基础库

Iskandert 的库 — 功能概览

本库包含 Iskandert 团队各项目间复用的构建模块。它专注于实用的游戏玩法系统(结构、阶段、标记、商店/团队)以及开发者工具(解析辅助工具、传输桥接、调试工具)。

使用与许可

该项目基于 MIT 许可证发布。你可以自由地在项目中使用它(包括修改、再分发和商业使用),只要保留许可证声明即可。

包含内容

结构系统(JSON 驱动)

用于通过外部 JSON 定义来定义和放置结构的工具:

  • 结构定义:模式、方块键、替换规则,以及强制/覆盖等选项。
  • 配置扫描与加载:发现结构 JSON 文件并进行运行时注册。
  • 放置引擎:在世界中放置结构,支持验证、属性应用和可选行为(例如“以玩家身份放置”、刷新 tick)。
  • 撤销历史:轻量级的每玩家放置历史,支持撤销。

关键包/类:

  • net.unfamily.iskalib.structure.StructureDefinition
  • net.unfamily.iskalib.structure.StructureLoader
  • net.unfamily.iskalib.structure.StructurePlacer
  • net.unfamily.iskalib.structure.StructurePlacementHistory

阶段系统(玩家 / 世界 / 团队)

一个通用的“阶段”注册表,用于在不同作用域内控制内容解锁和跟踪进度:

  • 玩家阶段:持久化的每玩家阶段标记。
  • 世界阶段:存储在世界存档数据中的全局标记。
  • 团队阶段:由团队共享的阶段标记,存储在世界存档数据中。
  • 钩子与监听器:用于响应阶段变化的集成点。

关键包/类:

  • net.unfamily.iskalib.stage.StageRegistry
  • net.unfamily.iskalib.stage.StageHooks
  • net.unfamily.iskalib.stage.StageActionHooks

团队支持(共享余额 / 成员资格)

用于对玩家进行分组并共享余额的团队管理:

  • 创建/删除团队
  • 管理成员资格和角色
  • 跟踪和查询每团队货币余额

关键包/类:

  • net.unfamily.iskalib.team.ShopTeamManager

商店货币集成钩子

本库按货币 id 存储余额,但不硬编码货币目录。使用方可以提供元数据和补全建议:

  • 货币 id 列表,用于命令自动补全和 UI
  • 货币显示元数据(翻译键、符号),在可用时提供

关键包/类:

  • net.unfamily.iskalib.shop.ShopCurrencyHooks

世界标记工具(客户端)

面向开发者的标记渲染和辅助工具,适用于调试区域、选区、扫描和自动化:

  • 方块的标记渲染
  • 位置的广告牌
  • 用于清理/重置行为的运行时会话(非持久化)
  • 用于创建/清除标记的调试命令入口

关键包/类:

  • net.unfamily.iskalib.client.marker.MarkRenderer
  • net.unfamily.iskalib.client.marker.VanillaWorldMarkerClientHooks
  • net.unfamily.iskalib.marker.MarkerSession
  • net.unfamily.iskalib.command.MarkerCommand

渐进式爆炸系统(服务端)

一个模块化、对卡顿更友好的爆炸实现,可以随时间逐步执行:

  • 椭圆形/水平+垂直半径爆炸
  • 基于 tick 的处理(当间隔为零时立即执行)
  • 可选的实体伤害和“破坏不可破坏方块”模式
  • 活动爆炸的中央注册表,带有停止/内省辅助方法

关键包/类:

  • net.unfamily.iskalib.explosion.ExplosionSystem

物品字符串解析与转换工具

用于将“物品参数”字符串转换为 ItemStack(以及反向转换)的辅助工具,匹配 /give 接受的格式:

  • 解析 minecraft:item_id 以及方括号组件语法,如 minecraft:item[component=value,...]
  • 验证用户为配置/命令提供的物品字符串
  • 将 ItemStack 格式化为物品参数字符串(id + 组件补丁)

关键包/类:

  • net.unfamily.iskalib.item.ItemConverter

传输桥接(自动化兼容)

将旧版物品处理器桥接到 NeoForge 的物品传输能力:

  • 将 IItemHandler 包装为事务性的 ResourceHandler<ItemResource>
  • 在可能的情况下(IItemHandlerModifiable)使用快照日志进行回滚

关键包/类:

  • net.unfamily.iskalib.transfer.LegacyItemHandlerResourceHandler

调试辅助工具与命令

用于开发和故障排除的小型、专注的实用工具:

  • 手部/物品转储辅助工具
  • 用于标记/阶段工作流的调试命令

关键包/类:

  • net.unfamily.iskalib.debug.HandItemDump
  • net.unfamily.iskalib.command.IskaLibDebugCommand
  • net.unfamily.iskalib.command.StageCommand

液体 API:

  • net.unfamily.iskalib.liquid