Adds a small FAQ to the README

This commit is contained in:
Kristian Knarvik 2022-07-14 23:33:53 +02:00
parent 427169c51a
commit 8b53182006

View File

@ -16,6 +16,34 @@ As this plugin only listens to sign change events, there are some limitations:
3. Plugins changing the lines on signs when successful might create confusion and mismatches if changes happen before
this plugin checks a sign
## FAQ
### A player placed down a sign, but some plugin broke it afterwards. What do I do?
There are three ways this can be solved:
1. Make the player (or anyone else) place an empty sign in the same location and break it again. The player should be
refunded as long as refunds are enabled.
2. Reload PaidSigns. The player should be refunded.
3. Restart the server. The player should be refunded Never place a new paid sign in this situation, as the old sign will
be overwritten, and the ability to refund the player automatically will be lost.
### Players have to pay for signs, even if the plugin sign isn't created
This is a known limitation of this plugin. As long as this plugin is agnostic to the plugin signs it's used for, it
cannot really know if a plugin sign has been created. The best you can do is finding the permission required for the
plugin sign and specifying it when creating the paid sign. It can be assumed that the player is able to create the
plugin sign, if the player has the correct permission.
### How can this plugin be used to enhance a server?
This plugin is known to be helpful with two tasks:
1. Allow normal players to create plugin signs, such as CraftBook's elevator signs, but at a cost. This can be done by
simply specifying the exact text required for the plugin sign in the paid sign conditions.
2. Add a swearing jar/swearing filter to the server. This can be done with a paid sign matching ANY condition, where the
list of swear words is given as a regEx. The same regEx should be added for each of the four sign lines.
## Commands
An argument marked by "<>" is required to execute the command. An argument marked by "[]" is optional. For empty