Extended Interactions

Minecraft 版本： 1.21.11

平台： fabric

标签： game-mechanics management utility

📖 About:

Extended Interactions adds radial menu for all blocks and entities that fill your world. This menu allows doing stuff without holding correct item in hand, without holding shift, etc. Just hold Tab and choose what you want to do.

❓ Why this mod exists?

There are a lot of radial(or similar) menu mods already, but most of them solve different problem.
These mods like Radial Macros and Radial are used for client-side actions like pressing keybinds. Basically create small macroses/scripts.

On other hand EI operates on both client and server to implement interactions/radial menu buttons/actions like vanilla mechanics - with own server code and client code. EI has ability to trigger keybinds and do other stuff radial menu macros/script mods does, but only as a workaround to support mods that don't have proper EI integration in them.

Running both on server and client gives us ability to ignore restrictions vanilla(or non-EI) servers have. For example actions like sheep shearing require holding specific items in player's hand. To implement this without server we would need to quickly put correct item in player's hand, do the required thing, and put items how they were originally. With server integrated we don't need to do anything like this, we can just shear the sheep directly. This improves performance with big network latency and UX in general.

📚 Compatibility:

EI has builtin support for following ingame docs mods: Oracle Index, Pathouli.
EI allows openning related articles from mentioned mod using radial menu.

EI also has a lot of vanilla interactions available. There is full list of features in in collapsed section below.

Full mod compatibility | Interaction / MC version | 1.21.1 | 1.21.11 | |-|-|-| | **`MC`** Sheep shearing | ✅ | ✅ | | **`MC`** Cow milking | ✅ | ✅ | | **`MC`** Mooshroom soup collection | ✅ | ✅ | | **`MC`** Attaching leashes | ✅ | ✅ | | **`MC`** Detaching leashes | ✅ | ✅ | | **`MC`** Putting saddles | ✅ | ✅ | | **`MC`** Trading with villagers | ✅ | ✅ | | **`MC`** Trading with wandering traders | ✅ | ✅ | | **`MC`** Configuring repeaters | ✅ | ✅ | | **`MC`** Take result from furnaces | ✅ | ✅ | | **`MC`** Insert plants into composters | ✅ | ✅ | | **`MC`** Insert keys into vaults | ✅ | ✅ | | [**`OI`**](https://modrinth.com/mod/oracle-index) Looking up articles based on target block | ✅ | ⛔ | | [**`PTO`**](https://modrinth.com/mod/patchouli) Looking up articles based on target block | ✅ | ⛔ | | 🦊 [**`MFG`**](https://modrinth.com/mod/mafglib) Activating lib keybinds in custom interactions | ✅ | ✅ | | 📜 [**`MLL`**](https://modrinth.com/mod/malilib) Activating lib keybinds in custom interactions | ✅ | ✅ | #### Table symbols | | | |-|-| |**`MC`** - Vanilla Minecraft interactions|✅ - Supported on latest EI version| |[**`OI`**](https://modrinth.com/mod/oracle-index) - [Oracle Index](https://modrinth.com/mod/oracle-index) interaction|⛔ - Third party mod is does not support this minecraft version| |Etc. All gray `boxes` in left column indicate mod interaction is for. Press on gray box to open mod's page|⚠️ - Interaction isn't implmented by EI yet!| | | ⏳ - Implemented on unreleased EI version | | | 📜 - Only on fabric | | | 🦊 - Only on neoforge |

👷🏻 For modpack and mod developers

For mod development EI has Java API for creating custom interactions. Modpack devs can create custom interactions using <.minecraft>/config/extended-interactions/custom directory.

Tutorial: Creating custom interactions using config All custom interactions are represented by json files in `/config/extended-interactions/custom` directory. Just create a file there and fill it with following: ```json { "icon": { "id": "minecraft:diamond" }, "blocks": [], "entities": [], "actions": [] } ``` File name must match [`[a-z][a-z0-9_]+\.json` regex](https://regex101.com/?regex=%5Ba-z%5D%5Ba-z0-9_%5D%2B%5C.json&testString=&flags=gm&flavor=pcre2&delimiter=%2F). ID of this interaction will be file's name without `.json` suffix. Interaction's icon is defined in `icon` property. It uses same format as [recipe result](https://minecraft.wiki/w/Recipe_(Java_Edition)#crafting_shapeless) does. Times when this interaction is available are defined by `blocks` and `entities` properties in following format: ```json { "subject": "". "if": [] } ``` For this kind of target to match all conditions in `if` property need to match. Conditions are formatted like so: ```json // Conditions for blocks { // Optional. Map of blockstate properties to values "state": { "waterlogged": "true" }, // Optional. NBT to match "nbt": { "CustomName": "Intersting block" }, // Optional. Chat component (https://minecraft.wiki/w/Text_component_format) to show if this condition has failed "message": "Block must be waterlogged" } ``` ```json // Conditions for entities { // Optional. NBT to match "nbt": { "Sitting": true }, // Optional. Chat component (https://minecraft.wiki/w/Text_component_format) to show if this condition has failed "message": "Fox must be sitting" } ``` Stuff that will happen if this interaction in triggered is defined by `actions` property. This are all supported actions: ```json // Since 1.1.0 // Execute chat command server-side // Command is executed as interaction target. (@s - is block or entity player looked at when openning radial menu) // To target player who is running the interaction use @ei:user { "type": "extended_interactions:command", "cmd": "item replace entity @s weapon.mainhand with minecraft:totem_of_undying" } ``` ```json // Since 1.1.0 // Right click with item is hand // This action automatically checks that player has item that // matches provided predicate. If player doesn't following message is displayed // {"translate":"extinter.extended_interactions.custom/.no_item"} { "type": "extended_interactions:use_item", // Item predicate (https://minecraft.wiki/w/Advancement/Conditions/item) "item": { "items": ["minecraft:shears"] } } ``` ```json // Since 1.1.0 // Trigger minecraft keybind client-side { "type": "extended_interactions:key", // Keybind identifier (https://minecraft.wiki/w/Controls#Configurable_controls) "key": "key.drop" } ``` ```json // Since 1.1.0. MaFgLib required // Trigger MaFgLib keybind { "type": "extended_interactions:mafglib", // Name of category this keybind belongs to "category": "Generic hotkeys", // Identifier of MaFgLib keybind "keybind": "openGuiConfigs" } ``` ```json // Since 1.1.0. MaLiLib required // Trigger MaLiLib keybind { "type": "extended_interactions:malilib", // Name of category this keybind belongs to "category": "Generic hotkeys", // Identifier of MaLiLib keybind "keybind": "openGuiConfigs" } ``` Custom interactions are named as a [language key](https://minecraft.wiki/w/Resource_pack#Language): `extinter.extended_interactions.custom/`. ### Example. Sheep shearing `/config/extended-interactions/custom/shearing.json:` ```json { "icon": { "id": "minecraft:shears" }, "blocks": [], "entities": [ { "subject": "minecraft:sheep", "if": [ { "nbt": {"Sheared": false}, "message": {"translate": "extinter.extended_interactions.custom/shearing.no_wool"} } ] } ], "actions": [ { "type": "extended_interactions:use_item", "item": { "items": ["minecraft:shears"] } } ] } ``` `/assets/lang/en_us.json`: ```json { "extinter.extended_interactions.custom/shearing": "Collect wool", "extinter.extended_interactions.custom/shearing.no_item": "You need a shears", "extinter.extended_interactions.custom/shearing.no_wool": "No wool to collect" } ```