The original warp plugin for PocketMine-MP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
meta
resources
src/falkirks/simplewarp
.gitignore
.poggit.yml
ISSUE_TEMPLATE.md
LICENSE
README.md
entry.php
plugin.yml

README.md

SimpleWarp

Poggit Average time to resolve an issue Total downloads

SimpleWarp is the original warp plugin for PocketMine-MP. It allows players to move from point A to B with ease. At the core of SimpleWarp is simplicity and extensibility. Although very easy on the end user, it exposes a powerful backend for developers to hack around with.

SimpleWarp 2.0 is not compatible with older SimpleWarp and PocketMine versions.

Commands

Command Usage Description
/warp /warp <name> [player] Warps you or another player to a specified warp.
/addwarp /addwarp <name> [<ip> <port>|<x> <y> <z> <level>|<player>] Creates a new warp at a set location.
/delwarp /delwarp <name> Deletes specified warp.
/listwarps /listwarps Prints out list of warps.
/openwarp /openwarp <name> Allows any player to access specified warp.
/closewarp /closewarp <name> Restricts specfied so that only players with correct permission node can use it
/warpreport /warpreport [title] Run from console to generate a new GitHub issue for SimpleWarp

Permissions

 simplewarp:
  default: op
  children:
   simplewarp.command:
    default: op
    children:
     simplewarp.command.list:
      default: true
      children:
       simplewarp.command.list.xyz:
        default: op
       simplewarp.command.list.visual:
        default: op
     simplewarp.command.addwarp:
      default: op
     simplewarp.command.delwarp:
      default: op
     simplewarp.command.warp:
      default: true
      children:
        simplewarp.command.warp.other:
         default: op
     simplewarp.command.openwarp:
      default: op
     simplewarp.command.closewarp:
       default: op
     simplewarp.command.closewarp:
       default: op
   simplewarp.essentials.notice:
    default: op
    description: Recieve messages when their is warp conflict in Essentials
   simplewarp.warp:
    default: op
    description: Allows usage of all warps

API

What good is a plugin without an API? SimpleWarp has an API which is used by it's own core components.

Getting access

Make sure to add the following to your plugin.yml

depend: ["SimpleWarp"]

Note: If you use softdepend you will need to check if SimpleWarp is installed.

Now you can a copy of the API in your onEnable method

$api = SimpleWarpAPI::getInstance($this); // This only works inside a PluginBase

If you want to get the instance outside your main class, you can do

$api = $server->getPluginManager()->getPlugin("SimpleWarp")->getApi(); // $server is an instance of \pocketmine\Server