In this guide, we will walk through the purpose, setup, configuration, commands, and permissions of the PureChat plugin

What is PureChat?

PureChat is a key Pocketmine plugin that allows you to:

Have custom chat format (+colors)
Display chat ranks set using PurePerms - Required!

How do you install it?

Download the plugin from Poggit
Upload it to your plugins folder
Restart your server

Having trouble? Check out our plugin setup article

How do you configure it?

Options
To start off, there are a few options. None are necessary for the plugin to work, but we'll go over them anyways:

version: "1.4.0-BETA-04": Do not touch this!

default-factions-plugin: ~: Optional faction plugin compatibility (FactionsPro or XeviousPE-Factions) - Some other faction plugins will work as well but require different forks of PureChat.

enable-multiworld-chat: false: Enable this if you want to use per-world chat formats / per-world nametags for players

Ranks
A few permission groups will have already been set, and from there you'll be able to edit them or add more. Make sure all groups have been set using PurePerms!

Here's the default Guest rank that we'll analyze:

groups:
  Guest:
    chat: "&3&l{prefix}&e[Guest]&f&r {display_name} &7> {msg}"
    nametag: "&3&l{prefix}&e[Guest]&f&r {display_name}"
    worlds: []

chat is where you determine how the rank will display in the chat (possibly using color codes and tags - you can add suffixes, prefixes, faction ranks, and colored chat!)
nametag is where you determine how the rank will display above the player
worlds: list all worlds where this permission group's chat formatting should apply (leave blank for all)

You can then add as many ranks as you want!

Reminder: color codes
&0: Black, &1: Dark Blue, &2: Dark Green, &3: Dark Aqua, &4: Dark Red, &5: Dark Purple, &6: Gold, &7: Gray, &8: Dark Gray, &9: Blue
&a: Green, &b: Aqua, &c: Red, &d: Light Purple, &e: Yellow, &f: White
&k: Obfuscated, &l: Bold, &m: Strikethrough, &n: Underline, &o: Italic, &r: Reset

Available PureChat tags
{display_name}, {msg}, {fac_name}, {fac_rank}, {prefix}, {suffix}, {world}

The formatting group in PureChat should have the same name as the corresponding PurePerms permission group if you want them to connect! (ex: "Guest" PureChat format for "Guest" PurePerms permission group)

What are the commands and permissions?

Make sure you have the permissions in order to execute commands, or make sure you are an operator!

/setsuffix <player> <suffix>: Set a players suffix - Permission: pchat.command.setsuffix
/setprefix <player> <prefix>: Set a players prefix - Permission: pchat.command.setprefix
/setnametag <group> [world] <format>: Set the default nametag of a group - Permission: pchat.command.setnametag
/setformat <group> [world] <format>: Set default chat format - Permission: pchat.command.setformat

Great! PureChat should now be all setup, have fun setting permission group chat formats!

Don't know how to set permission groups for Pocketmine? Check out our PurePerms setup article here!

Article made by Emperor#9999 ( ID 764580296673853460 )

Updated on: 14/06/2022