summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fc6ffc3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# PvP Areas
+
+Sets an area for PvP control.
+
+Use safemode to make areas be safe zones; otherwise they are killzones by default.
+
+## Config
+
+* `pvp_areas.safemode`
+ * safemode = true --> PvP Control areas are safe zones
+ * default is `false`, making PvP Control areas kill zones
+
+* `pvp_areas.label`
+ * if ShadowNinja's `areas` mod is also present with HUD registration feature, this label will be displayed anywhere
+ a PvP Control area has been set.
+
+## Commands
+
+* `/pvp_areas`
+ * without arguments lists areas, if any.
+* `/pvp_areas pos1`
+ * selects the players current position as the area minimum.
+* `/pvp_areas pos2`
+ * selects the players current position as the area maximum.
+* `/pvp_areas set`
+ * adds an entry using pos1 and pos2 values.
+* `/pvp_areas remove n`
+ * removes an area entry.