summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..53ebb74
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,16 @@
+=== New Simple Waypoints ===
+
+This plugin allows players on a Spigot server to save waypoints and teleport
+back to them, as well as teleport to other players if those players allow it.
+
+To build the plugin (assuming you have Maven installed), just run "mvn verify".
+The plugin jar will be placed in the "target" directory. To install the plugin,
+just copy that jar file into the "plugins" directory of the server. The first
+time that the server starts after that, a SQLite database will be created.
+
+See the file "src/main/resources/plugin.yml" for a list of commands. In order
+to use the /wtp command, a player must have the nswp.waypoints permission. In
+order to use the /wtpallow and /wtpa commands, a player must have the nswp.tpa
+permission. You can use a plugin like LuckPerms to grant these permissions.
+
+Enjoy!