Skip to content

Initial Setup

mattboy9921 edited this page Oct 19, 2019 · 3 revisions

By default, CrewChat has a single chat channel called global. This name is not special in any way and can be used for anything you like.

The default configuration file looks like this:

# CrewChat Configuration

# Channels
channels:
  global:
    chatcolor: WHITE
    autosubscribe: true

Each channel is named by its configuration section. In this case, the name is global and will show in game as "global". Channel names are case sensitive in configuration.

Chat color refers to the color messages will appear in chat for that channel. Your choices are the 16 chat color options.

Autosubscribe specifies that new players will automatically be subscribed to this channel when their player data is created. You'll want to have at least one channel with this set to true so when new players join, they have a chat channel to see.

You can specify as many channels as you like, however you are limited by the 16 chat colors so having more than 16 channels means some would have the same color.

For the example above, the only permission needed for players to be able to use the global channel like a normal chat is:

crewchat.speak.global

This means it is possible to allow players to view a channel without being able to talk themselves. From there, you can choose permissions to allow players to subscribe/unsubscribe to the channel, meaning they would be able to see or not see the messages sent in that channel. There is also a separate permission to allow a player to set a channel as their active channel, in other words, the channel their messages are sent to.

Clone this wiki locally