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

Fixes README table formatting

Browse Source
This commit is contained in:
Kristian Knarvik 2022-11-13 22:42:52 +00:00
parent dd47ce06eb
commit 1154d7ddaf
1 changed files with 56 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -59,7 +59,7 @@ An argument marked by "<>" is required to execute the command. An argument marke
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 |
| -------- | ------ | ------- | ------- | |------------------------------------------------------|---------------------------------------------------------------------------------------------------------|------------------|---------------------------------------------------------------------------|
| /paidsigns | | paidsigns.info | Used to display in-game information about all other commands | | /paidsigns | | paidsigns.info | Used to display in-game information about all other commands |
| [/addpaidsign](#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](#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 |
@ -78,13 +78,13 @@ This command adds a new paid sign that does nothing until a condition is added.
`/addpaidsign <name> <cost> [permission] [ignore case] [ignore color] [match any condition]` `/addpaidsign <name> <cost> [permission] [ignore case] [ignore color] [match any condition]`
| Argument | Usage | | Argument | Usage |
| ----- | ----- | |---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|name | A recognizable name only used to differentiate between registered paid signs | | name | A recognizable name only used to differentiate between registered paid signs |
|cost | The cost a player needs to pay to create any sign matching the paid sign | | cost | The cost a player needs to pay to create any sign matching the paid sign |
|permission | If the paid sign is used to represent a plugin sign, the permission should be the permission necessary for creating the plugin sign. This is used to decide if the plugin sign was created, or if the player was denied. | | permission | If the paid sign is used to represent a plugin sign, the permission should be the permission necessary for creating the plugin sign. This is used to decide if the plugin sign was created, or if the player was denied. |
|ignore case | Whether any conditions of the paid sign should ignore case by default, when matching against text (default uses the config file value). | | ignore case | Whether any conditions of the paid sign should ignore case by default, when matching against text (default uses the config file value). |
|ignore color | Whether any condition of the paid sign should ignore color by default, when matching against text (default uses the config file value). | | ignore color | Whether any condition of the paid sign should ignore color by default, when matching against text (default uses the config file value). |
|match any condition | Whether to trigger a paid sign match if a single one of the sign's conditions is true. This is mainly useful if several lines may contain the match string, or if trying to match a word. | | match any condition | Whether to trigger a paid sign match if a single one of the sign's conditions is true. This is mainly useful if several lines may contain the match string, or if trying to match a word. |
### /addpaidsigncondition ### /addpaidsigncondition
@ -94,7 +94,7 @@ a paid sign condition to a line that already has one will replace the previous c
`/addpaidsigncondition <name (of a paid sign)> <line number> <string to match> [executeRegEx] [ignoreCase] [ignoreColor]` `/addpaidsigncondition <name (of a paid sign)> <line number> <string to match> [executeRegEx] [ignoreCase] [ignoreColor]`
| Argument | Usage | | Argument | Usage |
| ----- | ----- | |-----------------|---------------------------------------------------------------------------------------------------------------------|
| name | The name of the paid sign to add the condition to | | name | The name of the paid sign to add the condition to |
| line number | The line on the sign (1-4) to search for any matches | | line number | The line on the sign (1-4) to search for any matches |
| string to match | The string or regular expression to look for on a sign | | string to match | The string or regular expression to look for on a sign |
@ -109,7 +109,7 @@ This lists registered paid signs and paid sign conditions. No arguments will pri
`/listpaidsigns [page number]/[name (of a paid sign)] [line number]` `/listpaidsigns [page number]/[name (of a paid sign)] [line number]`
| Argument | Usage | | Argument | Usage |
| ----- | ----- | |-------------|---------------------------------------------------------------------------------|
| page number | Paid signs are listed 7 at a time, so the page number is used to see the next 7 | | page number | Paid signs are listed 7 at a time, so the page number is used to see the next 7 |
| name | The name of the paid sign to see information about | | name | The name of the paid sign to see information about |
| line number | The line number of the condition to see information about | | line number | The line number of the condition to see information about |
@ -121,7 +121,7 @@ This command changes a property of a paid sign or a paid sign condition
`/editpaidsign <sign name> <property>/<line number> [new value]/<property> [new value]` `/editpaidsign <sign name> <property>/<line number> [new value]/<property> [new value]`
| Argument | Usage | | Argument | Usage |
| ----- | ----- | |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name | The name of the paid sign to edit | | name | The name of the paid sign to edit |
| property / line number | The property to edit for the sign (name, cost, permission, ignoreCase, ignoreColor, matchAnyCondition), or the line of the condition to edit | | property / line number | The property to edit for the sign (name, cost, permission, ignoreCase, ignoreColor, matchAnyCondition), or the line of the condition to edit |
| new value / property | The new property value if a property was specified in the second argument, or a condition property (stringToMatch, executeRegEx, ignoreCase, ignoreColor) if a line number was specified in the second argument | | new value / property | The new property value if a property was specified in the second argument, or a condition property (stringToMatch, executeRegEx, ignoreCase, ignoreColor) if a line number was specified in the second argument |
@ -134,7 +134,7 @@ Removes a paid sign condition from a sign
`/removepaidsigncondition <name (of a paid sign)> <line number>` `/removepaidsigncondition <name (of a paid sign)> <line number>`
| Argument | Usage | | Argument | Usage |
| ----- | ----- | |-------------|--------------------------------------------------------|
| name | The name of the paid sign to remove the condition from | | name | The name of the paid sign to remove the condition from |
| line number | The line the condition is associated with | | line number | The line the condition is associated with |
@ -145,13 +145,13 @@ Removes a registered paid sign
`/removepaidsign <name (of a paid sign)>` `/removepaidsign <name (of a paid sign)>`
| Argument | Usage | | Argument | Usage |
| ----- | ----- | |----------|-------------------------------------|
| name | The name of the paid sign to remove | | name | The name of the paid sign to remove |
## Permissions ## Permissions
| Node | Description | | Node | Description |
| ------- | ------- | |---------------------------|------------------------------------------------------|
| paidsigns.* | Grants all paid signs permissions | | paidsigns.* | Grants all paid signs permissions |
| --paidsigns.manage | Grants the permission to add/remove a paid sign | | --paidsigns.manage | Grants the permission to add/remove a paid sign |
| --paidsigns.reload | Grants the permissions to reload the plugin | | --paidsigns.reload | Grants the permissions to reload the plugin |
@ -160,7 +160,7 @@ Removes a registered paid sign
## Configuration options ## Configuration options
| Option | Description | | Option | Description |
| ------- | ------- | |------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| language | The language to use for all messages displayed to players. Currently, only "en" is valid. | | language | The language to use for all messages displayed to players. Currently, only "en" is valid. |
| ignoreCase | Whether to ignore the case (lowercase/uppercase) of the paid sign text. The option can be set on a per-sign basis, but this value is used if not specified. The correct value depends on whether the plugin signs it should match are case-sensitive or not. | | ignoreCase | Whether to ignore the case (lowercase/uppercase) of the paid sign text. The option can be set on a per-sign basis, but this value is used if not specified. The correct value depends on whether the plugin signs it should match are case-sensitive or not. |
| ignoreColor | Whether to ignore any color or formatting applied to the text when trying to match a paid sign's text. The option can be set on a per-sign basis, but this value is used if not specified. The correct value depends on whether the plugin signs it should match allow coloring or not. | | ignoreColor | Whether to ignore any color or formatting applied to the text when trying to match a paid sign's text. The option can be set on a per-sign basis, but this value is used if not specified. The correct value depends on whether the plugin signs it should match allow coloring or not. |