Waypoints | Waypoints.Signs | Waypoints.Plates

Use the links above to navigate amongst the modules of waypoints

Waypoints

A Minecraft Plugin Source code available at Sessional's GitHub Repository

Overview

Waypoints is a Minecraft mod to aid in the rapid traversing of large spread out worlds. It is designed to run easily with a large assortments of other plugins in the fact that each local command runs under the same command, for example ‘/waypoints go’ to execute a go command. This will prevent most and hopefully all command interferences with a wide array of plugins.

History

Development of waypoints started a little while after I began to play Minecraft. I found I had a tendency to wander far away from every other player, including my friends. While this was awesome at first, it eventually became tedious to meet up and share items with other people. The server I played on had access to a teleport command, but this command was long with requiring both names. I have nothing against the command, aside from the fact that 12 character names are annoying to type correctly often. I began building in my own little place and found that while it was great, for people to come visit me and see what I had built was a chore. This was mirrored in me visiting them to see what they had. Thus, waypoints was thought out.

Waypoints had to be designed to work with the “Permissions” mod, but to test it on my local environment it had to work with no permissions because I didn’t quite understand how to modify them. Simply, the plugin just confused me. I had to save it in a format that would be easy to fix because I didn’t quite know what bugs I was going to run into and there was a large chance I might have to hand fix the save files. Writing the code for the config file was largely clumped out of the tutorial on the wiki, and it worked, so why change it.

Philosophy

Waypoints is developed to meet players desires to make certain aspects of Minecraft that some may find undesirable such as trekking to and from friends houses in large, spread out, worlds less time consuming. As a mod developer and an avid gamer, I understand that what I want isn’t always what most people want and as such, suggestions are welcome, certain ones may not be added quickly, and I do apologize, but it becomes difficult to modify not well thought out code. As I write code I find myself rewriting it a lot because of poor planning. This comes largely from being self taught and impatient. Fixing and working around bugs is important to make sure that the user experience isn’t a nightmare which certainly may happen with updates. Testing is not always easy on a local server by a single user.

Player Commands

Player commands all begin with “/waypoints” or “/wps” to avoid conflicts with other plugins and because of this it can get tedious, but I feel the gain is more important than the possible negative interaction with commands.

Go

Supported in 2.0

Parameters in <> are required.
Parameters in [] are optional.
A parameter split with a | is an alias, either one can be used (but only one at a time)

Commands

/wps go <name>
/waypoints go <name>

Permissions

    waypoints.go

Examples

    /wps go home
        Teleports the player to the waypoint called home

Return

Supported in 2.0

Parameters in <> are required.
Parameters in [] are optional.
A parameter split with a | is an alias, either one can be used (but only one at a time)

Commands

/wps return
/waypoints return

Permissions

    waypoints.return

Examples

    /wps return
        Teleports the player to location before the last go command

Create

Supported in 2.0

Parameters in <> are required.
Parameters in [] are optional.
A parameter split with a | is an alias, either one can be used (but only one at a time)

Commands

/wps <add|create> <name> [world] [x] [y] [z]
/waypoints <add|create> <name> [world] [x] [y] [z]

Permissions

Any of the following permissions will allow the use of this command
    waypoints.add
    waypoints.create

Examples

    /wps add home
        Creates a waypoint called home at current location
    /wps create home homeWorld 0 0 0
        Creates a waypoint called home at x:0 y:0 z:0

Delete

Supported in 2.0

Parameters in <> are required.
Parameters in [] are optional.
A parameter split with a | is an alias, either one can be used (but only one at a time)

Commands

/wps <delete|remove> <name>
/waypoints <delete|remove> <name>

Permissions

Any of the following permissions will allow the use of this command
    waypoints.delete
    waypoints.remove

Examples

    /wps delete home
        Deletes the waypoint called home
    /wps remove home
        Deletes the waypoint called home

List

Supported in 2.0

Parameters in <> are required.
Parameters in [] are optional.
A parameter split with a | is an alias, either one can be used (but only one at a time)

Commands

/wps list [world <world name> |page <#>]
/waypoints list [world <world name> |page <#>]

Permissions

    waypoints.list

Examples

    /wps list
        Lists all waypoints that exist
    /wps list world homeworld
        Lists all waypoints that exist on the world homeworld
    /wps list page 2
        Lists waypoints in a page format starting on page two

Update

Supported in 2.4

Parameters in <> are required.
Parameters in [] are optional.
A parameter split with a | is an alias, either one can be used (but only one at a time)

Commands

/wps <update|set> <waypointName> <cost>
/wps <update|set> <waypointName> <worldName> <x> <y> <z>
/wps <update|set> <waypointName> <worldName> <x> <y> <z> <cost>

Permissions

    waypoints.set
    waypoints.update

Examples

    /wps set home 2
        Sets the cost of teleporting home to be 2 levels by default

Console Commands

Create

Supported in 2.1

Waypoints^^1^^ create(add)^^2^^ <waypoint name>^^3^^ <world> <x> <y> <z>
Usage: waypoints create aaa
Notes: Will create a waypoint at the given location. Waypoints are saved upon creation of a new one.

Delete

Supported in 2.1

waypoints delete(remove) < waypoint name>
Usage: waypoints delete aaa
Notes: Deletes the waypoint aaa from the list of waypoints. Waypoints is saved immediately upon deletion.

List

Supported in 2.1

waypoints list [page] [#]
waypoints list [world] [world name]
Usage: waypoints list
waypoints list page 1
waypoints list world world
Notes: Will list the waypoints you specified. If you use page it will list waypoints (9*page number - 1) through (9*page number).if you use world it will list all waypoints on the given world.