First Setup

Initial Configuration

After installing PrimeChat, follow these steps to configure it for your server:

1. Basic Chat Format

Edit the chat format in config.yml:

chat:
  format: "&#E0E0E0<%rank%&r&#E0E0E0> %player_name% &#888888»&#FDFDFD %message%"

This format includes:

• %rank% - Player's permission group (requires Vault)

• %player_name% - Player's display name

• %message% - The actual chat message

• Custom hex colors for styling

2. Configure Hover Information

Enable hover text to show player information:

chat:
  hover:
    enabled: true
    lines:
      - "&#00BFFF&lPlayer Information"
      - ""
      - "&#FFA500Player: &#FFFFFF%player_name%"
      - "&#FFA500Rank: &#FFFFFF%rank%"
      - "&#FFA500Money: &#FFFFFF%vault_eco_balance_formatted%"
      - "&#FFA500Health: &#FFFFFF%player_health%/%player_max_health%"

3. Security Settings

Configure basic security features:

security:
  anti-spam:
    enabled: true
    cooldown: 3  # seconds between messages
  
  blocked-words:
    enabled: true
    words:
      - "badword1"
      - "badword2"
  
  anti-advertising:
    enabled: true
    block-ipv4: true
    block-domains: true
    block-links: true

4. Set Up Permissions

Grant appropriate permissions to your staff and players:

For Administrators:

permissions:
  - primechat.admin
  - primechat.gui
  - primechat.spy

For Moderators:

permissions:
  - primechat.lock
  - primechat.unlock
  - primechat.clearchat

For VIP Players:

permissions:
  - primechat.color
  - primechat.hex
  - primechat.bypass.spam

5. Test Your Setup

1. Chat Format: Send a message to see your chat format

2. Hover Text: Hover over player names to see information

3. Security: Test anti-spam by sending messages quickly

4. Commands: Try /chat gui to open the admin panel

6. Customize Messages

Edit messages.yml to customize all plugin messages:

prefix: "&#FF6B6B&l[&#FFE66D&lPrimeChat&#FF6B6B&l]&r "
chat:
  cleared: "&#32CD32Chat has been cleared!"
  locked: "&#FF6B6B Chat is now locked!"
  unlocked: "&#32CD32Chat is now unlocked!"

Quick Commands Reference

• /chat gui - Open admin control panel

• /chat lock - Lock the chat

• /chat reload - Reload configuration

• /msg <player> <message> - Send private message

Need Help?

• Check the Troubleshooting guide

• Visit our Discord server

• Read the FAQ