diff --git a/README.md b/README.md index 4dad5a5..e51e0a2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,167 @@ -CustomAlerts -============ +# CustomAlerts Customize or hide alerts (join/leave messages, etc...) plugin for PocketMine-MP +## Category + +PocketMine-MP plugins + +## Requirements + +PocketMine-MP Alpha_1.4 API 1.9.0 + +## Overview + +**CustomAlerts** allows you to customize or hide alerts (join/leave messages, etc...) + +**EvolSoft Website:** http://www.evolsoft.tk + +***This Plugin uses the New API. You can't install it on old versions of PocketMine.*** + +With CustomAlerts you can customize or hide join/leave messages, first join messages, death messages, world change messages... (read documentation) + +**Commands:** + +***/customalerts*** *- CustomAlerts commands* + +**To-Do:** + +
- Bug fix (if bugs will be found)
+
- Killed by mob message
+ +## Documentation + +**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");
+ +**Configuration (config.yml):** + +```yaml +--- +#Date\Time format (replaced in {TIME}). For format codes read http://php.net/manual/en/datetime.formats.php +datetime-format: "H:i:s" +#First Join message settings +FirstJoin: +#Enable First Join message +enable: true +#First Join message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +message: "&2[{TIME}] &a{PLAYER}&d joined the game for the first time." +#Join message settings +Join: +#Hide Join message +hide: false +#Enable custom join message +custom: true +#Join message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +message: "&2[{TIME}] &a{PLAYER}&e joined the game." +#Quit message settings +Quit: +#Hide Quit message +hide: true +#Enable custom quit message +custom: false +#Quit message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +message: "&4[{TIME}] &c{PLAYER}&e has left the game" +#Death message settings +Death: +#Hide Quit message +hide: false +#Enable custom quit message +custom: true +#Killed by player message +#Available Tags: +# - {PLAYER}: Show player name +# - {KILLER}: Show killer name +# - {TIME}: Show current time +kill-message: "&9{PLAYER} &ewas killed by &c{KILLER}" +#Death default message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +death-default-message: "&c{PLAYER} died" +#Death suffocation message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +death-suffocation-message: "&c{PLAYER} suffocated" +#Death fall message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +death-fall-message: "&c{PLAYER} fell from a high place" +#Death fire message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +death-fire-message: "&c{PLAYER} went up in flames" +#Death lava message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +death-lava-message: "&c{PLAYER} tried to swim in lava" +#Death drowning message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +death-drowning-message: "&c{PLAYER} drowned" +#Death explosion message +#Available Tags: +# - {PLAYER}: Show player name +# - {TIME}: Show current time +death-explosion-message: "&c{PLAYER} exploded" +#World Change message settings +WorldChange: +#Enable World Change message +enable: true +#World Change message +#Available Tags: +# - {ORIGIN}: Show origin world name +# - {PLAYER}: Show player name +# - {TARGET}: Show target world name +# - {TIME}: Show current time +message: "&2[{TIME}] &a{PLAYER}&e moved from &c{ORIGIN}&e to &a{TARGET}" +``` + +**Commands:** + +***/customalerts*** *- CustomAlerts commands* +

+**Permissions:** +
+-
customalerts.* - CustomAlertspermissions.
+-
customalerts.help - CustomAlerts command Help permission.
+-
customalerts.info - CustomAlerts command Info permission.
+-
customalerts.reload - CustomAlerts command Reload permission.