Quick Start Guide

5 Minutes

Get VoxelAI up and running on your server in minutes! This guide will walk you through the essential setup and configuration.

🚀 5-Minute Setup

Follow these three simple steps to get VoxelAI running on your server. The entire process takes less than 5 minutes!

Installation Steps

Installation

1. Buy VoxelAI.jar from SpigotMC
2. Place in plugins folder
3. Start server
4. Stop server after files generate

plugins/VoxelAI.jar

API Key Setup

1. Get API key from Google AI Studio
2. Open plugins/VoxelAI/config.yml
3. Set gemini.api-key
4. Save file

gemini:
  api-key: "your-api-key-here"

Start Server

• Start your server
• Watch console for successful initialization
• Test with /voxelai stats

/voxelai stats

🎮 Basic Usage

Automatic Chat Moderation

ChatWarden automatically monitors and moderates chat messages in real-time.

[18:58:15] Player: spam spam spam

[18:58:16] VoxelAI: Warning issued to Player

No configuration needed - ChatWarden works automatically once installed!

⚙️ Essential Configuration

Punishment Thresholds

punishment_score_thresholds:
  warn: 1.0
  mute: 3.0
  tempban: 8.0
  ban: 20.0

Staff Permissions

permissions:
  voxelai.admin:
    description: Full admin access
    default: op

Exemptions

exemptions:
  exempt_permission: "voxelai.chatwarden.exempt"
  exempt_players:
    - "AdminPlayer1"

🛠️ Basic Commands

Player Commands

Commands available to all players

/ai <question>

Ask AI for help

/ai status

Check AI status

/voxelai help

Show all commands

Staff Commands

Commands for administrators and moderators

/voxelai stats

View statistics

/voxelai lookup <id>

Check punishment

/voxelai reload

Reload config

📊 Monitoring

Check Stats

/voxelai stats

Shows:

• Violations detected
• Punishments issued
• AI response times
• API usage

View Logs

plugins/VoxelAI/logs/
├── violations.log
├── punishments.log
└── debug.log

Test Setup

Test chat moderation:

Send test spam messages

Test AI assistant:

/ai help

📝 Next Steps

Fine-tuning

• Review violation patterns

• Adjust thresholds

• Customize messages

• Monitor performance

Staff Training

• Share commands

• Explain system

• Set guidelines

• Monitor usage

Documentation

• Read full docs

• Join Discord

• Check updates

• Report issues

🎉 You're All Set!

VoxelAI is now protecting your server! Check out the Punishment System and Escalation System documentation to learn more about how VoxelAI keeps your community safe.