Extended Interactions

Table symbols

All custom interactions are represented by json files in <.minecraft>/config/extended-interactions/custom directory. Just create a file there and fill it with following:

{
    "icon": {
        "id": "minecraft:diamond"
    },
    "blocks": [],
    "entities": [],
    "actions": []
}

File name must match [a-z][a-z0-9_]+\.json regex. 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 does.

Times when this interaction is available are defined by blocks and entities properties in following format:

{
    "subject": "<block/entity identifier>".
    "if": [<list of conditions>]
}

For this kind of target to match all conditions in if property need to match. Conditions are formatted like so:

// 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"
}

// 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:

// 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"
}

// 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/<interaction id>.no_item"}
{
    "type": "extended_interactions:use_item",
    // Item predicate (https://minecraft.wiki/w/Advancement/Conditions/item)
    "item": {
        "items": ["minecraft:shears"]
    }
}

// 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"
}

// 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"
}

// 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: extinter.extended_interactions.custom/<interaction id>.

Example. Sheep shearing

<.minecraft>/config/extended-interactions/custom/shearing.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"]
            }
        }
    ]
}

<resource-pack>/assets/lang/en_us.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"
}