Update README.md

EvolSoft · Jun 12, 2022 · fb994da · fb994da
1 parent 8cc87c0
commit fb994da
Showing 1 changed file with 36 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -12,13 +12,13 @@ PocketMine-MP plugins
 
 ## Requirements
 
-PocketMine-MP API 3.0.0
+PocketMine-MP API 4.0.0
 
 ## Overview
 
 **CustomAlerts** lets you customize or hide all PocketMine alerts (join/leave messages, whitelist messages, outdated server/client messages, etc...)
 
-**EvolSoft Website:** http://www.evolsoft.tk
+**EvolSoft Website:** *Downed*
 
 ***This Plugin uses the New API. You can't install it on old versions of PocketMine.***
 
@@ -41,16 +41,16 @@ In the ZIP file you will find:<br>
 
 **Commands:**
 
-***/customalerts*** *- CustomAlerts commands*
+***/customalerts*** *- CustomAlerts commands* ❗**(Temporarly not usable due to some unknow issues)**❗
 
 ## Donate
 
-Please support the development of this plugin with a small donation by clicking [:dollar: here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=flavius.c.1999@gmail.com&lc=US&item_name=www.evolsoft.tk&no_note=0&cn=&curency_code=EUR&bn=PP-DonationsBF:btn_donateCC_LG.gif:NonHosted). 
+Please support the development of this plugin with a small donation by clicking [:dollar: here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=talalsatouri5@gmail.com&lc=US&item_name=KanekiLeChomeurk&no_note=0&cn=&curency_code=EUR&bn=PP-DonationsBF:btn_donateCC_LG.gif:NonHosted). 
 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 :smile:
 
 ## Documentation
 
-**Text format (Available on PocketMine console and on MCPE v0.11.0 and later):**
+**Text format (Available on PocketMine console and on MCPE since v0.11.0):**
 
 **Colors:**
 
@@ -106,7 +106,6 @@ OutdatedClient:
   #Outdated Client message
   #Available Tags:
   # - {MAXPLAYERS}: Show the maximum number of players supported by the server
-  # - {PLAYER}: Show player name
   # - {TIME}: Show current time
   # - {TOTALPLAYERS}: Show the number of all online players
   message: "&cYour MCPE client is outdated!"
@@ -117,7 +116,6 @@ OutdatedServer:
   #Outdated Server message
   #Available Tags:
   # - {MAXPLAYERS}: Show the maximum number of players supported by the server
-  # - {PLAYER}: Show player name
   # - {TIME}: Show current time
   # - {TOTALPLAYERS}: Show the number of all online players
   message: "&cOops! Server outdated!"
@@ -128,7 +126,6 @@ WhitelistedServer:
   #Whitelisted Server message
   #Available Tags:
   # - {MAXPLAYERS}: Show the maximum number of players supported by the server
-  # - {PLAYER}: Show player name
   # - {TIME}: Show current time
   # - {TOTALPLAYERS}: Show the number of all online players
   message: "&c&oThis Server is whitelisted!"
@@ -138,7 +135,6 @@ FullServer:
   custom: true
   #Available Tags:
   # - {MAXPLAYERS}: Show the maximum number of players supported by the server
-  # - {PLAYER}: Show player name
   # - {TIME}: Show current time
   # - {TOTALPLAYERS}: Show the number of all online players
   message: "&e{PLAYER}&b, The Server is full &c[{TOTALPLAYERS}/{MAXPLAYERS}]&b!\n&l&dTry to join later :)"
@@ -369,7 +365,7 @@ Death:
 
 **Commands:**
 
-***/customalerts*** *- CustomAlerts commands*
+***/customalerts*** *- CustomAlerts commands* **Not usable for the moment**
 <br><br>
 **Permissions:**
 <br>
