From 3b7730dae16a27d15cb704371f75f1dabf258fbf Mon Sep 17 00:00:00 2001 From: VixikHD Date: Fri, 5 Aug 2022 18:00:11 +0200 Subject: [PATCH] Update description --- README.md | 195 +++++++++++++----------------------------------------- 1 file changed, 45 insertions(+), 150 deletions(-) diff --git a/README.md b/README.md index 57ffc406..be008b39 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,67 @@

- - - - - - - - - - - - - - - + + + + + + + + + + + +

✔️ Passing PHPStan Level 9
✔️ Simple world management commands
- ✔️ New generators (Ender, Nether, Void, SkyBlock) -
- ✔️Custom world generator + ✔️ Custom generators (Vanilla, Ender, Nether, Void, SkyBlock)
✔️ Supports last PocketMine API version
✔️ Multi-language system
- ✔️ Implemented Game Rules -
✔️ Simple API for other plugins +
+ ✔️ Command autofill

+## 👍 2.0.0 Update: -## 👍 1.7.0 Update: - -> - Bug fixes -> - Update to PocketMine 4.x api - +> - Removed old Custom & Custom Nether generators +> - Added Muqsit's VanillaGenerator (Normal and Nether) with some modifications & fixes +> - Removed /mw update & /mw gamerule commands. There will be replacements for those in the future +> - Removed GameRules api +> - Removed Dimension handling api +> - Added command autofill with CortexPE's library Commando ## ⬇️ Downloads: -| Version | Phar Download | Zip Download | API | Stable | Pre release | -|-------------|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------|------------------------------|--------|-------------| -| 1.7.0-beta2 | [Poggit CI](https://poggit.pmmp.io/r/149254/MultiWorld_dev-236.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/af347f880fc32422962b6d6a7dea73007ccc5232.zip) | 4.0.0 | ❌ | ✔ | -| 1.6.0-beta6 | [Poggit releases](https://poggit.pmmp.io/p/MultiWorld/1.6.0-beta6) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/77c593081c15a11795431c1dfb8cd8b26906c5bc.zip) | 3.20.0+ | ✔ | ✔ | -| 1.5.3 | [Poggit releases](https://poggit.pmmp.io/p/MultiWorld/1.5.3) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/97901625970449e6fbc0825ef663217b1d31b8be.zip) | 3.20.0+ | ✔ | ❌ | -| 1.5.2 | [Poggit releases](https://poggit.pmmp.io/p/MultiWorld/1.5.2) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/5ab655846002e4ce9cfd9768b519c2da6e84a8d4.zip) | 3.x.x | ✔️ | ❌ | -| 1.5.1 | [Poggit releases](https://poggit.pmmp.io/p/MultiWorld/1.5.1) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/7070892a1b272eab0152f188670150228fc57959.zip) | 3.x.x | ✔️ | ❌ | -| 1.5.0 | [Poggit releases](https://poggit.pmmp.io/p/MultiWorld/1.5.0) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/1.5.0) | 3.0.0, 3.1.0 | ✔️ | ❌ | -| 1.5.0-beta2 | [GitHub](https://github.com/CzechPMDevs/MultiWorld/releases/download/1.5.0-beta1/MultiWorld_v1.5.0-beta1.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/1.5.0-beta1.zip) | 3.0.0, 3.1.0 | ✔️ | ✔️ | -| 1.5.0-beta1 | [GitHub](https://github.com/CzechPMDevs/MultiWorld/releases/download/1.5.0-beta1/MultiWorld_v1.5.0-beta1.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/1.5.0-beta1.zip) | 3.0.0, 3.1.0 | ❌ | ✔️ | -| 1.4.3 | [Poggit Releases](https://poggit.pmmp.io/r/34104/MultiWorld.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/ef6f73109c0438ab2a5c404ccdd288e2d73b5002.zip) | 3.0.0-ALPHA7 - 3.0.0 | ✔️ | ❌ | -| 1.4.2 | [Poggit Releases](https://poggit.pmmp.io/r/28962/MultiWorld.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/1.4.2.zip) | 3.0.0-ALPHA7 - 3.0.0-ALPHA12 | ✔️ | ❌ | -| 1.4.1 | [Poggit-CI Downloads](https://poggit.pmmp.io/r/27881/MultiWorld_dev-99.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/1.4.1.zip) | 3.0.0-ALPHA7 - 3.0.0-ALPHA12 | ✔️ | ❌ | -| 1.4.0 | [Poggit Releases](https://poggit.pmmp.io/r/25218/MultiWorld.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/be4083eae06adc249e3d4a8968ea0992d42f929c.zip) | 3.0.0-ALPHA7 - 3.0.0-ALPHA11 | ✔️ | ❌ | -| 1.3.2 | [Poggit-CI Downloads](https://poggit.pmmp.io/r/11536/MultiWorld_dev-86.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/5237db27b69fbf9a9aac66075fd81e9e804f180c.zip) | 3.0.0-ALPHA7 | ❌ | ❌ | -| 1.3.1 | [GitHub](https://github.com/CzechPMDevs/MultiWorld/releases/download/1.3.1/MultiWorld.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/1.3.1.zip) | 3.0.0-ALPHA7 | ✔️ | ❌ | -| 1.3.0 | [Poggit-CI Downloads](https://poggit.pmmp.io/r/10889/MultiWorld.phar) | [GitHub](https://github.com/CzechPMDevs/MultiWorld/archive/1.3.0.zip) | 3.0.0-ALPHA7 | ❌ | ❌ | - +| Downloads | API | Downloads | +|-------------------------------------------------------|-----------|---------------------------------------------------------------------------| +| Latest Stable Release (1.7.0) | 4.x | [Poggit](https://poggit.pmmp.io/r/177396/MultiWorld.phar) | +| Latest Beta Release (2.0.0-beta1) | 4.x | [Poggit](https://poggit.pmmp.io/r/188977/MultiWorld.phar) | +| Latest Dev Build (2.0.0 for 4.x / 'api/pm5' for 5.x) | 4.x / 5.x | [Poggit CI](https://poggit.pmmp.io/ci/CzechPMDevs/MultiWorld/MultiWorld/) |
-> **Download latest version [here](https://poggit.pmmp.io/r/34104/MultiWorld.phar)** - -> **All released versions [here](https://github.com/CzechPMDevs/MultiWorld/releases)** - -> **All development builds on [Poggit](https://poggit.pmmp.io/ci/CzechPMDevs/MultiWorld/MultiWorld)** - -> **Latest released version on [Poggit](https://poggit.pmmp.io/p/MultiWorld)** - > **Other plugins by CzechPMDevs [here](https://poggit.pmmp.io/plugins/by/CzechPMDevs)**
- ## 📁 Supported software: **This plugin works only on PocketMine-MP.** You can download [MultiWorld by Creeperface](https://github.com/Creeperface01/MultiWorld) for Nukkit or [MultiWorld by ferrybig](https://dev.bukkit.org/projects/multiworld-v-2-0) for Bukkit. **PMMP Spoons are NOT supported.** - ## 🔧 How to install MultiWorld? 1) [Download](https://poggit.pmmp.io/p/MultiWorld) latest stable released version from poggit 2) Move dowloaded file to your server **/plugins/** folder 3) Restart the server - ## 🌎 World management commands: - All MultiWorld commands starts with `/mw` (`/multiworld`) except for the `/gamerule` command that was added as an alias to change game rules from settings. @@ -106,50 +79,20 @@ | **/mw list** | **Displays list of all levels**

Alias: `/mw ls`
Usage: `/mw list` | | **/mw info** | **Displays level information**

Alias: `/mw i`
Usage: `/mw info`

This command can be used only in game | | **/mw delete** | **Remove level**

Aliases: `/mw del`, `/mw dl`, `/mw remove`, `/mw rm`
Usage: `/mw remove `

Default level can not be deleted | -| **/mw update** | **Change spawn, lobby or default level**

Aliases: `/mw ue`
Usage: `/mw update [x] [y] [z] [world]`

In game enough type `/mw update <...>` without `[x] [y] [z] [world]`, subcommand `lobby` can be used only in game | | **/mw load** | **Loads level**

Aliases: `/mw ld`
Usage: `/mw load ` | | **/mw unload** | **Unloads level**

Aliases: `/mw unld`
Usage: `/mw unload ` | -| **/mw gamerule** | **Manage with level game rules**

Aliases: `/gamerule`, `/mw gr`, `/mw gamer`, `/mw grule`
Usage: `/gamerule [bool]`

Level game rules can be changed in server settings, implemented game rules: `doDaylightCycle`, `doMobLoot`, `doTileDrops`, `keepInventory`, `naturalRegeneration`, `pvp`, `showcoordinates` and `tntexplodes` more informations can be found on [WorldGameRulesAPI documentation]() | | **/mw rename** | **Renames level**

Aliases: `/mw rnm`, `/mw re`
Usage: `/mw rename `

This command changes name of the folder and of nbt too. | | **/mw manage** | **Opens world form manager**

Aliases: `/mw mng`, `/mw mg`
Usage: `/mw manage`

The form manager just dispatches command as a player, so player needs also permission for the command. | - -## 📃 Permissions: - -- You can use permission `mw.cmd` for all commands -
- -**All MultiWorlds Permissions:** - -| Permission | Command | Operator | -|-----------------|----------------|----------| -| mw.cmd.help | `/mw help` | ✔️ | -| mw.cmd.create | `/mw create` | ✔️ | -| mw.cmd.teleport | `/mw teleport` | ✔️ | -| mw.cmd.list | `/mw list` | ✔️ | -| mw.cmd.info | `/mw info` | ✔️ | -| mw.cmd.delete | `/mw delete` | ✔️ | -| mw.cmd.update | `/mw update` | ✔️ | -| mw.cmd.load | `/mw load` | ✔️ | -| mw.cmd.unload | `/mw unload` | ✔️ | -| mw.cmd.gamerule | `/mw gamerule` | ✔️ | -| mw.cmd.rename | `/mw rename` | ✔️ | -| mw.cmd.manage | `/mw manage` | ✔️ | - - ## ⛰️ Generators ### Custom World Generator: - - - - - - - - - + + + + + ### Nether World Generator: @@ -162,81 +105,33 @@ ### SkyBlock Generator: - -## 🖊️ World Game Rules API - -- The World game rules API was added in MultiWorld v1.5.0, you can download stubs on [release page](), there are all WorldGameRulesAPI methods - -- **All implemented GameRules: `doDaylightCycle`, `doMobLoot`, `doTileDrops`, `keepInventory`, `naturalRegeneration`, `pvp`, `showcoordinates`and `tntexplodes`** -- **GameRules are stored in level.dat in CompoundTag `GameRules`, you can look at it using [NBTExplorer](https://www.minecraftforum.net/forums/mapping-and-modding-java-edition/minecraft-tools/1262665-nbtexplorer-nbt-editor-for-windows-and-mac) or [UniversalMinecraftEditor](https://www.universalminecrafteditor.com/).** - -**Examples:** - -```php -getServer()->getPluginManager()->registerEvents($this, $this); - $this->update(); - } - - public function onCommand(CommandSender $sender, Command $command, string $label, array $args): bool { - if($command->getName() !== "xyz") { - return false; - } - $bool = $this->enabled ? "off" : "on"; - $sender->sendMessage("§a> Coordinates turned $bool!"); - $this->enabled = !$this->enabled; - $this->update(); - return true; - } - - public function onLevelLoad(WorldLoadEvent $event): void { - MultiWorld::getGameRules($event->getWorld())->setRule(GameRule::SHOW_COORDINATES()->setValue(true)); - } - - private function update(): void { - foreach ($this->getServer()->getLevels() as $level) { - MultiWorld::getGameRules($event->getWorld())->setRule(GameRule::SHOW_COORDINATES()->setValue(true)); - } - } -} -``` - ## 🌐Add your language! - Do you want to help with the development of MultiWorld? Add your native language! 1) Open [lanuage resource file](https://github.com/CzechPMDevs/MultiWorld/tree/master/resources/languages) 2) Click create new file -3) Translate e.g. language from English file https://github.com/CzechPMDevs/MultiWorld/blob/master/resources/languages/en_US.yml +3) Translate e.g. language from English file https://github.com/CzechPMDevs/MultiWorld/blob/2.0.0/resources/languages/en_US.yml 4) Click Propose new file - ## 💰 Credits +**Icon** - Icon made by [Freepik](http://www.freepik.com/ "Freepik") from [www.flaticon.com](https://www.flaticon.com/ "Flaticon") is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/ "Creative Commons BY 3.0") + +**Vanilla (Overworld & Nether) generators** +- Generators translated from Glowstone project to PocketMine by @Muqsit + +**Translations** - Japanese translation by [fuyutsuki](https://github.com/fuyutsuki) - Russian translation by [SteinsSquad (themestl)](https://github.com/themestl) -- Indonesian translation by [WooWBoom](https://github.com/GitWoow) +- Indonesian translation by [WooWBoom](https://github.com/GitWoow) and [keenanyafiqy](https://github.com/keenanyafiqy) - German translation by [SchdowNVIDIA](https://github.com/SchdowNVIDIA) and [Tobikisss](https://github.com/Tobikisss) -- Chinese translation by [abc1460132901](https://github.com/abc1460132901) +- Chinese translation by [abc1460132901](https://github.com/abc1460132901) and [AZ1IDJC](https://github.com/Blackjack200) +- Vietnamese translation by [NhanAZ](https://github.com/NhanAZ) +- Spanish translation by [MrBlastyMSK](https://github.com/MrBlasyMSK) +- French translation by wrathx, [Hydros01](https://github.com/Hydros01) +- Thai translation by [KohakuChanX](https://github.com/Kuuuuuuuu) ## 💡 License