# Advanced Datapack Mod > This mod is designed to extend datapack functionality and is currently in early development. Do not use this mod during regular gameplay. It may cause crashes or even corrupt your world! > 此mod旨在扩展数据包功能，目前处于早期开发阶段。不要在正常游戏期间使用此模组。它可能会导致崩溃甚至坏档！ ## Installation Make sure Minecraft has the Fabric Loader and Fabric API installed, then put this mod file in the `mods` folder * Q: Not sure if you installed the mod correctly? A: Enter the game input command: /adm. * Q: Can the Minecraft(Vanilla) datapacks be used in this mod? A: There are almost no problems if you do that. * Q: Can I use this mod on a dedicated servers? A: I do not recommend that you do this.Because the game will be unstable and sometimes you even cannot join the server especially when the mod version in your client is not as same as your server mod version. ## Features This mod modifies Minecraft's datapack loading, bypassing registry restrictions and making it possible to hotload items, blocks, etc.You can do these things by using a datapack simply. ## Features that may be added in the future - 1.Heat unload items, blocks, etc - 2.When an item/block is used/placed/destroyed, it will call the Datapack function that you specified - 3.Make it possible to register new effects, even new entity. ## Bug Report We apologize, we are currently preparing a channel for bug reports. If you encounter any bugs, please contact us via email(BilibiliXiaotian@outlook.com). # EnglishVersion of doc * [translated by Deepseek(AI) and XiaotianMC(author)] ## Datapack Function Introduction ### 1\. Item Expansion * Compared to the vanilla datapack, it provides more item expansion functionalities, allowing Minecraft to dynamically register items through datapacks. * Supports custom item attributes, durability, etc. * Supports custom item models and textures. (Defined in the resource pack) ### 2\. Block Expansion (Under Development) * Adds more block expansion functionalities. ### 3\. Commands * `adm` command \[Returns\] mod information * `item` subcommand * `get ` \[Returns\] list of registered items. `` is an optional parameter. * `disable ` \[Disable\] a specified _adm_ item. `` is a required parameter (Available, under refinement). * `enable ` \[Enable\] a specified _adm_ item. `` is a required parameter (Available, under refinement). * `setclear` \[Clear\] disabled items currently in use will be removed. true->false; false->true (Available, under refinement). * `block` subcommand * `get ` \[Returns\] list of registered blocks. `` is an optional parameter. * `disable ` \[Disable\] a specified _adm_ block. `` is a required parameter (Available, under refinement). * `enable ` \[Enable\] a specified _adm_ block. `` is a required parameter (Available, under refinement). * `debug` subcommand \[Set\] debug mode. true->false; false->true. * `reload` subcommand \[Reload\] mod data (Under Development). ## Datapack Format #### To define an item, create a `.json` file in the `data//item` directory of the datapack. _This is an example:_ ``` { "food": { "canAlwaysEat": true, "nutrition": 80, "saturation": 3.0, "effects": [ ["minecraft:night_vision", 10, 1] ] }, "tool": { "type": "axe", "level": "stone", "attackDamage": 999, "attackSpeed": 0.1, "durability": 1 }, "replace": "barrier" } ``` Where `food`, `tool`, and `replace` are optional. * `food` defines the food-related properties of the item. * `canAlwaysEat`: Whether the item can always be eaten. * `nutrition`: The food value (saturation restored when eating). * `saturation`: The saturation value. * `effects`: Effects applied after consumption, in the format `[effect_id, duration_in_ticks, effect_level]`. * `tool` defines the tool-related properties of the item. * `type`: Tool type, such as `axe`, `pickaxe`, `shovel`, `hoe`, `sword`. * `level`: Tool tier, such as `wood`, `stone`, `iron`, `diamond`, `netherite`. * `attackDamage`: The attack damage of the tool. * `attackSpeed`: The attack speed of the tool. * `durability`: The durability of the tool. * `replace` defines the display item of the item on the client side. It must be an existing (client-side) item ID, such as `minecraft:stone`, `minecraft:iron_ingot`, etc. (Under development). #### To define a block, create a `.json` file in the `data//block` directory of the datapack. _This is an example:_ ``` { "hardness": 1.0, "resistance": 10.0, "lightLevel": 0, "replace": "minecraft:stone", "require_tool": true, "has_item": true, "replaceable": false } ``` Where `hardness`, `resistance`, `lightLevel`, `replace`, `require_tool`, `tool`, and `has_item` are optional. * `hardness`: The hardness of the block. * `resistance`: The explosion resistance of the block. * `lightLevel`: The light emission level of the block. * `has_item`: Whether the block has a corresponding item form. (If yes, create an item definition file with the same name in the `data//item` directory.) * `replace`: Defines the display block of the block on the client side. It must be an existing (client-side) block ID, such as `minecraft:stone`, `minecraft:oak_planks`, etc. (Under development). * `require_tool`: Whether a tool is required to break the block. ## ADM API * `cn.gcte.adm.api.ResReloadManager` Resource Reload Manager * `public static void register(Consumer consumer)` Register a listener, This listener will be called when the datapack is initially loaded. `ResReloadManager.register(resourceManager -> { // Handle resources right after they are loaded // For example: LOGGER.info("Resource manager has been reloaded!"); });` * `cn.gcte.adm.api.GetBlockData` Get block datapack resources (i.e., the `data//block/.json` file). * `public static String getAllData()` Get the DataList (as a JSON string). * `cn.gcte.adm.api.GetItemData` Get item datapack resources (i.e., the `data//item/.json` file). * `public static String getAllData()` Get the DataList (as a JSON string). # ChineseVersion of doc-中文版文档 ## Datapack功能介绍 ### 1\. 物品扩展 * 相比于原版数据包，增加了更多的物品扩展功能，能够使Minecraft通过数据包动态注册物品。 * 支持物品的自定义属性、耐久度等。 * 支持物品的自定义模型和纹理。(在资源包中定义) ### 2\. 方块扩展(正在开发) * 增加了更多的方块扩展功能。 ### 3\. 命令 * `adm`命令 \[返回\]mod 信息 * `item`子命令 * `get ` \[返回\]注册的物品列表 ``非必选参数 * `disable ` \[禁用\]指定_adm_物品 ``必选参数(可用,正在完善中) * `enable ` \[启用\]指定_adm_物品 ``必选参数(可用,正在完善中) * `setclear` \[清除\]正在被使用的已禁用物品会被清除 true->false;false->true(可用,正在完善中) * `block`子命令 * `get ` \[返回\]注册的方块列表 ``非必选参数 * `disable ` \[禁用\]指定_adm_方块 ``必选参数(可用,正在完善中) * `enable ` \[启用\]指定_adm_方块 ``必选参数(可用,正在完善中) * `debug`子命令 \[设置\]debug模式 true->false;false->true * `reload`子命令 \[重载\]mod数据 (正在开发) ## Datapack格式 #### 在数据包的 `data//item`目录下新建`.json`文件以定义物品。 _这是一个示例_ ``` { "food": { "canAlwaysEat": true, "nutrition": 80, "saturation": 3.0, "effects":[ ["minecraft:night_vision",10,1] ] }, "tool": { "type": "axe", "level": "stone", "attackDamage": 999, "attackSpeed": 0.1, "durability": 1 }, "replace": "barrier" } ``` undefined 其中`food`、`tool`和`replace`是可选的。 * `food`定义了物品的食物属性。 * `canAlwaysEat`：是否总是可以食用。 * `nutrition`：食物的饱食度。 * `saturation`：食物的饱和度。 * `effects`：食用后给予的效果，格式为`[效果ID,持续时间(tick),效果等级]`。 * `tool`定义了物品的工具属性。 * `type`：工具类型，如`axe`、`pickaxe`、`shovel`、`hoe`、`sword`。 * `level`：工具等级，如`wood`、`stone`、`iron`、`diamond`、`netherite`。 * `attackDamage`：工具的攻击伤害。 * `attackSpeed`：工具的攻击速度。 * `durability`：工具的耐久度。 * `replace`定义了物品在客户端的展示物品，必须是一个(客户端)存在的物品ID，如`minecraft:stone`、`minecraft:iron_ingot`等(developing)。 #### 在数据包的 `data//block`目录下新建`.json`文件以定义方块。 _这是一个示例_ ``` { "hardness": 1.0, "resistance": 10.0, "lightLevel": 0, "replace": "minecraft:stone", "require_tool": true, "has_item": true, "replaceable": false } ``` 其中`hardness`、`resistance`、`lightLevel`、`replace`、`require_tool`、`tool`和`has_item`是可选的。 * `hardness`：方块的硬度。 * `resistance`：方块的爆炸抗性。 * `lightLevel`：方块的光照等级。 * `has_item`：方块是否有对应的物品形式。(若有，则在`data//item`目录下新建同名的物品定义文件) * `replace`定义了方块在客户端的展示方块，必须是一个(客户端)存在的方块ID，如`minecraft:stone`、`minecraft:oak_planks`等(developing)。 * `require_tool`：是否需要工具才能破坏方块。 ## ADM API * `cn.gcte.adm.api.ResReloadManager` 资源重载管理器 * `public static void register(Consumer consumer)` 注册listener, 该listener会在数据包刚开始加载时被调用。 `ResReloadManager.register(resourceManager -> { // 在这里处理资源刚加载 // 举个例子 LOGGER.info("Resource manager has been reloaded!"); });` * `cn.gcte.adm.api.GetBlockData` 获得方块数据包资源(即`data//block/.json`文件)。 * `public static String getAllData()`获得DataList(json字符串) * `cn.gcte.adm.api.GetItemData` 获得物品数据包资源(即`data//item/.json`文件)。 * `public static String getAllData()`获得DataList(json字符串)