Channel Configuration - Hexaoxide/Carbon GitHub Wiki

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, see formatting section for more info. 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 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 section is divided into 2, basic and locales:

• basic - Allows you to set the various kinds of formats of a channel. They are:
  • default_format - Applies to everyone. Main format of channel. Visible to players.
  • console - Applies to console log messages.
  • discord - Format is what's shown to supported Discord integrations.
  • <group> - Allows you to set formats for different permission groups.

format {
	basic {
		default_format="<<username>> <message>"
		vip="[VIP] <<username>> <message>"
		admin="<white>[</white>Prefix<white>]</white> <display_name><white>: <message></white>"
		discord="<message>"
	}
}

• locales - Per language chat formats. Leave section empty if you don't want to use this feature. Each locale section can be configured in the same way as the above 'basic' section. Will fall back to the 'basic' section if no format was found for the player's locale. Locale files (with their locale keys) can be seen here.

format {
	locales {
		"en_US" {
			default_format="<<username>> <message>"
			vip="[VIP] <<username>> <message>"
			admin="<white>[</white>Prefix<white>]</white> <display_name><white>: <message></white>"
			discord="<message>"
			}
		}
	}

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.

This section allows you to list aliases for the command to use this channel. By default, it is simply the channel's name.

command-aliases=[
  team,
  group
]

The distance in blocks players must be within to see each other's messages. A value of '-1' disables this feature completely. A value of '0' requires that both players are in the same world. On velocity, '0' requires that both players are in the same server.

If true, players will be able to see if they're not sending messages to anyone because they're out of range from the radius.

Dynamically created hashmap of players and their current cooldown. Do not edit manually.

Cooldown between sending messages in a channel, measured in milliseconds. Set to -1 to disable completely.

Whether this channel's messages should be sent cross-server.