Fixes README table formatting
This commit is contained in:
parent
dd47ce06eb
commit
1154d7ddaf
112
README.md
112
README.md
@ -58,16 +58,16 @@ unfortunate. That's really just how tab-completion works, and not something I th
|
||||
An argument marked by "<>" is required to execute the command. An argument marked by "[]" is optional. For empty
|
||||
arguments, such as no paid sign permission, you should use empty quotes ("").
|
||||
|
||||
| Command | Arguments | Permission | Description |
|
||||
| -------- | ------ | ------- | ------- |
|
||||
| /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 |
|
||||
| [/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](#listpaidsigns) | \[name (of a paid sign)] \[line number] | paidsigns.manage | Used to list registered paid signs or a registered paid sign's 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](#removepaidsigncondition) | \<name (of a paid sign)> \<line number> | paidsigns.manage | Used to remove a condition from 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 |
|
||||
| Command | Arguments | Permission | Description |
|
||||
|------------------------------------------------------|---------------------------------------------------------------------------------------------------------|------------------|---------------------------------------------------------------------------|
|
||||
| /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 |
|
||||
| [/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](#listpaidsigns) | \[name (of a paid sign)] \[line number] | paidsigns.manage | Used to list registered paid signs or a registered paid sign's 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](#removepaidsigncondition) | \<name (of a paid sign)> \<line number> | paidsigns.manage | Used to remove a condition from 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 |
|
||||
|
||||
## Command explanation
|
||||
|
||||
@ -77,14 +77,14 @@ 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]`
|
||||
|
||||
| Argument | Usage |
|
||||
| ----- | ----- |
|
||||
|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 |
|
||||
|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 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. |
|
||||
| Argument | Usage |
|
||||
|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 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 |
|
||||
| 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 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. |
|
||||
|
||||
### /addpaidsigncondition
|
||||
|
||||
@ -93,14 +93,14 @@ 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]`
|
||||
|
||||
| Argument | Usage |
|
||||
| ----- | ----- |
|
||||
| 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 |
|
||||
| string to match | The string or regular expression to look for on a sign |
|
||||
| executeRegEx | Whether to use a regular expression match instead of looking for the exact string |
|
||||
| ignoreCase | Whether this condition should ignore case when trying to match the string (default uses the "parent" sign's value) |
|
||||
| ignoreColor | Whether this condition should ignore color when trying to match the string (default uses the "parent" sign's value) |
|
||||
| Argument | Usage |
|
||||
|-----------------|---------------------------------------------------------------------------------------------------------------------|
|
||||
| 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 |
|
||||
| string to match | The string or regular expression to look for on a sign |
|
||||
| executeRegEx | Whether to use a regular expression match instead of looking for the exact string |
|
||||
| ignoreCase | Whether this condition should ignore case when trying to match the string (default uses the "parent" sign's value) |
|
||||
| ignoreColor | Whether this condition should ignore color when trying to match the string (default uses the "parent" sign's value) |
|
||||
|
||||
### /listpaidsigns
|
||||
|
||||
@ -108,11 +108,11 @@ This lists registered paid signs and paid sign conditions. No arguments will pri
|
||||
|
||||
`/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 |
|
||||
| name | The name of the paid sign to see information about |
|
||||
| line number | The line number of the condition 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 |
|
||||
|
||||
### /editpaidsign
|
||||
|
||||
@ -120,12 +120,12 @@ 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]`
|
||||
|
||||
| Argument | Usage |
|
||||
| ----- | ----- |
|
||||
| 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 |
|
||||
| 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 | The new property value of the condition property specified in the third argument |
|
||||
| Argument | Usage |
|
||||
|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 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 |
|
||||
| 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 | The new property value of the condition property specified in the third argument |
|
||||
|
||||
### /removepaidsigncondition
|
||||
|
||||
@ -133,10 +133,10 @@ Removes a paid sign condition from a sign
|
||||
|
||||
`/removepaidsigncondition <name (of a paid sign)> <line number>`
|
||||
|
||||
| Argument | Usage |
|
||||
| ----- | ----- |
|
||||
| name | The name of the paid sign to remove the condition from |
|
||||
| line number | The line the condition is associated with |
|
||||
| Argument | Usage |
|
||||
|-------------|--------------------------------------------------------|
|
||||
| name | The name of the paid sign to remove the condition from |
|
||||
| line number | The line the condition is associated with |
|
||||
|
||||
### /removepaidsign
|
||||
|
||||
@ -144,29 +144,29 @@ Removes a registered paid sign
|
||||
|
||||
`/removepaidsign <name (of a paid sign)>`
|
||||
|
||||
| Argument | Usage |
|
||||
| ----- | ----- |
|
||||
| name | The name of the paid sign to remove |
|
||||
| Argument | Usage |
|
||||
|----------|-------------------------------------|
|
||||
| name | The name of the paid sign to remove |
|
||||
|
||||
## Permissions
|
||||
|
||||
| Node | Description |
|
||||
| ------- | ------- |
|
||||
| paidsigns.* | Grants all paid signs permissions |
|
||||
| --paidsigns.manage | Grants the permission to add/remove a paid sign |
|
||||
| --paidsigns.reload | Grants the permissions to reload the plugin |
|
||||
| Node | Description |
|
||||
|---------------------------|------------------------------------------------------|
|
||||
| paidsigns.* | Grants all paid signs permissions |
|
||||
| --paidsigns.manage | Grants the permission to add/remove a paid sign |
|
||||
| --paidsigns.reload | Grants the permissions to reload the plugin |
|
||||
| --paidsigns.paymentexempt | Makes this player exempt from the cost of paid signs |
|
||||
|
||||
## Configuration options
|
||||
|
||||
| Option | Description |
|
||||
| ------- | ------- |
|
||||
| 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. |
|
||||
| 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. |
|
||||
| refundsEnabled | Whether to enable refunds to the sign creator when a sign detected as a paid sign is broken (payment will always go to the original creator) |
|
||||
| refundPercentage | The percentage of the paid sign cost to refund (0-100) |
|
||||
| refundAlways | Whether to refund when signs that players have paid for are broken by anything. This includes tnt, creepers, pistons and similar |
|
||||
| Option | Description |
|
||||
|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 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. |
|
||||
| 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. |
|
||||
| refundsEnabled | Whether to enable refunds to the sign creator when a sign detected as a paid sign is broken (payment will always go to the original creator) |
|
||||
| refundPercentage | The percentage of the paid sign cost to refund (0-100) |
|
||||
| refundAlways | Whether to refund when signs that players have paid for are broken by anything. This includes tnt, creepers, pistons and similar |
|
||||
|
||||
## Language customization
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user