1.1.0

README.md

@@ -1,2 +1,98 @@
-# MagicTelePortal-
-Very EASY to use portal (aka Me Too Portal)
+<img src="https://raw.githubusercontent.com/Muirfield/MagicTelePortal/master/media/portal-icon.jpg" style="width:64px;height:64px" width="64" height="64"/>
+# MeTooPortal
+
+* Summary: Easy to use Portal plugin
+* Dependency Plugins: N/A
+* PocketMine-MP version: 1.4 - API 1.10.0
+* DependencyPlugins: -
+* OptionalPlugins: FastTransfer
+* Categories: Fun
+* Plugin Access: Blocks, Commands
+
+Overview
+--------
+
+Simple plugin to make creation of portals easy.
+
+Documentation
+-------------
+
+### Commands
+
+You use one command:
+
+    [CODE]
+    /mtp [world|server:port] [x y z]
+    [/CODE]
+
+Examples:
+
+* Portal to another world:
+  * /mtp minigames
+* Portal to another location in the same world:
+  * /mtp 128 70 128
+* Portal to an specific location in another world:
+  * /mtp minigames 392 70 939
+* FastTransfer portal
+  * /mtp example.com:19132
+
+### Configuration
+
+~~~~
+[CODE]
+# How far can the portals be created
+max-dist: 8
+# Block-id of the border block (defaults to Nether Bricks)
+border: 112
+# Block-id of the center block (defaults to Still Water)
+center: 9
+# Block-id of the corners (defaults to Nether Brick Stairs)
+corner: 114
+# Broadcast teleports (UNIMPLEMENTED)
+broadcast-tp: true
+[/CODE]
+~~~~
+
+
+### Permission Nodes:
+
+* metooportal.cmd.mtp: Permission to create portals
+
+FAQ
+---
+
+* Q: How do I prevent people from breaking my portal?
+* A: Use an anti-grief plugin.
+
+Todo
+----
+
+* Add broadcast-tp option.
+
+Changes
+-------
+
+* 1.1.0 : Next release
+  * Support for FastTransfer
+  * Some configuration options
+* 1.0.0 : First submission
+
+Copyright
+---------
+
+    MeTooPortal
+    Copyright (C) 2015 Alejandro Liu
+    All Rights Reserved.
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

plugin.yml

@@ -0,0 +1,19 @@
+main: aliuly\mtp\Main
+api: 1.10.0
+load: POSTWORLD
+
+name: MeTooPortal
+description: Yet another portal plugin
+version: 1.1.0
+author: aliuly
+
+commands:
+    mtp:
+        description: Create a portal
+        usage: "/mtp [world|addr:port] [x y z]"
+        permission: metooportal.cmd.mtp
+
+permissions:
+    metooportal.cmd.mtp:
+        default: op
+        description: "Allow to create portal"