2.0.0

Muirfield · Jul 2, 2016 · e475423 · e475423
1 parent 4e552e8
commit e475423
Show file tree

Hide file tree

Showing 18 changed files with 1,582 additions and 699 deletions.
diff --git a/README.md b/README.md
@@ -1,81 +1,131 @@
-ManyWorlds
-==========
+<img src="https://raw.githubusercontent.com/alejandroliu/pocketmine-plugins/master/Media/ManyWorlds-icon.png" style="width:64px;height:64px" width="64" height="64"/>
 
-* Summary: Basic commands for MultiWorld functionality
+# ManyWorlds
+
+* Summary: Full Suite for MultiWorld functionality
 * Dependency Plugins: n/a
 * PocketMine-MP version: 1.4 - API 1.10.0
 * OptionalPlugins: n/a
 * Categories: World Editing and Management, Teleportation
 * Plugin Access: Commands, Manages Worlds
 * WebSite: [github](https://github.com/alejandroliu/pocketmine-plugins/tree/master/ManyWorlds)
 
-Overview
----------
+## Overview
+
+**DO NOT POST QUESTION/BUG-REPORTS/REQUESTS IN THE REVIEWS**
 
-A very basic plugin implementing MultiWorld functionality
+It is difficult to carry a conversation in the reviews.  If you have a
+question/bug-report/request please use the
+[Thread](http://forums.pocketmine.net/threads/manyworlds.7277/) for
+that.  You are more likely to get a response and help that way.
+
+Please go to
+[github](https://github.com/alejandroliu/pocketmine-plugins/tree/master/ManyWorlds)
+for the most up-to-date documentation.
+
+Full feature set of commands to manage multiple worlds.
 
 Features:
 
 * teleport
 * load/unload
 * create
 * world info
+* edit level.dat
 
-Basic Usage:
+### Basic Usage
 
-* /mw tp *level* [player]
-* /mw create *level* [seed [flat|normal [preset]]]
-* /mw load *level*
-* /mw unload [-f] *level*
-* /mw ls [level]
-* /mw lvdat [level] [attr=value]
-* /mw fixname [level]
+* create : Creates a new world
+* default : Sets the default world
+* fixname : fixes name mismatches
+* generators : List available world generators
+* load : Loads a world
+* ls : Provide world information
+* lvdat : Show/Modify level.dat variables
+* tp : Teleport to another world
+* unload : Unloads world
 
-Documentation
--------------
+## Documentation
 
 This plugin is a world manager that allows you to generate and load
 worlds as well as teleport between worlds.
 
-The teleport itself has a number of workarounds to deal with
-Client-Server glitches.  Essentially, it works for me.
+### Command Reference
+
+The following commands are available:
 
-### Commands:
+* /mw **create** _&lt;world&gt;_ _[seed]_ _[generator]_ _[preset]_  
+  Creates a new world  
 
-Teleporting:
+ Creates a world named _world_.  You can optionally specify a _seed_
+ as number, the generator (_flat_ or _normal_) and a _preset_ string.
 
-* mw tp *level* [player]  
-  Teleports `player` to `level`.  If no `player` is specified, it
-  teleports the current user.
-* mw ls [level]  
-  If `level` is not specified, it will list all available worlds.  If
-  `level` is specified, it will provide details on that `level`.
+* /mw **default** _&lt;world&gt;_  
+  Sets the default world  
 
-World management:
+  Teleports you to another world.  If _player_ is specified, that
+  player will be teleported.
+* /mw **fixname** _&lt;world&gt;_  
+  fixes name mismatches  
 
-* mw create *level* [seed] [flat|normal] [preset]  
-  Creates a world named `level`.  You can optionally specify a `seed`
-  as number, the generator (`flat` or `normal`) and a `preset` string.
-* mw load *level*  
-  Loads `level` directly.  If you use `--all` for the `level` name, it
-  will load all worlds.
-* mw unload *level*  
-  Unloads `level`.
+  Fixes a world's **level.dat** file so that the name matches the
+  folder name.
+* /mw **generators**  
+  List available world generators  
 
-Format hacking:
+  List registered world generators.
+* /mw **load** _&lt;world&gt;_  
+  Loads a world  
 
-* mw fixname *level*  
-  Fixes `level.dat` files so that the name matches the folder name.
-* mw lvdat *attr=value* *attr=value*  
-  Change directly some `level.dat` values/attributes.  Supported
+  Loads _world_ directly.  Use _--all_ to load **all** worlds.
+
+* /mw **ls** _[world]_  
+  Provide world information  
+
+  If _world_ is not specified, it will list available worlds.
+  Otherwise, details for _world_ will be provided.
+* /mw **lvdat** _&lt;world&gt;_ _[attr=value]_  
+  Show/Modify level.dat variables  
+
+  Change directly some **level.dat** values/attributes.  Supported
   attributes:
-  * spawn=x,y,z : Sets spawn point
-  * seed=randomseed : seed used for terrain generation
-  * name=string : Level name
-  * generator=flat|normal : Terrain generator
-  * preset=string : Presets string.
+  - spawn=x,y,z : Sets spawn point
+  - seed=randomseed : seed used for terrain generation
+  - name=string : Level name
+  - generator=flat|normal : Terrain generator
+  - preset=string : Presets string.
+
+* /mw **tp** _[player]_ _&lt;world&gt;_  
+  Teleport to another world  
+
+  Teleports you to another world.  If _player_ is specified, that
+  player will be teleported.
+* /mw **unload** _[-f]_  _&lt;world&gt;_  
+  Unloads world  
+
+  Unloads _world_.  Use _-f_ to force unloads.
 
-### Examples:
+
+### Permission Nodes
+
+* mw.cmds : Allow all the ManyWorlds functionality
+* mw.cmd.tp : Allows users to travel to other worlds
+  (Defaults to Op)
+* mw.cmd.tp.others : Allows users to make others travel to other worlds
+  (Defaults to Op)
+* mw.cmd.ls : Allows users to list worlds
+  (Defaults to Op)
+* mw.cmd.world.create : Allows users to create worlds
+  (Defaults to Op)
+* mw.cmd.world.load : Allows users to load worlds
+  (Defaults to Op)
+* mw.cmd.lvdat : Manipulate level.dat
+  (Defaults to Op)
+* mw.cmd.default : Changes default world
+  (Defaults to Op)
+
+
+## Examples
 
 Create a new normal world:
 
@@ -91,39 +141,26 @@ Teleport to this newly created world:
 
 Teleport a player to another world:
 
-    /mw tp flatland joshua
-
-### Configuration
-
-In the plugin's config.yml file you can have:
+    /mw tp joshua flatland
 
-	settings:
-	  broadcast-tp: true
+## Translations
 
-* `broadcast-tp`: Controls broadcast message that somebody teleported.
+This plugin will follow the server language configuration.  The
+languages currently available are:
 
-### API
+* English
+* Spanish
 
-To use the teleport provided by ManyWorlds, you can use this code:
+You can provide your own message file by creating a file called
+`messages.ini` in the pluginc config directory.  Check
+[github](https://github.com/alejandroliu/pocketmine-plugins/tree/master/ManyWorlds/resources/messages/)
+for sample files.
 
-	if (($mw = $this->getServer()->getPluginManager()->getPlugin("ManyWorlds")) != null) {
-	    $mw->mwtp($player,$pos);
-	} else {
-	    $player->teleport($pos);
-	}
+## Issues
 
-You need to do this in order for WorldProtect limits to work.
+* New world names can not contain spaces.
 
-### Permission Nodes:
-
-* mw.cmd.tp - Allows users to travel to other worlds
-* mw.cmd.tp.others - Allows users to make others travel to other worlds
-* mw.cmd.world.create - Allows users to create worlds
-* mw.cmd.world.load - Allows users to load worlds
-* mw.cmd.lvdat - Manipulate level data
-
-FAQ
----
+## FAQ
 
 * Q: How do I create a `FLAT` world?
 * A: You must be using PocketMine-MP v1.4.1.  Set the `generator` to
@@ -133,14 +170,15 @@ FAQ
   In the `pocketmine.yml` file there is a `worlds` section where you
   can define which worlds to load on start-up.
 
-Issues
-------
-
-* World names can not contain spaces.
-
-Changes
--------
+# Changes
 
+* 2.0.0: Modularization
+  * Re-written for modularity
+  * teleport manager API deprecated
+  * Added `default` command to change the default level.
+  * New `genlist` for list of generators
+  * tp command changed to more natural English.
+  * Translation: Spanish
 * 1.3.4: Updates for PM1.5
   * Removed CallbackTask deprecation warnings
 * 1.3.3: Updates for PM1.5
@@ -199,3 +237,4 @@ Copyright
 
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
diff --git a/plugin.yml b/plugin.yml
@@ -4,34 +4,37 @@ load: POSTWORLD
 
 name: ManyWorlds
 description: Manage Multiple Worlds
-version: 1.3.4
+version: 2.0.0
 author: aliuly
 
 commands:
-    mw:
-        description: Manage worlds
-        usage: "/mw <help|sub-cmd> [options]"
-        permission: mw.cmds
+  mw:
+    description: Manage worlds
+    usage: "/mw <help|sub-cmd> [options]"
+    permission: mw.cmds
 
 permissions:
-    mw.cmds:
-        default: true
-        description: "Allow all the ManyWorlds functionality"
-    mw.cmd.tp:
-        default: op
-        description: "Allows users to travel to other worlds"
-    mw.cmd.tp.others:
-        default: op
-        description: "Allows users to make others travel to other worlds"
-    mw.cmd.ls:
-        default: op
-        description: "Allows users to list worlds"
-    mw.cmd.world.create:
-        default: op
-        description: "Allows users to create worlds"
-    mw.cmd.world.load:
-        default: op
-        description: "Allows users to load worlds"
-    mw.cmd.lvdat:
-        default: op
-        description: "Manipulate level.dat"
+  mw.cmds:
+    default: true
+    description: "Allow all the ManyWorlds functionality"
+  mw.cmd.tp:
+    default: op
+    description: "Allows users to travel to other worlds"
+  mw.cmd.tp.others:
+    default: op
+    description: "Allows users to make others travel to other worlds"
+  mw.cmd.ls:
+    default: op
+    description: "Allows users to list worlds"
+  mw.cmd.world.create:
+    default: op
+    description: "Allows users to create worlds"
+  mw.cmd.world.load:
+    default: op
+    description: "Allows users to load worlds"
+  mw.cmd.lvdat:
+    default: op
+    description: "Manipulate level.dat"
+  mw.cmd.default:
+    default: op
+    description: "Changes default world"