Creating.md

Creating a Chat Channel

This will introduce you to how to successfully create a chat channel for The New Chat using the chats.yml configuration file.

The format

The format for a channel in chats.yml looks like the following:

  Sample: #A random unqiue identifier.
    Commands: #The commands that will be used to join/send messages to this channel.
    - your
    - commands
    - here
    Handler: handler name #The name of the handler for your channel use https://github.com/TheNewEconomy/TheNewChat/blob/master/Variables.md
    Type: type name #The name of the type for your your channel, found under the handler at https://github.com/TheNewEconomy/TheNewChat/blob/master/Variables.md
    Format: "Your format here" #The format of your channel using core/handler-specific variables, and/or PAPI Placeholders.

Making a /townchat command for Towny Servers

In this example we'll make a simple Town Chat Channel for a towny server.

Using our variables page will tell you the handler for Towny is "towny". From there we find the correct type we need, which is town.

As seen here.

Chats:
  Town:
    Handler: towny
    Type: town

We'll also want the channel to be accessible using the /tc, and /townchat commands.

Chats:
  Town:
    Commands:
    - townchat
    - tc
    Handler: towny
    Type: town

From here we'll have to decide what format to use. For this we'll need to reference our variables page again for proper colour codes, and variables. For our format we'll want something like [player name]: message. This leads us to our final configuration as seen below.

Chats:
  Town:
    Commands:
    - townchat
    - tc
    Handler: towny
    Type: town
    Format: "<blue>[<white>$display<blue>]<white>: $message"

From here we may use some of the optional configurations as follows:

    Ignorable: true #Whether or not players may ignore this channel using /ignorechannel
    WorldBased: false #Whether chat in this channel is only sent to players in the same world.
    Radial: false #Whether chat in this channel is based on the player's location.
    Radius: 20 #The max distance away a player may be and here this channel's chat if Radial is true.
    Permission: "examplechat.chat" #The permission node required to use this channel.

Separators

We support a function we notate as "separators" in TNC. Separators allow you to add optional text after a variable if the variable is not empty/whitespace.

Example: If you're using the Towny provider and want to output a separator after a $nation variable you could do so using a separator.

[{$nation: | }$town]$display: $message

The above format would output "[<nation name> | <town name>]username: message" if $nation is not empty/whitespace. This may be used when you're not sure if players will have a nation, but want to use the variable in your chat formatting.

Checks

We support a function we notate as "checks" in TNC. These checks allow you to output specific formatting if a check is true, and also optionally output formatting for when it is false. Checks are built-in the chat handler, and as before the default ones provided by TNC are outlined in Variables.md.

Example: If you're using the Towny provider and want to output a colour code if a player is a king, you'd use the isking check.

{isking:<blue>:<white>}$display: $message

The above format would make the player's name blue if they are a king, otherwise white.