Discord Module Configuration

This guide covers all configuration options for the Discord Module, including bot settings, channel configuration, and permission management.

📁 Configuration Files

The Discord Module uses two main configuration files:

modules/discord/discord-bot.yml - Bot settings and permissions
modules/discord/channels.yml - Channel logging configuration

🤖 Bot Configuration

Basic Bot Settings

enabled: true

bot:
  # Bot Token (keep this secret!)
  token: "BOT_TOKEN"

  # Bot Status
  status: "dnd" # online, idle, dnd, invisible

  # Bot Activity
  activity:
    enabled: true
    type: "WATCHING" # PLAYING, STREAMING, LISTENING, WATCHING
    text: "Zenith-Mod Server"

Bot Status Options

Status	Description
`online`	Green online status
`idle`	Yellow idle status
`dnd`	Red do not disturb status
`invisible`	Gray invisible status

Activity Types

Type	Description	Example
`PLAYING`	Playing a game	”Playing Minecraft”
`STREAMING`	Streaming content	”Streaming on Twitch”
`LISTENING`	Listening to music	”Listening to music”
`WATCHING`	Watching something	”Watching Zenith-Mod Server”

📢 Channel Configuration

Log Channel Setup

enabled: true

channels:
  # Channel for kick logs
  kick_log: "CHANNEL_ID"

  # Channel for ban logs
  ban_log: "CHANNEL_ID"

  # Channel for unban logs
  unban_log: "CHANNEL_ID"

  # Channel for mute logs
  mute_log: "CHANNEL_ID"

  # Channel for unmute logs
  unmute_log: "CHANNEL_ID"

  # Channel for warn logs
  warn_log: "CHANNEL_ID"

Getting Channel IDs

Enable Developer Mode in Discord:
- User Settings → Advanced → Developer Mode
Right-click on the channel
Select “Copy ID”
Paste the ID into your configuration

Embed Settings

embed:
  # Show Discord-specific information in embeds
  show_discord_info: true

  # Show staff avatar in footer for Discord commands
  show_discord_staff_avatar: true

  # Show target player avatar as thumbnail
  show_target_avatar: true

🔐 Permission Configuration

Permission Structure

Permissions:
  # Basic commands
  GetInfo: ["ROLE_ID_1", "ROLE_ID_2"]
  Alts: ["ROLE_ID_1", "ROLE_ID_2"]
  Case: ["ROLE_ID_1", "ROLE_ID_2"]

  # Notes management
  Notes:
    List: ["ROLE_ID_1", "ROLE_ID_2"]
    Add: ["ROLE_ID_1"]
    Remove: ["ROLE_ID_1"]
    Clear: ["ROLE_ID_1"]
    Search: ["ROLE_ID_1", "ROLE_ID_2"]

  # Alt limit management
  AltLimit:
    Check: ["ROLE_ID_1", "ROLE_ID_2"]
    Set: ["ROLE_ID_1"]
    Remove: ["ROLE_ID_1"]

  # Moderation commands
  Kick: ["ROLE_ID_1", "ROLE_ID_2"]
  Warn: ["ROLE_ID_1", "ROLE_ID_2"]
  Mute: ["ROLE_ID_1", "ROLE_ID_2"]
  Ban: ["ROLE_ID_1", "ROLE_ID_2"]
  Unban: ["ROLE_ID_1", "ROLE_ID_2"]
  Unmute: ["ROLE_ID_1", "ROLE_ID_2"]

Permission Levels

Administrator Level

Full access to all commands
Bot management commands
Configuration changes

Moderator Level

Player information commands
Basic moderation commands
Notes management
Case viewing

Helper Level

Read-only commands
Basic player information
Limited moderation

Getting Role IDs

Enable Developer Mode in Discord
Right-click on the role in the server member list
Select “Copy ID”
Use the ID in your configuration

⚙️ Advanced Configuration

Server Settings

server:
  # Guild ID (optional, for specific server)
  guild_id: "GUILD_ID"

  # Channel IDs
  channels:
    general: "CHANNEL_ID"
    staff: "CHANNEL_ID"
    logs: "CHANNEL_ID"
    console: "CHANNEL_ID"

  # Role IDs
  roles:
    staff: "ROLE_ID"
    admin: "ROLE_ID"
    player: "ROLE_ID"

Bot Behavior Settings

behavior:
  # Auto-register commands on startup
  auto_register_commands: true

  # Command cooldown (seconds)
  command_cooldown: 3

  # Maximum command history
  max_command_history: 100

  # Enable debug logging
  debug_mode: false

🔄 Configuration Reloading

Reload Configuration

You can reload the Discord Module configuration without restarting the server:

# In-game command
/dcbot reload

# Or reload entire plugin
/zenith reload

Configuration Validation

The module validates configuration on startup:

✅ Bot token - Must be valid Discord bot token
✅ Channel IDs - Must be valid Discord channel IDs
✅ Role IDs - Must be valid Discord role IDs
✅ Permission structure - Must follow correct format

📊 Configuration Examples

Basic Setup

enabled: true

bot:
  token: "YOUR_BOT_TOKEN"
  status: "online"
  activity:
    enabled: true
    type: "WATCHING"
    text: "Zenith-Mod Server"

Permissions:
  GetInfo: ["123456789012345678"]
  Notes:
    List: ["123456789012345678"]
    Add: ["123456789012345678"]
  Kick: ["123456789012345678"]
  Ban: ["123456789012345678"]

Advanced Setup

enabled: true

bot:
  token: "YOUR_BOT_TOKEN"
  status: "dnd"
  activity:
    enabled: true
    type: "PLAYING"
    text: "Minecraft with Zenith-Mod"

server:
  guild_id: "123456789012345678"
  channels:
    general: "123456789012345678"
    staff: "123456789012345678"
    logs: "123456789012345678"
  roles:
    staff: "123456789012345678"
    admin: "123456789012345678"

Permissions:
  GetInfo: ["123456789012345678", "123456789012345679"]
  Notes:
    List: ["123456789012345678", "123456789012345679"]
    Add: ["123456789012345678"]
    Remove: ["123456789012345678"]
    Clear: ["123456789012345678"]
    Search: ["123456789012345678", "123456789012345679"]
  Alts: ["123456789012345678", "123456789012345679"]
  AltLimit:
    Check: ["123456789012345678", "123456789012345679"]
    Set: ["123456789012345678"]
    Remove: ["123456789012345678"]
  Kick: ["123456789012345678", "123456789012345679"]
  Warn: ["123456789012345678", "123456789012345679"]
  Mute: ["123456789012345678", "123456789012345679"]
  Ban: ["123456789012345678", "123456789012345679"]
  Unban: ["123456789012345678", "123456789012345679"]
  Unmute: ["123456789012345678", "123456789012345679"]
  Case: ["123456789012345678", "123456789012345679"]

behavior:
  auto_register_commands: true
  command_cooldown: 2
  max_command_history: 50
  debug_mode: false

🛠️ Troubleshooting Configuration

Common Issues

Issue: Bot not starting

Check if bot token is valid
Verify enabled: true is set
Check server console for errors

Issue: Commands not working

Verify role IDs are correct
Check permission configuration
Run /dcbot register to register commands

Issue: Logs not appearing

Check channel IDs are correct
Verify bot has permission to send messages
Check if logging is enabled

Configuration Validation

Use the in-game command to validate configuration:

/dcbot status

This will show:

Bot connection status
Configuration validity
Permission setup
Channel accessibility

Next Steps: Learn about Discord Permissions to secure your bot!