Channels are what players talk in and can be switched between using the /channel command or specialized channel shortcut command. By default, HuskChat has the following channels setup, perfect for a typical setup:
local- Local-scoped channel with
/lshortcut commands, for sending messages to players on the same server.
global(default channel) - Global-scoped channel with
/gshortcut commands, for sending messages across the network.
staff- Global-scoped channel with
/scshortcut commands. Great for letting staff communicate easily. Players need the
huskchat.channel.staff.receivepermissions to send and receive messages in this channel respectively.
helpop- Global-scoped channel with
/helpopshortcut command. Great for letting players easily contact staff. Players need the
huskchat.channel.helpop.receivepermission to receive messages in this channel.
To define custom channels, put them under the
channels: section of
config.yml. Below is the specification for how
this should be laid out, using a typical
staff channel as an example. Keys marked as (Required) should be present.
Fields not marked as required will be set to a default value.
channels: #... staff: # (Required) The ID of the channel. To switch to this channel, users would execute /channel staff format: '&e[Staff] %name%: &7' # (Required) Display format of the channel - See below broadcast_scope: GLOBAL # Broadcast scope of the channel - See below log_to_console: true # Whether messages sent to this channel should be logged to the proxy console filtered: false # Whether messages sent to this channel should be filtered and replaced (see below) permissions: send: 'huskchat.channel.staff.send' # Permission required to see channel messages receive: 'huskchat.channel.staff.receive' # Permission required to switch to & send messages shortcut_commands: # List of shortcut commands that users can use to quickly use the channel - /staff - /sc restricted_servers: # List of servers where messages in this channel can't be sent or received - hub #...
Channel scope defines the scope by which messages are broadcast and handled by HuskChat. The following options are available:
These scopes are available when running HuskChat on a proxy server (Velocity or BungeeCord/Waterfall)
GLOBAL- Message is broadcast globally to those with permissions via the proxy
LOCAL- Message is broadcast via the proxy to players who have permission and are on the same server as the source
PASSTHROUGH- Message is not handled by the proxy and is instead passed to the backend server
GLOBAL_PASSTHROUGH- Message is broadcast globally to those with permissions via the proxy and is additionally passed
LOCAL_PASSTHROUGH- Message is broadcast via the proxy to players who have permission and are on the same server as the source and is additionally passed to the backend server to the backend server
These scopes are available when running HuskChat on a single-server Spigot server
GLOBAL- Message is broadcast to everyone on the server
PASSTHROUGH- Message is not handled by HuskChat; chat will be delegated to other/the vanilla chat handlers
GLOBAL_PASSTHROUGH- Message is broadcast to everyone on the server and is additionally passed to other/the vanilla chat handlers (the event is not cancelled)
On a single server setup, the
LOCAL_PASSTHROUGH scopes duplicate the
You must define a
default_channel in config.yml that players will be put in when they join.
Additionally, you can define server specific defaults in the
server_default_channels section. When a player changes to
a server with a server_default_channel assigned, the player will automatically switch to the specified channel
server_default_channels: uhc: minigames bedwars: minigames
On a single-server setup, this is ignored.
If you'd like to prevent players from using certain channels in certain servers, you can define
each channel (see the channel definition above for an example). Players are unable to send or receive any messages in a
channel if they are connected to a server where it is restricted.
Additionally, if a player changes server to one where their current channel is restricted, it will change to
default_channel unless it has an overriding server default channel as outlined above.
You can also restrict use of the
/r commands in certain servers through the
On a single-server setup, this is ignored.