KnarCraft/PaidSigns
KnarCraft/PaidSigns
1
0
Fork 0
Code Issues 3 Pull Requests Projects Releases 10 Wiki Activity

Adds links in the README for easier navigation

Browse Source
This commit is contained in:
Kristian Knarvik 2022-04-28 13:39:18 +02:00
parent 0ce37de509
commit 7344af616b
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -10,23 +10,25 @@ see any payment messages. For testing, you'll need to un-set the `paidsigns.paym
As this plugin only listens to sign change events, there are some limitations: As this plugin only listens to sign change events, there are some limitations:
1. The plugin is not aware of whether the creation of a sign is successful. Setting the appropriate permission might help, but it's not guaranteed 1. The plugin is not aware of whether the creation of a sign is successful. Setting the appropriate permission might
help, but it's not guaranteed
2. It is assumed that any protection plugins run before this plugin checks a sign, but it's not guaranteed 2. It is assumed that any protection plugins run before this plugin checks a sign, but it's not guaranteed
3. Plugins changing the lines on signs when successful might create confusion and mismatches if changes happen before this plugin checks a sign 3. Plugins changing the lines on signs when successful might create confusion and mismatches if changes happen before
this plugin checks a sign
## Commands ## Commands
An argument marked by "<>" is required to execute the command. An argument marked by "[]" is optional. An argument marked by "<>" is required to execute the command. An argument marked by "[]" is optional. For empty
For empty arguments, such as no paid sign permission, you should use empty quotes (""). arguments, such as no paid sign permission, you should use empty quotes ("").
| Command | Arguments | Permission | Description | | Command | Arguments | Permission | Description |
| -------- | ------ | ------- | ------- | | -------- | ------ | ------- | ------- |
| /addpaidsign | \<name> \<cost> \[permission] \[ignore case] \[ignore color] \[match any condition] | paidsigns.manage | Used to add a new paid sign | | [/addpaidsign](#addpaidsign) | \<name> \<cost> \[permission] \[ignore case] \[ignore color] \[match any condition] | paidsigns.manage | Used to add a new paid sign |
| /addpaidsigncondition | \<name (of a paid sign)> \<line number> \<string to match> \[executeRegEx] \[ignoreCase] \[ignoreColor] | paidsigns.manage | Used to add a condition to a paid sign | | [/addpaidsigncondition](#addpaidsigncondition) | \<name (of a paid sign)> \<line number> \<string to match> \[executeRegEx] \[ignoreCase] \[ignoreColor] | paidsigns.manage | Used to add a condition to a paid sign |
| /listpaidsigns | \[name (of a paid sign)] \[line number] | paidsigns.manage | Used to list registered paid signs or a registered paid sign's conditions | | [/listpaidsigns](#listpaidsigns) | \[name (of a paid sign)] \[line number] | paidsigns.manage | Used to list registered paid signs or a registered paid sign's conditions |
| /editpaidsign | \<sign name> \<property>/\<line number> \[new value]/\<property> \[new value] | paidsigns.manage | Used to modify a registered paid sign or one of its conditions | | [/editpaidsign](#editpaidsign) | \<sign name> \<property>/\<line number> \[new value]/\<property> \[new value] | paidsigns.manage | Used to modify a registered paid sign or one of its conditions |
| /removepaidsigncondition | \<name (of a paid sign)> \<line number> | paidsigns.manage | Used to remove a condition from a registered paid sign | | [/removepaidsigncondition](#removepaidsigncondition) | \<name (of a paid sign)> \<line number> | paidsigns.manage | Used to remove a condition from a registered paid sign |
| /removepaidsign | \<name (of a paid sign)> | paidsigns.manage | Used to remove a registered paid sign | | [/removepaidsign](#removepaidsign) | \<name (of a paid sign)> | paidsigns.manage | Used to remove a registered paid sign |
| /reload | | paidsigns.reload | Used to reload the configuration file | | /reload | | paidsigns.reload | Used to reload the configuration file |
## Command explanation ## Command explanation
@ -140,5 +142,5 @@ Remember to change the language code to whichever you use for your custom langua
## License ## License
PaidSigns is licensed under the GNU Public License Version 3.0. This includes every source and resource file. See PaidSigns is licensed under the GNU Public License Version 3.0. This includes every source and resource file. See the
the HEADER file for a more detailed license description. HEADER file for a more detailed license description.