Skip to main content

Spigot / Paper Plugin Installation

This guide covers Spigot, Paper, Folia, and Purpur. The plugin is the same across all four.

Requirements

VersionNotes
Minecraft1.8 through 1.21.xJava Edition
Java8 or newerJava 17+ required for Folia or MC 1.20.4+
Server softwareSpigot, Paper, Folia, or PurpurAny one of them

Install

  1. Download craftyai-spigot-1.2.0-beta.jar from Modrinth.
  2. Drop it into your server's plugins/ folder.
  3. Start the server.

On first start, the plugin generates an API key and prints it to the console once. Copy it. Then open plugins/CraftyAI/config.yml and paste the key where it says secret: "your-api-key". Run /crafty reload to load the new key without restarting.

That's it. Players can start talking to CraftyAI in chat.

What's in config.yml

The plugin generates a default config on first run. The fields that matter:

server:
secret: "your-api-key"

ai:
# What the AI is called in chat
name: "Crafty"

# Names players can use to address the AI
aliases:
- crafty
- craftyai
- ai
- helper

# Set to true to let the AI change time, weather, etc.
enable_actions: true

# Set to true to let the AI scan nearby blocks when asked
allow_block_scanning: true

You probably won't need to change any of this. The defaults work for most servers.

Commands

CommandWhat it does
/craftyShow plugin info
/crafty statusCheck connection
/crafty reloadReload config (admin only)
/crafty learn Q | ATeach the AI (admin only)
/crafty testSend a test message
/crafty apikeyGenerate a new API key
/crafty pro statusShow your current tier
/crafty pro redeem <key>Redeem a Pro key
/crafty linkGet a code to link this server to your Discord

Permissions

The default permissions are designed so most servers don't need a permissions plugin. OPs get everything. Standard players get only crafty.chat, which lets them talk to the AI but not trigger actions like time changes.

If you want to grant actions to specific players, install LuckPerms and add crafty.actions.

Folia note

Folia splits the server into multiple threads and regions. CraftyAI supports Folia but Java 17 is required, regardless of your Minecraft version.

Help

If something doesn't work, check Common Issues or ask on Discord.