Configuration

Landon Jobe edited this page Jan 10, 2018 · 17 revisions

Table of Contents

  1. Bot Configuration
  2. Chat Configuration
  3. Broadcast Configuration
  4. Moderator Channel Configuration

Configuration Files

When a config file have been generated or a config node have been added to one of the configurations below. The server startup will be stopped for safety. This will prevent unwanted errors to appear on your server console.

All configuration files provides very informative comments on each nodes. Those comments are straight forward and should be able to explain what the nodes are and what values you need to place.

Default Configurations

Bot Configuration

It's very important that you fill out all nodes of this configuration. Because the bot won't function properly, if the fields below are incomplete or left at default.

# +----------------------------------------------------+
# <                 Bot Configuration                  >
# <               All bot configuration                >
# +----------------------------------------------------+

# Bot token can be found on your
# Discord application page.
Bot_Token: sample.token

# Bot ID, this is also known as Client ID
# on your Discord application page.
Bot_ID: '123123123123'

# Owner ID of the owner of the bot, server, or guild.
# You can easily get your id by right
# clicking your self and copy id.
# This only works when developer mode is enabled.
# Go to settings>appearance and enable developer mode
Owner_ID: '12312312312313'

# Set of character that distinguish if it''s a command.
Command_Trigger: '!!'

# Should bot''s command responses be deleted after 5 minutes?
Delete_Response: false

# What language should the bot respond with
Localization: en

# This will be the game of the bot
# and will be shown under the name
# of the bot as "Playing <Default_Game>"
Default_Game: default

Chat Configuration

# +----------------------------------------------------+
# <                 Chat Configuration                 >
# <              All chat configurations               >
# +----------------------------------------------------+

# MCBChannel ID''s of text channels you
# want to bind Minecraft chat with
Relay_Channels:
- '123123123'
- '123123123'

# Formatting codes for messages coming from Discord
Message_Format: '&7'

# Prefix of messages that came from Discord.
# This can be formatted.
Discord_Prefix: '&6&l[Discord] &r{role} {ename}'

# Prefix of messages that came from Minecraft.
Minecraft_Prefix: '[Minecraft] {erank} {ename}'

# If a message from Discord is a command with any of the prefix
# below. That message won''t be relayed to Minecraft.
# You can block your own bot''s prefix
# by placing {this} place holder.
Blocked_Prefix:
- '~'
- ~~
- '{this}'

# If a message from Discord came from any of the Bots below.
# That message won''t be relayed to Minecraft.
Blocked_Bots:
- '123123123'
- '123123123'

Broadcast Configuration

Some nodes takes effect on moderator channel.

# +----------------------------------------------------+
# <              Broadcast Configuration               >
# <            All broadcast configuration             >
# <           Some nodes below will also be            >
# <             effective to Mod Channels              >
# +----------------------------------------------------+

# Will broadcast from other plugins be relayed to Discord?
See_Plugin_Broadcast: true

# Will player join event broadcast be relayed to Discord??
See_Player_Join: true

# Will player quit event broadcast be relayed to Discord?
See_Player_Quit: true

# Will player death event broadcast be relayed to Discord?
See_Player_Death: true

# Will ClearLag broadcasts be relayed to Discord?
See_ClearLag: true

# Do players with minecordbot.incognito
# permission be hidden from
# Join/Quit broadcast that are being relayed to Discord.
Hide_Incognito_Player: false

Moderator Channel Configuration

# +----------------------------------------------------+
# <             Mod Channel Configuration              >
# <           All mod channel configuration            >
# +----------------------------------------------------+

# ID of the text channel you want to make as a mod channel
# Leave it blank if you don''t want a mod channel
Mod_Channels:
- '123123123'
- '123123123'

# Do you want to prevent messages that
# are being sent on the mod channel
# to be relayed to Minecraft?
One_Way: false

# Do you want to see in-game chat on a mod channel?
See_Chat: true

# Will player join event broadcast be relayed to Mod MCBChannel?
See_Player_Join: true

# Will player quit event broadcast be relayed to Mod MCBChannel?
See_Player_Quit: true

# Will player death event broadcast be relayed to Mod MCBChannel?
See_Player_Death: true

# Do you want to see commands that
# are being executed on a mod channel?
See_Commands: true

# Do you want to see messages that
# have been cancelled by other plugin?
# Cancelled messages are considered
# a private message
See_Cancelled_Chats: true

# Do you want to see player chat that
# have been GriefPrevention soft muted.
See_GriefPrevention_SoftMute: true

# Do you want to see mcMMO Admin chat?
See_mcMMO_Admin_Chat: true

# Do you want to see mcMMO Party chat?
See_mcMMO_Party_Chat: true

# Do you want to see fake join/leave messages
# from SuperVanish on a mod channel?
# Will be marked "(Vanish)"
See_SV: true

# Do you want to see broadcasts on a mod channel?
See_Broadcast: true
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.