Configuration
There are two parts to SteveChat's config - general plugin-wide settings and channel-specific settings. For those of you coming from other chat plugins, this should seem fairly familiar, as it was deliberately designed to be so.
General Settings
| Name | Description | Default Value |
|---|
| default-channel | The default channel which new players join if they have permission | Global |
| default-format.chat | The default format (see below) for chat messages | {color}{nick}&f: <{prefix}{sender}{suffix}&f> {msg} |
| default-format.announce | The default format (see below) for announcements | {color}{nick}&f: {msg} |
| default-format.emote | The default format (see below) for emotes | {color}{nick}&f: * {prefix}{sender}{suffix} &f{msg} |
| default-format.private-message | The default format (see below) for private messages | &d{tofrom} {partner}&d: {msg} |
| twitter-style-private-messages | Whether players can private message each other using @player message | true |
| check-updates | Whether SteveChat should periodically check for updates | true |
Channels
When SteveChat is first run, it should create a channels folder inside its plugin folder, containing example channels. To add a new channel, all you need to do is create a file called Channel.yml (the file name doesn't matter so long as it ends in .yml, but choose something sensible!) with the same structure as one of the example channels. Below is a list of the different settings for a channel.
| Name | Description | Example |
|---|
| name | The full name of the channel | Global |
| nick | The nickname for the channel | G |
| format | The format (see below) for chat messages | {default} |
| password | The password required to join the channel (can be left blank for no password) | Password123 |
| color | The color to use for the channel | DARK_GREEN |
| radius | The radius (in blocks) for players to hear other players' messages (0 or below disables this) | 50 |
| qm-shortcut | Whether players can use /<channel> as a shortcut for /ch qm <channel> | true |
| announce-activity | Whether players joining/leaving/being kicked/banned should be announced to members of the channel | true |
| server-wide | Whether the channel is available across the whole server or specific to certain worlds | true |
| worlds | If server-wide is set to true, this sets which worlds the channel can be used from | [ "world", "world_nether", "world_the_end", "pvp", "creative" ] |
| banned | Controls which players are banned from this channel | [ "Mr_CurseAlot", "SomePlayer" ] |
| muted | Controls which players are muted in this channel | [ "Sir_SpamsAlot", "WhinyKid" ] |
Format Codes
| Code | Replaced With | Example Output |
|---|
| & + valid color code | The actual color code sequence, allowing you to color sections of a chat message | (Red text follows) |
| {default} | The contents of default-format.chat specified in config.yml | {color}{nick}&f: <{prefix}{sender}{suffix}&f> {msg} |
| {name} | The channel's name | Global |
| {nick} | The channel's nickname | G |
| {color} | The color code for the channel | (Dark green text follows) |
| {msg} or {message} | The chat message | Hi there! |
| {sender} | The sender's display name | MrChat |
| {plainsender} or {fullsender} | The sender's full name | MrChatterbox |
| {world} | The sender's world | world_nether |
| {prefix} | The player's prefix (requires Vault and a supported plugin) | [Cool guy] |
| {suffix} | The player's suffix (requires Vault and a supported plugin) | [Awesome] |
| {group} | The player's group (requires Vault and a supported plugin) | Moderator |
| {groupprefix} | The player's group's prefix (requires Vault and a supported plugin) | [Slightly cool] |
| {groupsuffix} | The player's group's suffix (requires Vault and a supported plugin) | [Chilled] |
| {convoaddress} or {tofrom} | Either "To" or "From" in private messages | To |
| {partner} | The partner's display name (private messages only) | MrQuiet |
| {plainpartner} or {fullpartner} | The partner's full name (private messages only) | MrQuietPerson |
| {partnerworld} | The partner's world (private messages only) | world_nether |
| {partnerprefix} | The partner's prefix (requires Vault and a supported plugin) (private messages only) | [Noob] |
| {partnersuffix} | The partner's suffix (requires Vault and a supported plugin) (private messages only) | [Up-and-coming] |
| {partnergroup} | The partner's group (requires Vault and a supported plugin) (private messages only) | Player |
| {partnergroupprefix} | The partner's group's prefix (requires Vault and a supported plugin) (private messages only) | [Nooby] |
| {partnergroupsuffix} | The partner's group's suffix (requires Vault and a supported plugin) (private messages only) | [New] |
Comments