Here you will find basic configuration instructions and guidelines for the Carbon config. If there is a setting or option you are looking for here that you cannot find, please go to Advanced Configuration.
- The default config itself can be found at
src/main/resources/config.yml
Before you can begin to effectively configure Carbon, it is necessary to understand the basis of the plugin, and a little bit about how it works. Carbon is built on channels, or, different chats which people can see and send messages in, based on a variety of different factors.
Some of these factors include permissions, especially the ability to send messages, and the ability to receive messages, in a particular channel, each of which is controlled by a separate permission. Another system of factors are contexts, which allow a person to interact with channels based off of factors like distance, mcMMO party, worldguard region, and towny town.
Just about every single setting and format in Carbon is configurable, which allows for massive potential! Want a broadcast channel with a special format? Simply create it in the config, and only give your players permission to see the channel, not send messages. Make the channel unignorable, and bam! a broadcast channel, exactly how you wanted.
With that covered, we will go over in a bit more detail the channel system, the basic options which most people will need to use, and the placeholders which Carbon supports in its formatting.
The channels system, as described above, is a powerful method of customizing chat exactly how you want it. Even if you want just one channel, it's a simple matter to configure it function exactly how you want it to! Here's an overview:
The default: section in the configuration is the first one, and it defines the standard attributes of every new channel, unless those attributes are specifically changed in that new channel. In other words, this section holds what the (customizable) formats are for every other channel unless you define different settings in them.
Click here for specifics of each option
switch-messageswitch-other-messageswitch-failure-messagetoggle-on-messagetoggle-off-messagetoggle-other-ontoggle-other-offcannot-use-channelformatsformat-groupscontextscolorignorableshould-bungeeprimary-group-onlydefault-groupcancel-message-eventhonors-recipient-listcustom-order
This section of the config is where you define channels and their attributes. Simply setting a channel up with a name will cause the channel to take on all the attributes that are set as default. To define things per-channel, that override default settings, simply set them as options with the same format as the examples already present in the config or in this wiki.
global- the name of the channel that Carbon uses internallyname- the name of the channel when usedaliases- other names/letters by which a channel can be useddefault- whether the channel is the default channel which players send messages to (main chat)message-prefix- messages that start with the string defined here will be sent to this channel
staff:
name: Staff
formats:
moderator: '<red>[Mod]<white><message>'
developer: '<green>[Dev]<white><message>'
admin: '<gold>[Admin]<red><message>'
ignorable: false
should-bungee: true
message-prefix: '$'
switch-message: '<color:#55FF55>Staff chat toggled. Time to whine to the developer? Click <green><click:run_command:"/fly">here<reset><color:#55FF55> to fly.'
cannot-use-channel: '<red><bold><italic>You are not permitted to use staff channel!'type- This option allows you to choose what you would like to use for formatting -Minimessage,MiniMessage-Markdown, orMineDown. Note that all formatting in the default config is set up forMiniMessage, which is the default. If you change this, you will have to change the formatting style of the config.
type: MiniMessageThis section of the config is where non-channel related formats are set.
Click here for specifics of each option
reloadedmessage-to-othermessage-from-otherspy-whispersno-reply-targetempty-channelchannel-switch-failureother-nickname-set
Click here for specifics of each option
meignoring-usernot-ignoring-userignore-exemptchannel-color-setspy-toggled-onspy-toggled-offspy-whispers-onspy-whispers-offnickname-set
This setting allows you to define what this server will appear as when you use the <server> placeholder in channel formats.
server-name: 'Hub'This setting allows you to define what placeholders can be used in messages in order to link to the item a person is holding in their hand.
item-link-placeholders:
- '[item]'
- '%item%'
- 'handitem'
- '~inhand~'This allows you to define what the prefix for the spy messages will be.
This section allows you to set up pings, a Carbon feature which will play a sound when a user is 'mentioned' in chat, kind of like a discord ping.
enabledsourcesoundvolumepitchhighlighton-whisper
This section allows you to set your storage method. Currently JSON and MySQL are supported
type: MySQL # JSON, MySQL
username: 'carbonuser'
password: 'fjopeq1514375_nfo3416asndfo'
database: 'mcserver'
hostname: '45.74.856.14'
port: 3306This section allows you to configure redis.
enabled: false
host: 'localhost'
port: 6379
database: 0- Defines the format of the message players receive when they enter the channel.
switch-message: '<green>You are now in <color><channel> <green>channel! Click <click:run_command:"/toggle <channel>">here<reset><green> to toggle it off.'- Defines the format others receive when you enter that channel.
switch-other-message: '<gray><player> </rainbow><gray>is now in <color><channel> <gray>chat!'- Defines the format and message received by default when you cannot switch to a channel using
/channelname
switch-failure-message: '<red>You cannot use channel <channel>!'- Defines the format of the message you see when you toggle visibility of the channel on.
toggle-on-message: '<gray>You can now see <color><channel> <gray>chat!'- Defines the format of the message you see when you toggle visibility of the channel off.
toggle-off-message: '<gray>You can no longer see <color><channel> <gray>chat!'- Defines the format of the message that other players see when you toggle visibility of the channel on.
toggle-other-on: '<gray><player> </rainbow><gray>can now see <color><channel> <gray>chat!'- Defines the format of the message that other players see when you toggle visibility of the channel off.
toggle-other-off: '<gray><player> </rainbow><gray>can no longer see <color><channel> <gray>chat!'- Defines the format of the message received when trying to use a channel one is not permitted to use. This includes
/<channelname>, which is used to set one's active channel (so their messages go there) and/<channelname> <message>, which is used to send a message to that channel but notswitch their primary one to it.
cannot-use-channel: '<red>You cannot use that channel!'- This section of the config defines per-group formats, which is the user's primary group retrieved from Vault. The default configuration includes a format, which is by default the one that appears in all channels unless specified otherwise in that channel's settings.
staff: '<gray>{[%vault_prefix%<gray>]} %player_displayname% </rainbow><gray>» <color><message>'
default: '<gray>[%vault_prefix%<gray>] %player_displayname%</rainbow><gray>: <color><message>'- This setting allows you to define an order of groups in which Carbon will check for the first match that the user has. If there are no matches, the plugin will fall back to the
primary-group-onlyoption. It's advised to set this option to[]if you don't want to use it.
custom-order:
- 'owner'
- 'admin'
- 'helper'
- 'builder'
- 'default'- If true, plugin will only use the format corresponding to the user's primary group (vault).
- If false, plugin will look through the user's groups and go with the first group with a corresponding format.
permission-group-matching: true- This setting determines which Vault group is taken to be the
defaultgroup for formatting purposes In other words, the group whose format the user will get if they do not have another group with a specified format for that channel.
default-group: 'default'- This portion of the default channel config deals with chat contexts, which are systems by which channels apply to users by default. These are all set to
falsein this section. For more information on contexts and what they do, please see this page on contexts
contexts:
distance: -1
mcmmo-party: false
worldguard-region: false
towny-town: false
filter: true
vault-balance: 0
vault-cost: 0- This setting defines the colour all channels are by default, unless overridden in a specific channel. When used it is the color that that
<color>placeholder is replaced with. - It also supports PAPI, however the placeholder must result in a valid colour.
color: '#FFFF00'- This setting detemines if users can, by default, use the
/togglecommand for the channel it's set in, and stop seeing messages from it.
ignorable: false- This setting enables or disables cross server chat for channels by default, unless overridden in a specific channel.
- This setting determines if Carbon will only set a non-default format for a user's primary group, or if it will set the format based on a search of all the user's groups, going with the first one it finds that the channel also has a specific format set for. It is highly recommended you leave this
truebecause the order of groups which Vault sends is unreliable and should only be used if you know what you're doing!
primary-group-only: true- Will prevent other plugins from seeing messages that they should not do things with. This should be set to
falsefor public channels, and totruefor private channels. - This will not break compatibility with plugins like DiscordSRV which can still be used with private channels, even when set to
true.
cancel-message-event: true- Used to allow other plugins to see who would recieve messages in a specific channel and is used for compatiblity. If you have another plugin which specifies what players receive certain messages, set this to true in the channel that plugin interacts in. Otherwise, leave it false.
honors-recipient-list: false- The message sent when Carbon successfully reloads
reloaded: '<Red>Chat config has been reloaded!'- Format of private messages as seen when sent.
<target>refers to the recipient of the private message.
message-to-other: '<green>[<gray>Me <gold>-> <gray><target></rainbow><green>] <message>'- Format of private messages as seen when received.
<sender>refers to the person sending the private message as seen when received.
message-from-other: '<green>[<gray><sender></rainbow> <gold>-> <gray>Me<green>] <message>'- Format of spy-detected whispers between other players.
<sender>refers to the person sending the message, and<target>refers to the person receiving it.
spy-whispers: '<yellow>Spy [<gray><sender></rainbow> <gold>-> <gray><target></rainbow><yellow>] <message>'- Message seen when a player tries to reply to private message when there are no private messages to reply to.
no-reply-target: '<red>You have no one to reply to!'- Empty channel message, received when sending a message to a channel with nobody else in it.
empty-channel: '<blue>You're <italic>all alone</italic> in this channel, <bold>nobody</bold> to hear you, <bold>nobody</bold> to answer. No matter how long, how often, how <italic>desperately</italic> you communicate, the vast distance of infinity is too great here, insurmountable, rendering you totally and completely unable to reach another living soul.'- Format of system message received when a player changes their nickname.
other-nickname-set: '<green><user></rainbow>''s nickname was set to <nickname><green>!'- Format of system message received when a player resets their nickname.
other-nickname-reset: '<green><user></rainbow>''s nickname was reset!'- Defines the format of the message sent to the channel the user is in when they run the
/me <message>command.
me: '<italic><dark_purple>*%player_displayname% </rainbow><message>*</dark_purple></italic>'- Message received when a user is ignored.
<player>refers to the ignored user.
ignoring-user: '<red>You have silenced <gold><player></rainbow><red> and will never hear from them again!'- Message received when a user is un-ignored.
<player>refers to the un-ignored user.
not-ignoring-user: '<green>You have chosen to make audible the cries of <gold><player></rainbow> once more!'- Message received when a player attempts to ignore someone that cannot be ignored.
<player>refers to the unignorable user.
ignore-exempt: '<red>You may not silence <gold><player></rainbow>! <red>They are exempt from being ignored!'- Message received when setting a channel colour.
<color>refers to the colour the channel is set to,<channel>to the name of the channel, and<hex>to the hex value of the<color>.
channel-color-set: '<green>You have set <color><channel> <green>color to <hex>!'- Message received when toggling on spy for a channel.
<color>refers to the color of the channel you toggled spy on for, and<channel>to its name.
spy-toggled-on: '<gray>You are now spying on <color><channel> <gray>chat!'- Message received when toggling off spy for a channel.
<color>refers to the color of the channel you toggled spy off for, and<channel>to its name.
spy-toggled-off: '<gray>You are no longer spying on <color><channel> <gray>chat!'- Message received when toggling on spy for whispers, or private messages.
spy-whispers-on: '<gray>You are now spying on private messages!'- Message received when toggling off spy for whispers, or private messages.
spy-whispers-off: '<gray>You are no longer spying on private messages!'- Message a player receives when they set their nickname.
nickname-set: '<green>Your nickname was set to <nickname></rainbow><green>!'- Message a player receives when they reset their nickname.
<purple>Your nickname was reset!