From 22a5ec06e8f19b65217c60dae47b6c1ca3bc3d03 Mon Sep 17 00:00:00 2001 From: Bryson Steck Date: Sun, 18 Jul 2021 03:19:30 +0000 Subject: updated doc --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bdd82b1..4895176 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,26 @@ 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 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. +**This plugin is currently in a beta state.** This means that the plugin's functionality may not be stable or as intended. Opening issues here on GitHub or contacting me on Discord is heavily recommended if a bug occurs. -# Commands +## Compatibility + +Tested Versions: 1.16 +Native Version: 1.16 + +## Commands * `/about` - * Displays information about the plugin, manually checks for updates. + * Displays information about the plugin, including links to GitHub and Spigot, and also warns the player if the plugin is outdated. * `/resurrect PLAYER` - * An operator-only command. Manually resurrects a player if they are dead. -* `/howlong [PLAYER]` *(Currently not implemented)* + * Manually resurrects a player if they are dead. + * Operator-only command. +* `/howlong [PLAYER]` * Shows the player how long they (or the specified player) have until they are resurrected. + * This command requires a player to be specified when ran from the console. -# Files +## Files -This program automatically generates a [`playerData.resurrection`](data/playerData.resurrection) file in the same directory as the Spigot server jar. This file contains data for each player relevant for the plugin and 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 in it's place on enabling. +This program automatically generates a [`playerData.resurrection`](data/playerData.resurrection) file in the same directory as the plugin Jar file. This file contains data for each player relevant for the plugin and is important to make sure that the resurrection timing stays in effect after a server shutdown. If this file is deleted, moved or doesn't exist, a blank file will be created in it's place upon enabling. -***Please be aware that removing this file after it's creation may cause the plugin to behave differently,*** such as holding a player in a dead state for all of time and eternity. +***Please be aware that modifying, moving or removing this file after it's creation or while the plugin is enabled may cause the plugin to behave erratically,*** such as holding a player in a dead state for all of time and eternity. If you choose to do so, do it at your own risk. -- cgit v1.2.3