Installation & Setup

Essential

Get VoxelAI installed and configured on your Minecraft server in just a few steps.

Before You Begin

Make sure you have a Google Gemini API key ready. You can get one for free at Google AI Studio.

Prerequisites

Server Requirements

Paper server 1.21+

Java 21 or higher

At least 1GB free RAM

API Requirements

Google Gemini API key

Internet connection

Outbound HTTPS access

Installation Steps

Buy the Plugin

Buy the latest version of VoxelAI from SpigotMC and place it in your plugins folder.

Buy from SpigotMC

plugins/VoxelAI.jar

First Run

Start your server to generate the default configuration files, then stop it.

[VoxelAI] Generating default configuration...

[VoxelAI] Configuration files created successfully!

[VoxelAI] Please configure your API key in config.yml

Configure API Key

Open the configuration file and add your Google Gemini API key.

File: plugins/VoxelAI/config.yml

core:
  debug_mode: false
  log_violations: true

gemini:
  api-key: "your-api-key-here"
  model: "gemini-2.0-flash-lite"

Replace your-api-key-here with your actual Google Gemini API key.

Restart Server

Start your server again and check the console for successful initialization.

[VoxelAI] Plugin enabled successfully!

[VoxelAI] ChatWarden system initialized

[VoxelAI] AI Assistant ready

[VoxelAI] API connection established

Verifying Installation

Check Plugin Status

Run the stats command to verify VoxelAI is working correctly.

/voxelai stats

You should see statistics about AI usage and violations.

Test AI Assistant

Test the AI assistant functionality with a simple command.

/ai help

The AI should respond with available commands and help information.

Test ChatWarden

Send a test message to verify chat moderation is working.

hello hello hello hello hello

ChatWarden should detect this as spam and issue a warning.

Permissions Setup

Basic Permission Nodes

Configure these permissions in your permissions plugin (LuckPerms, PermissionsEx, etc.)

voxelai.*:
  description: All VoxelAI permissions
  children:
    voxelai.admin: true
    voxelai.ai: true
    voxelai.chatwarden.exempt: false

voxelai.admin:
  description: Administrative access
  default: op

voxelai.ai:
  description: Access to AI assistant
  default: true

voxelai.chatwarden.exempt:
  description: Exempt from chat moderation
  default: op

Next Steps

Quick Start Guide

Learn the basics of using VoxelAI

View Quick Start →

Configuration Guide

Customize VoxelAI for your server

View Configuration →