-
-
Notifications
You must be signed in to change notification settings - Fork 43
Channel Configuration
Here you will find channel configuration instructions and guidelines for the Carbon global.conf and other channel configs.
- The default global channel config itself can be found here
The style for channel formatting is MiniMessage, and PlaceholderAPI placeholders (surrounded by %) are permitted if you have PlaceholderAPI installed.
This section will describe each of the main sections of a channel's configuration file.
This section allows you to list aliases for the command to use this channel. By default, it is simply the channel's name.
This section allows you to set the formats of a channel - both the format printed to console (console) and the format shown to players (default_format).
The default_format setting applies to everyone by default.
You can add per-group formats using the group name as the format name. For example, if you copy the default_format line and change "default_format" to owner and then modify the format, anyone with the group owner in LuckPerms will have the modified format.
You can add per-language formats using the locales section of a channel. To do so easily, simply copy/paste and modify the default en_US section. Within per-language formats you can also define per-group formats. If you do not want to use this feature, you can delete the entire section safely.
This setting will be used internally and in other configs (like here) to identify the channel. It is good practice to name them following the default naming scheme, carbon:<channelname> as it will ensure seamless functionality.
This setting determines the base permission required to use the channel. It should always follow the convention set in the default config of carbon.channel.channelname for permissions functionality.
This setting allows a message prefix to be set for users to send a message to this channel without switching the channel they are in. For example, you could set this to ! for a staff channel and any message beginning with "!" would be sent to that channel.
This setting determines a bit of internal functionality and should be left true unless you know why you need to set it to false, and what it will do.