Introducing BLWarps, a Sponge plugin for easily creating Warps - locations that players can teleport to!
You can download the latest release here.
Commands
Note: In the following commands, square brackets ([]) indicate optional arguments, and angle brackets (<>) indicate required arguments.
Warp Commands
/warp set [-g] <warp name> [x] [y] [z]- Create a new warp with name
warp nameand optional coordinates (x,y,z). Add the-gflag to make it a global warp. /warp <warp id>- Warp to the warp with ID
warp id. /warp delete <warp id>- Delete the warp with ID
warp id. /warp list- List all of the warps for which one has permission to use
/warp info <warp id>- Displays information about the specified warp
Warp Region Commands
/warp region set [-g] <region name> <warp id> <corner1> <corner1>- Create a new warp region with name
region name, linked warp with IDwarp idand cornerscorner1andcorner2 /warp region delete <region id>- Delete the warp region with ID
region id. /warp region list- List all of the regions for which the player has permission to use their linked warps
/warp region info <region id>- Displays information about the warp region with ID
region id
Warp Regions
A warp region is an area in a world in which a player will be warped to any arbitrary warp if they enter the region. Currently, there is no support for WorldGuard regions, but it is a planned feature. See the Warp Region Commands section above for instructions.
Warp Signs
Warp signs can be created for any previously established warp. To do this, simply place a sign anywhere in the world, and write the following text on each line:
- [Warp]
<warp name>- Doesn’t matter
- Doesn’t matter
If you have correctly placed the sign, the text on the sign will be colored and reformatted. To use the sign to warp, simply right click on the sign.
Permissions
Permission to use a warp is given on a per-warp basis, as shown below:
-
blwarps.warp.<warp name>
Permissions for various commands are as follows: -
blwarps.warp.create: Permission to create a private warp -
blwarps.warp.create-global: Permission to create a global warp -
blwarps.warp.delete-global: Permission to delete a global warp -
blwarps.region.create: Permission to create a private warp region -
blwarps.region.create-global: Permission to create a global warp region -
blwarps.region.delete-global: Permission to delete a global warp region
You can also configure the number of private warps a player can have with thewarpCreationLimitoption. For example, see the following PermissionsEx configuration:
"group": {
"test": [
{
"options": {
"warpCreationLimit": "2"
}
}
]
}
Storage
There are 3 different options for warp storage:
- Flat File Storage
- SQL Storage
- REST API Storage
A more complete description of the plugin can be found at its GitHub repo.
The plugin seems to be stable, but there are probably some bugs. If you find any, or would like to request features, please leave an issue on GitHub (preferred).
