aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBryson Steck <steck.bryson@gmail.com>2021-06-20 22:17:41 -0600
committerBryson Steck <steck.bryson@gmail.com>2021-06-20 22:17:41 -0600
commit3305708003b9bdaa409d0be384b9ea057891f308 (patch)
tree273ef781ddf71cd3820b99b6a4b181f1da239c57 /README.md
parent65f2eb0d1526e3864f05bbd811b5fbea7b197807 (diff)
downloadresurrection-3305708003b9bdaa409d0be384b9ea057891f308.tar
resurrection-3305708003b9bdaa409d0be384b9ea057891f308.tar.gz
resurrection-3305708003b9bdaa409d0be384b9ea057891f308.tar.bz2
edited readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 3076a5b..070546c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
# Resurrection
-A Spigot Minecraft plugin that makes players wait a full day before respawning.
+Resurrection is a Spigot Minecraft Server plugin that forces players to wait a full 24 hours before rejoining the world. This allows for tactical planning for games such as faction survival and others as it can severely penalize an entire team if care is not taken.
+
+This plugin currently runs on 1.16.5 servers and worlds with 1.17.\* support expected in the future.
+
+# Commands
+
+* `/about`
+ * Displays information about the plugin, manually checks for updates.
+* `/resurrect PLAYER`
+ * An operator-only command. Manually resurrects a player if they are dead.
+* `/howlong [PLAYER]` *(Currently not implemented)*
+ * Shows the player how long they (or the specified player) have until they are resurrected.
+
+# Files
+
+This program automatically generates a 'player data' file in the same directory as the server jar. This file is important to make sure that the resurrection timing stays in effect after a server shutdown. If this file is deleted, moved or non-existent, a blank file will be created.
+
+**Please be aware that removing this file may cause the plugin to behave differently,** such as holding a player in a dead state for all of time.