Installation

This guide will help you install and set up Chatr on your Minecraft server.

Requirements

Before installing Chatr, ensure your server meets these requirements:

  • Minecraft Version: 1.21.x (Paper/Spigot)
  • Server Software: Paper recommended (Spigot compatible); Java Edition only
  • Java Version: Java 21 or higher
  • Dependencies:
    • AI server or API keys (LM Studio, Ollama, Groq, Mistral, NVIDIA, OpenRouter, Gemini for NPCs)

Download

  1. Visit the GitHub Releases page
  2. Download the latest Chatr-1.0.0.jar file
  3. Save it to your server’s plugins/ directory

Installation Steps

Step 1: Install Chatr

  1. Place Chatr-1.0.0.jar in your plugins/ directory
  2. Important: Perform a full server restart (not just /reload)
  3. Chatr will create its configuration files in plugins/Chatr/

Step 2: Configure an AI Provider

Open plugins/Chatr/config.yml and set at minimum:

ai:
  endpoint: "http://localhost:1234"  # or a cloud provider name
  model: "your-model-name"

See Configuration for full details.

Step 3: Verify Installation

Check your server console for:

[Chatr] Chatr plugin has been enabled!

If you see this message, Chatr is successfully installed.

Initial Configuration

After installation, you’ll need to configure at least one AI provider. See Configuration for detailed setup instructions.

Common Installation Issues

Plugin doesn’t load

  • Ensure you’re using Spigot/Paper 1.21+
  • Verify Java 21+ is being used
  • Check server logs for NMS compatibility errors

Configuration files missing

  • Make sure to do a full server restart after adding the JAR
  • Check file permissions on the plugins directory

Console errors

  • Enable debug mode in config.yml for detailed error information
  • Check that all required dependencies are installed

Next Steps

Once installed, proceed to:

  1. Configure your AI provider
  2. Create your first NPC
  3. Set up the server assistant (optional)