Quick Start Guide

Get PrimeChat up and running in 5 minutes with this quick start guide.

Step 1: Install the Plugin

1. Purchase PrimeChat for £14.99 GBP

2. Download PrimeChat.jar after purchase

3. Place it in your plugins/ folder

4. Restart your server

5. Verify installation with /plugins

Step 2: Basic Setup (2 minutes)

Set Chat Format

Edit plugins/PrimeChat/config.yml:

chat:
  format: "<%player_name%> %message%"

Enable Security

security:
  anti-spam:
    enabled: true
    cooldown: 3

Step 3: Set Permissions (1 minute)

For Admins:

permissions:
  - primechat.admin

For Players:

permissions:
  - primechat.color  # Optional: allow color codes

Step 4: Test Everything (2 minutes)

1. Chat Format: Send a message to see the new format

2. Admin GUI: Run /chat gui to open the control panel

3. Private Messages: Try /msg <player> hello

4. Security: Send messages quickly to test anti-spam

Essential Commands

• /chat gui - Open admin control panel

• /chat lock - Lock chat

• /chat reload - Reload config

• /msg <player> <message> - Private message

Next Steps

Once you have the basics working:

1. Customize Colors: Learn about hex colors and formatting

2. Setup PlaceholderAPI: Add rich placeholders to your chat

3. Configure Security: Fine-tune anti-spam and word filters

4. Add Chat Games: Set up trivia questions for your players

Common Issues

Chat Format Not Working

• Check YAML syntax in config.yml

• Ensure PlaceholderAPI is installed for placeholders

• Run /chat reload after changes

Permissions Not Working

• Verify your permission plugin is installed

• Check permission node spelling

• Restart server after major permission changes

Colors Not Showing

• Grant primechat.color permission

• Use & for basic colors or &#RRGGBB for hex colors

• Ensure client supports hex colors (1.16+)

Default Configuration

PrimeChat comes with sensible defaults:

• ✅ Anti-spam enabled (3 second cooldown)

• ✅ Hover information enabled

• ✅ Anti-advertising enabled

• ❌ Blocked words disabled (add your own)

• ❌ Chat games disabled (configure first)

Getting Help

• In-Game: /chat help

• Documentation: Browse this GitBook

• Discord: Join our server

• Issues: Check troubleshooting guide

---

Congratulations! 🎉 Your PrimeChat plugin is now configured and ready to enhance your server's chat experience.