From 8e759b87aac4d32d7d2959629d3cb7899b29f86e Mon Sep 17 00:00:00 2001
From: zontreck <zontreck@noreply>
Date: Sat, 18 Jan 2025 16:47:58 -0700
Subject: [PATCH] Add warps

---
 warps.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 warps.md

diff --git a/warps.md b/warps.md
new file mode 100644
index 0000000..c40e6c1
--- /dev/null
+++ b/warps.md
@@ -0,0 +1,33 @@
+### Warps
+
+This page details the warps system. By default, a warp can be accessed by a standard user, but only admins can manage warps.
+
+# Config
+
+The following config values are available, and the defaults are listed below.
+
+```json
+{
+    "onlyAdminsCreateWarps": true
+}
+```
+
+**NOTE**: While the flag says "create", this affects both Delete and Create at this time.
+
+**NOTE**: All commands except `/warps` take a optional name parameter, which defaults to `default`.
+
+# /setwarp
+
+Sets or updates a global server warp.
+
+# /delwarp
+
+Deletes a warp, if it exists.
+
+# /warp
+
+Can be used by all players by default, and teleports you immediately to the specified server warp
+
+# /warps
+
+Lists all available server warps, and the total number of warps in existence.
\ No newline at end of file