@@ -402,7 +398,7 @@ use CustomAlerts\Events\CustomAlertsJoinEvent;
 class Example extends PluginBase implements Listener {
 }
 ```
-*4. Check if CustomAlerts API is compatible (insert this code in onEnable() function)*
+*4. Check if CustomAlerts API is compatible (insert this code in onEnable():void function)*
 ```php
 if(CustomAlerts::getAPI()->getAPIVersion() == "(used API version)"){
             //API compatible
@@ -485,15 +481,15 @@ This event is handled when a player is kicked due to full server.
 
 Event functions are:
 
-###### Get Player:
+###### Get NetworkSession:
 
 ```php
-Player getPlayer()
+Player getOrigin()
 ```
 **Description:**<br>
-Get event player.<br>
+Get event NetworkSession.<br>
 **Return:**<br>
-The event player (instance of pocketmine\Player)
+The event NetworkSession (instance of pocketmine\Player)
 
 ###### CustomAlertsJoinEvent:
 
@@ -509,7 +505,7 @@ Player getPlayer()
 **Description:**<br>
 Get join event player.<br>
 **Return:**<br>
-The join event player (instance of pocketmine\Player)
+The join event player (instance of pocketmine\player\Player)
 
 ###### Get default PocketMine join message:
 
@@ -543,31 +539,31 @@ This event is handled when a player is kicked due to outdated client.
 
 Event functions are:
 
-###### Get Player:
+###### Get NetworkSession:
 
 ```php
-Player getPlayer()
+Player getOrigin()
 ```
 **Description:**<br>
-Get event player.<br>
+Get event NetworkSession.<br>
 **Return:**<br>
-The event player (instance of pocketmine\Player)
+The event NetworkSession (instance of pocketmine\network\mcpe\NetworkSession)
 
 ###### CustomAlertsOutdatedServerKickEvent:
 
 This event is handled when a player is kicked due to outdated server.
 
 Event functions are:
 
-###### Get Player:
+###### Get NetworkSession:
 
 ```php
-Player getPlayer()
+Player getOrigin()
 ```
 **Description:**<br>
 Get event player.<br>
 **Return:**<br>
-The event player (instance of pocketmine\Player)
+The event NetworkSession (instance of pocketmine\network\mcpe\NetworkSession)
 
 ###### CustomAlertsQuitEvent:
 
@@ -583,7 +579,7 @@ Player getPlayer()
 **Description:**<br>
 Get quit event player.<br>
 **Return:**<br>
-The quit event player (instance of pocketmine\Player)
+The quit event player (instance of pocketmine\player\Player)
 
 ###### Get default PocketMine quit message:
 
@@ -604,12 +600,12 @@ Event functions are:
 ###### Get Player:
 
 ```php
-Player getPlayer()
+PlayerInfo getPlayerInfo()
 ```
 **Description:**<br>
 Get event player.<br>
 **Return:**<br>
-The event player (instance of pocketmine\Player)
+The event PlayerInfo (instance of pocketmine\player\PlayerInfo)
 
 ###### CustomAlertsWorldChangeEvent:
 
@@ -625,27 +621,27 @@ Player getPlayer()
 **Description:**<br>
 Get world change event player.<br>
 **Return:**<br>
-The world change event player (instance of pocketmine\Player)
+The world change event player (instance of pocketmine\player\Player)
 
-###### Get Origin Level:
+###### Get Origin World:
 
 ```php
-Level getOrigin()
+World getFrom()
 ```
 **Description:**<br>
-Get origin level.<br>
+Get origin world.<br>
 **Return:**<br>
-The origin level (instance of pocketmine\Level)
+The origin world (instance of pocketmine\world\World)
 
-###### Get Target Level:
+###### Get Target World:
 
 ```php
-Level getTarget()
+World getTarget()
 ```
 **Description:**<br>
-Get target level.<br>
+Get target world.<br>
 **Return:**<br>
-The target level (instance of pocketmine\Level)
+The target world (instance of pocketmine\world\World)
 
 **CustomAlerts API Functions:**
 
@@ -696,12 +692,11 @@ Check if outdated client message is custom.<br>
 
 ###### Get outdated client message:
 ```php
-string getOutdatedClientMessage(Player $player)
+string getOutdatedClientMessage()
 ```
 **Description:**<br>
 Get outdated client message.<br>
 **Parameters:**<br>
-*$player* the current player<br>
 **Return:**<br>
 *string*
 
@@ -716,12 +711,11 @@ Check if outdated server message is custom.<br>
 
 ###### Get outdated server message:
 ```php
-string getOutdatedServerMessage(Player $player)
+string getOutdatedServerMessage()
 ```
 **Description:**<br>
 Get outdated server message.<br>
 **Parameters:**<br>
-*$player* the current player<br>
 **Return:**<br>
 *string*
 
@@ -736,12 +730,11 @@ Check if whitelist message is custom.<br>
 
 ###### Get whitelist message:
 ```php
-string getWhitelistMessage(Player $player)
+string getWhitelistMessage()
 ```
 **Description:**<br>
 Get whitelist message.<br>
 **Parameters:**<br>
-*$player* the current player<br>
 **Return:**<br>
 *string*
 
@@ -756,7 +749,7 @@ Check if full server message is custom.<br>
 
 ###### Get full server message:
 ```php
-string getFullServerMessage(Player $player)
+string getFullServerMessage()
 ```
 **Description:**<br>
 Get full server message.<br>
@@ -854,7 +847,7 @@ Check if world change message is enabled.<br>
 
 ###### Get world change message:
 ```php
-string getWorldChangeMessage(Player $player, Level $origin, Level $target)
+string getWorldChangeMessage(Player $player, World $origin, World $target)
 ```
 **Description:**<br>
 Get default world change message.<br>