Integrating Your Own Item Plugin

ItemPluginHook Interface

To integrate a custom item plugin with Craftorithm, implement the ItemPluginHook interface and the ItemProvider interface:

public class MyPluginHook implements ItemPluginHook {
    
    @Override
    public ItemProvider itemProvider() {
        return new MyPluginItemProvider();
    }

    @Override
    public String pluginName() {
        return "MyPlugin";
    }



}

public class MyPluginItemProvider implements ItemProvider {

    @Override
    public String namespace() {
        return "myplugin"; // Namespace for item ID prefix
    }

    @Override
    public ItemStack matchItem(String id) {
        // Convert "myplugin:sword" to ItemStack
        return MyPluginAPI.getItem(id);
    }

    @Override
    public NamespacedItemId matchItemId(ItemStack itemStack) {
        // Reverse-lookup item ID from ItemStack
        String id = MyPluginAPI.getItemId(itemStack);
        if (id == null) {
            return null;
        }
        return NamespacedItemId.of(namespace(), id);
    }
}

Registering Hooks

Register during plugin startup:

CraftorithmAPI.INSTANCE.registerItemPluginHook(new MyPluginHook());

Existing Hook Reference

All of Craftorithm's hook implementations live in the hook module; refer to them when writing your own hook.

Notes

• Hook classes are initialized after Craftorithm starts but before recipes load
• matchItem() should return null if the item is not found
• matchItemId() should return null if the item does not belong to that plugin
• matchItemId() only returns the item ID; item amounts are handled by Craftorithm
• Avoid performing expensive operations in hooks
• matchItem() and matchItemId() must support being called asynchronously, otherwise an error will occur during recipe loading