Spigot / Paper Plugin Installation

This guide covers the installation and configuration of the CraftyAI plugin for server platforms like Spigot, Paper, Folia, and Purpur.

Requirements

Requirement	Version	Notes
Minecraft	1.8 → 1.21.x+	Full support for legacy and modern versions.
Java	17+ (Recommended 21)	Java 17+ is mandatory for modern MC versions (1.20.4+). Legacy Java 8 is supported only for 1.8 - 1.12.2.
Server	Spigot, Paper, Folia, Purpur

:::warning Folia Users Java 17 or higher is mandatory for Folia, regardless of the Minecraft version, to support regionized multithreading. :::

Installation Steps

1. Download: Get the CraftyAI-1.0.0-beta.jar from our Modrinth page.
2. Install: Place the downloaded .jar file into your server's plugins/ directory.
3. First Run: Start your server. This will generate the default config.yml file and your unique Session ID.
4. Get API Key: Follow our API Key Guide to obtain your secret key.
5. Configure: Open plugins/CraftyAI/config.yml and paste your API key into the server.secret field. Customize other settings as desired.
6. Reload: Run /crafty reload in the server console or in-game (if you have permissions) to apply the changes.

Configuration (config.yml)

Here is a breakdown of the key settings in the config.yml file:

server:
  # Paste your API key here (starts with cai_)
  secret: "your-api-key"

ai:
  # The display name of the AI in chat
  name: "Crafty"
  
  # A list of names players can use to talk to the AI
  aliases:
    - crafty
    - craftyai
    - ai
    - helper
    
  activation:
    # Optional prefix required before the alias (e.g., @crafty)
    prefix: "@"
    # If true, players MUST use the prefix to trigger the AI
    require-prefix: false
    # If true, the AI will try to understand misspelled aliases
    fuzzy-match: true
    # Cooldown in seconds between queries per player
    cooldown: 3
    
  # Enable or disable the AI's ability to execute world commands
  enable_actions: true

Commands & Permissions

Command	Permission	Description
/crafty	crafty.chat	Show plugin information and version.
/crafty status	crafty.chat	View connection diagnostics and server ID.
/crafty reload	crafty.admin	Reload the configuration file from disk.
/crafty learn <Q> | <A>	crafty.admin	Teach the AI custom knowledge.
/crafty test	crafty.chat	Test the connection to the AI engine.

tip

Having trouble? Check out our Troubleshooting Guide or ask for help on Discord!