aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1afc07a20c5cf99ef305e4f71b1ce70f1eeec60a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Resurrection

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 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 filling out this [Google Form](https://docs.google.com/forms/d/e/1FAIpQLSd8RWwcGTy7rtqPl4J7h1UWE-H0KKp1Usr1NOFdgZkVLmLUtw/viewform?usp=sf_link) is heavily recommended if a bug occurs. 

## Compatibility 

Tested Versions: 1.13, 1.14, 1.15, 1.16, 1.17
Native Version: 1.16

## Commands

* `/about`
    * Displays information about the plugin, including links to GitHub and Spigot, and also warns the player if the plugin is outdated. 
* `/bug`
    * Displays contact information in case a bug occurs, such as links to the GitHub issues page and the Google Form.
* `/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. 
* `/resurrect PLAYER`
    * Manually resurrects a player if they are dead.
    * Operator-only command. 

## Files

This program automatically generates a [`playerData.resurrection`](data/playerData.resurrection) and a [`settings.resurrection`](data/settings.resurrection) file in the same directory as the plugin Jar file. These files contain data for each player relevant for the plugin and contains settings for the plugin. It is important for these files to be present (and **UNMODIFIED** in the case of the playerData file) to make sure that the resurrection timing stays in effect after a server shutdown and for the proper functioning of the plugin in general. If these files are deleted, moved or do not exist, blank/default files will be created in it's place upon enabling.

***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.