ServerChannels

A powerful chat channelling plugin for PocketMine-MP

Category

PocketMine-MP plugins

Requirements

PocketMine-MP API 3.0.0

Overview

ServerChannels is a powerful chat channelling plugin for PocketMine-MP. You can create highly customizable chat channels on your MC:PE server thanks to this plugin.

Features:

• Custom format: customize the channel format with colors and tags
• Hidden/Unhidden channels: customize channel visibility (hidden channels messages will be seen only by players who joined that channels, unhidden channels messages will be seen by all players)
• Custom channels authentication: create whitelisted channels, protect them with a password or leave them accessible by all players

EvolSoft Website: https://www.evolsoft.tk

This Plugin uses the New API. You can't install it on old versions of PocketMine.

Donate

Please support the development of this plugin with a small donation by clicking 💵 here. Your small donation will help me paying web hosting, domains, buying programs (such as IDEs, debuggers, etc...) and new hardware to improve software development. Thank you 😄

Documentation

Text format (Available on PocketMine console and on MCPE v0.11.0 and later):

Colors:

Black ("&0");
Dark Blue ("&1");
Dark Green ("&2");
Dark Aqua ("&3");
Dark Red ("&4");
Dark Purple ("&5");
Gold ("&6");
Gray ("&7");
Dark Gray ("&8");
Blue ("&9");
Green ("&a");
Aqua ("&b");
Red ("&c");
Light Purple ("&d");
Yellow ("&e");
White ("&f");

Special:

Obfuscated ("&k");
Bold ("&l");
Strikethrough ("&m");
Underline ("&n");
Italic ("&o");
Reset ("&r");

Create and configure a channel:

Remember that you must have the "serverchannels.channels.<channel>" permission to join the channel

1. Run the command "/sch create <channel>"
   
2. Open "channels.yml" file inside plugin configuration folder and open it
   This is a channel config file entry:

# Channel name
channel_name:
  # Channel prefix
  prefix: "&7[&bExampleChannel&7]"
  # Channel suffix
  suffix: ""
  # Channel format
  # Available Tags:
  #  - {MESSAGE}: Show message
  #  - {PLAYER}: Show player name
  #  - {PREFIX}: Show prefix
  #  - {SUFFIX}: Show suffix
  #  - {TIME}: Show current time
  #  - {WORLD}: Show world name
  format: "{PREFIX} &7{PLAYER}: &f{MESSAGE}"
  # Channel visiblity (true if you want that channel messages will be seen by players in the channel only, false if you want that channel messages will be seen by all players)
  hidden: false
  # Channel authentication (0 or "none" = no authentication, 1 or "password" = password authentication, 2 or "whitelist" = whitelisted channel)
  auth: "none"
  # Channel password (this field is ignored unless auth is set to 1 or "password")
  password: ""
  # Channel whitelisted players array (this field is ignored unless auth is set to 2 or "whitelist")
  whitelist: []

Configuration (config.yml):

---
# Date\Time format (replaced in {TIME}). For format codes read http://php.net/manual/en/datetime.formats.php
datetime-format: "H:i:s"
# Log channel messages on console
log-on-console: true
# Default channel settings
default-channel:
  # Enable default (join) channel
  enabled: false
  # Default (join) channel
  channel: "users"
...

Commands:

/serverchannels - ServerChannels commands (aliases: [serverch, sch])
/sch info - Show info about this plugin
/sch help - Show help about this plugin
/sch reload - Reload the config
/sch create <channel> - Create a new channel
/sch join <channel> [password] - Join a channel
/sch leave - Leave the current channel
/sch list - Show the list of all channels

Permissions:

• serverchannels.* - ServerChannels permissions.
• serverchannels.channels.* - ServerChannels channels permissions.
• serverchannels.commands.* - ServerChannels commands permissions.
• serverchannels.commands.help - ServerChannels command Help permission.
• serverchannels.commands.info - ServerChannels command Info permission.
• serverchannels.commands.reload - ServerChannels command Reload permission.
• serverchannels.commands.create - ServerChannels command New permission.
• serverchannels.commands.join - ServerChannels command Join permission.
• serverchannels.commands.leave - ServerChannels command Leave permission.
• serverchannels.commands.list - ServerChannels command List permission.

API

Almost all our plugins have API access to widely extend their features.

To access ServerChannels API:
1. Define the plugin dependency in plugin.yml (you can check if ServerChannels is installed in different ways):

depend: [ServerChannels]

2. Include ServerChannels API in your plugin code:

//ServerChannels API
use ServerChannels\ServerChannels;

3. Access the API by doing:

ServerChannels::getAPI()