Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aappleton8 authored May 14, 2019
1 parent eecf11b commit 1d88217
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The terms 'username' and 'playername' are used interchangeably in this plugin an
This plugin can use either playernames or player UUIDs. Although this plugin can convert between the two, errors are likely to occur (most commonly users' usernames becoming 'null') if the conversion operation is performed on an offline player. As such, the format to use should be chosen at the start and kept constant. If a conversion is necessary, setting the 'onlyautoupdateonline' config field to true will prevent the plugin updating offline players, avoiding errors. Setting the 'updateonplayerjoins' config field to true will make the plugin convert the players when they come online, however, the user may still appear as 'null' until then. It is recommended always to use player UUIDs.

## Versions:
The current plugin release version is 1.0.2.3. The compiled .jar file is available in the 'releases' section. The 'Jar' folder contains the most recently compiled plugin version that runs (currently version 1.0.3.1); this may be the same as the most recent release or it may be a development build. The development builds may be unstable. The current release of this plugin has been tested on Spigot servers running Minecraft versions 1.7.10, 1.8.9, 1.12.2 and 1.13.1. It is designed for Minecraft versions between 1.7.6 and 1.14.0, and as such, any bug for any version between 1.7.6 and 1.14.0 will be fixed. This plugin is likely to work with many other Minecraft Spigot and Bukkit versions but this is untested and bugs found with these versions will not necessarily be fixed.
The current plugin release version is 1.0.3.1. The compiled .jar file is available in the 'releases' section. The 'Jar' folder contains the most recently compiled plugin version that runs; this may be the same as the most recent release or it may be a development build. The development builds may be unstable. The current release of this plugin has been tested on Spigot servers running Minecraft versions 1.7.10, 1.8.9, 1.12.2 and 1.13.1. It is designed for Minecraft versions between 1.7.6 and 1.14.0, and as such, any bug for any version between 1.7.6 and 1.14.0 will be fixed. This plugin is likely to work with many other Minecraft Spigot and Bukkit versions but this is untested and bugs found with these versions will not necessarily be fixed.

## License:
This plugin and its source code are released under the MIT license (see the [LICENSE file](https://github.com/aappleton8/OpPermissions/blob/master/LICENSE) for full details). This plugin is copyright (c) aappleton3/aappleton8, 2018 - 2019.
Expand All @@ -32,7 +32,7 @@ Below, the individual commands are listed:
- /oppermissions - Show the help screen
- /opset help [1|2|3] - Show the help screen
- /opset help all [1|2|3] - Show help for all commands, even ones the player does not have permission to use
- /opset help config - Show help for setting individual config file fields
- /opset help config [1|2] - Show help for setting individual config file fields
- /opset version - Show the plugin version
- /opset add <playername> - Adds a player to the list
- /opset remove <playername> - Removes a player from the list
Expand All @@ -48,6 +48,10 @@ Below, the individual commands are listed:
- /opset config set permanentopsusecommands true|false - Specify whether permanent ops can use all the blocked commands without the extra permission or not
- /opset config set showopattempts true|false - Specify whether players with the *oppermissions.showopattempts* permission get notified every time someone tries to use the */op* or */deop* command, even if not successfully
- /opset config set showcommanduse true|false - Specify whether players with the *oppermissions.command.show* permission get notified every time someone tries to use one of the commands on the list of blocked commands, even if not successfully
- /opset config set showbanattempts true|false - Specify whether players with the *oppermissions.ban.show* permission get notified every time someone tries to deop an op, even if not successfully
- /opset config set bannableops op|permanent|permission|default|no|false - Specify restrictions on which players can ban ops
- /opset config set bannablepermanentops op|permanent|permission|default|no|false - Specify additional restrictions on which players can ban permanent ops
- /opset config set deoponban true|false - Whether ops who are banned should be deopped or not
- /opset config verifylist - Update the ops list to convert between UUIDs and playernames, depending on the 'useuuids' config field and the 'onlyautoupdateonline' config field (this conversion will also happen when the 'useuuids' field is set)
- /opset list - List the list
- /opset check <playername> - Check if someone is on the list
Expand Down Expand Up @@ -134,6 +138,7 @@ All configurable options for this plugin are in the 'config.yml' file. This file
- bannableops - Whether ops are prevented from being banned or not (default: the default action happens; op: only ops can ban ops; permanent: only permanent ops can ban ops; permission: the *oppermissions.ban.ops* permission is required to ban ops; no|false: the command can only be performed by the console)
- bannablepermanentops - Whether permanent ops are prevented from being banned or not (default: the default action happens; op: only ops can ban ops; permanent: only permanent ops can ban permanent ops; permission: the *oppermissions.ban.permanentops* permission is required to ban permanent ops; no|false: the command can only be performed by the console)
- deoponban - Whether ops who are banned should be deopped or not (true: banned ops are deopped; false: banned ops are not deopped)
- showbanattempts - Whether to announce to people with the *oppermissions.ban.show* command when someone tries to ban an op or permanent op or not (true: announce op ban attempts; false: do not announce op ban attempts)
- ops - The list of permanent ops
- commands - The list of blocked commands

Expand All @@ -152,6 +157,7 @@ showcommanduse: true
bannableops: default
bannablepermanentops: default
deoponban: false
showbanattempts: true
ops:
- aappleton3
- Codefined
Expand Down

0 comments on commit 1d88217

Please sign in to comment.