Skip to content

Installation & Dependencies

System Requirements

ItemRequirement
Java21+
ServerPaper / Spigot 1.19.4+
FoliaFully supported

Installation

Place the downloaded Craftorithm-xx.jar into your plugins folder, then restart the server.

Installation Recommendations

To experience all features, it is recommended to use Paper server or its forks, and install either packetevents or ProtocolLib. Without a packet management plugin, the virtual recipe preview feature will not be available.

Migration from Old Version

The plugin has built-in conversion from old recipe formats that runs automatically on startup. However, for language files, it is recommended to delete the old lang folder and let it regenerate.

Soft Dependencies

The following plugins are optional. Installing them unlocks additional features:

PluginFeature
VaultEconomy system (money condition function, take_money/give_money actions)
PlayerPointsPoints system (points condition function, take_points/give_points actions)
PlaceholderAPIVariable parsing (papi condition function)
ProtocolLibRecipe book fake result preview
PacketEventsRecipe book fake result preview (ProtocolLib alternative)

External Item Plugin Hooks

Craftorithm supports integrating with the following item plugins, allowing you to use their item IDs directly in recipes:

PluginNamespaceItem ID Format
CraftEnginecraftenginecraftengine:<id>
Nexonexonexo:<id>
AzureFlowazureflowazureflow:<id>
NeigeItemsneigeitemsneigeitems:<id>
ItemsAdderitemsadderitemsadder:<id>
Oraxenoraxenoraxen:<id>
EcoItemsecoitemsecoitems:<id>
ExecutableItemsexecutableitemsexecutableitems:<id>
MMOItemsmmoitemsmmoitems:<type>:<id>
MythicMobsmythicmobsmythicmobs:<id>
SX-Itemsx-itemsx-item:<id>

Hook priority can be configured in config.yml under item_plugin_hook_priority.

Plugin Directory Structure

After installation, the plugin generates the following directory structure:

plugins/Craftorithm/
├── config.yml           # Main configuration
├── recipes/             # Recipe files
├── triggers/            # Trigger files
├── items/               # Custom items
├── menus/               # Menu configurations
│   ├── custom/          # Custom menus
│   └── internal/        # Built-in menus (do not modify)
├── item_packs.yml       # Item pack definitions
├── custom_fuels.yml     # Custom fuels
├── disabled_recipes.yml # Disabled recipe list
└── lang/                # Language files

基于 GPL-3.0 许可证发布