• ftbultimine:excluded_tools - items in this tag can't be used for ultimining (applies to main hand slot)
• ftbultimine:excluded_tools/strict - items in this tag can't be used for ultimining (applies to main and offhand slots)
• ftbultimine:included_tools - if require_tool is true in server config, by default only "tool" items can be used (tiered items with durability); this can be used to allow extra items

• ftbultimine:excluded_blocks - blocks in this tag may never be ultimined
• ftbultimine:block_whitelist - if this tag is non-empty, then only blocks in this tag may be ultimined
• ftbultimine:farmland_tillable - blocks in this tag can be ultimine-tilled with a hoe tool; includes grass & dirt blocks by default
• ftbultimine:shovel_flattenable - blocks in this tag can be ultimine-flattened (turned to dirt path) with a shovel tool; includes grass & dirt blocks by default

Following nodes can be configured via FTB Ranks:

• ftbultimine.max_blocks - if present in a player's rank, overrides the server max_blocks config setting
• ftbultimine.ultimine_cooldown - if present in a player's rank, overrides the server ultimine_cooldown setting

Note: anything in the dev.ftb.mods.ftbultimine.api package is public API, and we will make every effort to keep this API stable. Any code outside the api package is subject to change without notice - please to try to avoid using this code directly. Contact us if you want to create an addon mod that the existing API does not cover, and we will try to help.

FTB Ultimine fires a few Architectury events intended to make it easy for modders to write plugins and extension to FTB Ultimine.

This provides for custom behaviour when a block is right-clicked and the Ultimine key is currently pressed. Look at code in the dev.ftb.mods.ftbultimine.rightclick package for examples.

In your mod constructor, register an instance of a class which implements RightClickHandler:

RegisterRightClickHandlerEvent.REGISTER.register(dispatcher -> dispatcher.registerHandler(MyHandler.INSTANCE));

Example handler:

public enum MyHandler implements RightClickHandler {
    INSTANCE;

    @Override
    public int handleRightClickBlock(ShapeContext shapeContext, InteractionHand hand, Collection<BlockPos> positions) {
        // do the work you need here
        return numberOfBlocksAffected;
    }
}

This allows for detection of custom crops which don't behave like vanilla crops. Builtin support is included for Agricraft (see the AgriCraftCropLikeHandler class).

In your mod constructor, register an instance of a class which implements CropLikeHandler:

RegisterCropLikeEvent.REGISTER.register(registry -> registry.register(MyHandler.INSTANCE));

See VanillaCropLikeHandler or AgriCraftCropLikeHandler for examples.

This can be used to restrict players' ability to ultimine based on criteria of your choosing.

RegisterRestrictionHandlerEvent.REGISTER.register(registry -> registry.register(MyHandler.INSTANCE));

Example to require player to be holding a specific item:

public enum MyHandler implements RestrictionHandler {
    @Override
    public boolean canUltimine(Player player) {
        return player.getMainHandItem().getItem() instanceof SomeCustomItem;
    }
}

This can be used to register custom ultimining shapes.

In your mod constructor, register an instance of the Shape interface:

RegisterShapeEvent.REGISTER.register(registry -> registry.register(MyShape.INSTANCE));

• For Modpack issues, please go here: https://go.ftb.team/support-modpack
• For Mod issues, please go here: https://go.ftb.team/support-mod-issues
• Just got a question? Check out our Discord: https://go.ftb.team/discord

All Rights Reserved to Feed The Beast Ltd. Source code is visible source, please see our LICENSE.md for more information. Any Pull Requests made to this mod must have the CLA (Contributor Licence Agreement) signed and agreed to before the request will be considered.