Skip to content

Implementing this plugin

Leo edited this page Feb 21, 2017 · 5 revisions

Installation

You can find an archived Phar file of RealMute at the Releases page. Click here to go directly to the latest release.
Once you have finished downloading, put the Phar file under /plugins folder in your PocketMine-MP installation path, then restart PocketMine-MP or use other utility plugin to load RealMute.

Configuration

All settings of RealMute can be changed using commands. You can still edit config.yml manually when RealMute is disabled (not recommended). If you edit config.yml when RealMute is enabled, all modifications you made will lost.
All settings and related information of them are listed below.

Setting Description Flag in config.yml Default configuration Default key in config.yml Related command
Notification to muted players notification ON true `/realmute notify <on
Exclude OPs from muting all players excludeop ON true /realmute muteop
Auto-mute players if they send banned words wordmute OFF false /realmute wordmute
Block muted players' private messages banpm OFF false /realmute banpm
Auto-mute players if they flood the chat screen banspam OFF false /realmute banspam
Mute players/Slice messages when players send lengthy messages banlengthy OFF false `/realmute banlengthy <mute
Muted players cannot use signs bansign OFF false /realmute bansign
Mute devices/IPs alongside usernames muteuuidip OFF false /realmute mutedevice (API 2.0.0 and higher only) -or- /realmute muteip (API 1.x only)
Spam threshold spamthreshold OFF false /realmute spamth <time>
Time limit of auto-mute automutetime OFF false /realmute amtime <time>
length limit of chat messages lengthlimit OFF false /realmute length <number of characters>

Updating RealMute

Download a new version of RealMute at the Releases page.
Once you have finished downloading, replace the old Phar file of RealMute under /plugins folder in your PocketMine-MP installation path with the new one you downloaded, then restart PocketMine-MP.

Uninstallation

Delete the Phar file of RealMute and /plugins/RealMute folder in your PocketMine-MP installation path, then restart PocketMine-MP.

Notice on downgrading RealMute from version 3.x

Because of changes of internal mechanisms, configuration files generated by v3.x are not fully compatible with v2.4.x-v2.7.4.
If you want to downgrade RealMute from v3.x to v2.x, please make sure you use v2.7.5 or v2.0.x-v2.3.x so that you will not meet any problem.