Update readme and name (un)restriction setting comments (#652)

- Add missing language code to readme
- Remove Gource video from readme (now over a year old)
- Improve property comments for name restrictions and unrestrictions
This commit is contained in:
ljacqu 2016-11-13 12:27:52 +01:00
parent 5dda439bed
commit ed29ae2318
3 changed files with 23 additions and 28 deletions

View File

@ -38,10 +38,6 @@ McStats: http://mcstats.org/plugin/AuthMe
<img src="http://i.mcstats.org/AuthMe/Version+Demographics.borderless.png"> <img src="http://i.mcstats.org/AuthMe/Version+Demographics.borderless.png">
#####Development history:
Outdated!
[![Gource AuthMe History Video](http://img.youtube.com/vi/hJRzNfYyd9k/hqdefault.jpg)](https://www.youtube.com/watch?v=hJRzNfYyd9k)
<hr> <hr>
#####Compiling Requirements: #####Compiling Requirements:
@ -104,11 +100,11 @@ You can also create your own translation file and, if you want, you can share it
<li><strong>Cached database queries!</strong></li> <li><strong>Cached database queries!</strong></li>
<li><strong>Fully compatible with Citizens2, CombatTag, CombatTagPlus and ChestShop!</strong></li> <li><strong>Fully compatible with Citizens2, CombatTag, CombatTagPlus and ChestShop!</strong></li>
<li>Compatible with Minecraft mods like <strong>BuildCraft or RedstoneCraft</strong></li> <li>Compatible with Minecraft mods like <strong>BuildCraft or RedstoneCraft</strong></li>
<li>Restricted users (associate a Username with an IP)</li> <li>Restricted users (associate a username with an IP)</li>
<li>Protect player's inventory until a correct Authentication</li> <li>Protect player's inventory until correct authentication</li>
<li>Saves the quit location of the player</li> <li>Saves the quit location of the player</li>
<li>Automatic database Backup</li> <li>Automatic database backup</li>
<li>Available languages: en, de, br, cz, pl, fr, uk, ru, hu, sk, es, fi, zhtw, zhhk, zhcn, lt, it, ko, pt, nl, gl, bg, eu, tr, vn (feel free to send new translations)</li> <li>Available languages: en, de, br, cz, pl, fr, uk, ru, hu, sk, es, fi, id, zhtw, zhhk, zhcn, lt, it, ko, pt, nl, gl, bg, eu, tr, vn (feel free to send new translations)</li>
<li>Built-in Deprecated FlatFile (auths.db) to SQL (authme.sql) converter!</li> <li>Built-in Deprecated FlatFile (auths.db) to SQL (authme.sql) converter!</li>
<li><strong>Import your old database from other plugins like Rakamak, xAuth, CrazyLogin, RoyalAuth and vAuth!</strong></li> <li><strong>Import your old database from other plugins like Rakamak, xAuth, CrazyLogin, RoyalAuth and vAuth!</strong></li>
</ul> </ul>
@ -130,7 +126,7 @@ You can also create your own translation file and, if you want, you can share it
- [Website integration](http://dev.bukkit.org/server-mods/authme-reloaded/pages/web-site-integration/) - [Website integration](http://dev.bukkit.org/server-mods/authme-reloaded/pages/web-site-integration/)
- [Click here for an example of the config file](https://raw.githubusercontent.com/Xephi/AuthMeReloaded/master/src/main/resources/config.yml) - [Click here for an example of the config file](https://raw.githubusercontent.com/Xephi/AuthMeReloaded/master/src/main/resources/config.yml)
- [How to convert from Rakamak](http://dev.bukkit.org/server-mods/authme-reloaded/pages/how-to-import-database-from-rakamak/) - [How to convert from Rakamak](http://dev.bukkit.org/server-mods/authme-reloaded/pages/how-to-import-database-from-rakamak/)
- Convert from FlatFile (auths.db but not the sqlite one) to MySQL: /authme converter - Convert between database types (e.g. SQLite to MySQL): /authme converter
<hr> <hr>

View File

@ -1,5 +1,5 @@
<!-- AUTO-GENERATED FILE! Do not edit this directly --> <!-- AUTO-GENERATED FILE! Do not edit this directly -->
<!-- File auto-generated on Sun Nov 13 10:33:55 CET 2016. See docs/config/config.tpl.md --> <!-- File auto-generated on Sun Nov 13 12:06:04 CET 2016. See docs/config/config.tpl.md -->
## AuthMe Configuration ## AuthMe Configuration
The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder, The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder,
@ -150,7 +150,7 @@ settings:
# to enable this option and configure the AllowedRestrictedUser field. # to enable this option and configure the AllowedRestrictedUser field.
AllowRestrictedUser: false AllowRestrictedUser: false
# The restricted user feature will kick players listed below # The restricted user feature will kick players listed below
# if they don't match the defined IP address. # if they don't match the defined IP address. Names are case-insensitive.
# Example: # Example:
# AllowedRestrictedUser: # AllowedRestrictedUser:
# - playername;127.0.0.1 # - playername;127.0.0.1
@ -214,13 +214,13 @@ settings:
# Force survival gamemode when player joins? # Force survival gamemode when player joins?
ForceSurvivalMode: false ForceSurvivalMode: false
unrestrictions: unrestrictions:
# Below you can list all account names that # Below you can list all account names that AuthMe will ignore
# AuthMe will ignore for registration or login, configure it # for registration or login. Configure it at your own risk!!
# at your own risk!! Remember that if you are going to add # This option adds compatibility with BuildCraft and some other mods.
# nickname with [], you have to delimit name with ' '. # It is case-insensitive! Example:
# this option add compatibility with BuildCraft and some # UnrestrictedName:
# other mods. # - 'npcPlayer'
# It is case-sensitive! # - 'npcPlayer2'
UnrestrictedName: [] UnrestrictedName: []
security: security:
# Minimum length of password # Minimum length of password
@ -463,4 +463,4 @@ To change settings on a running server, save your changes to config.yml and use
--- ---
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Sun Nov 13 10:33:55 CET 2016 This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Sun Nov 13 12:06:04 CET 2016

View File

@ -4,7 +4,6 @@ import com.github.authme.configme.Comment;
import com.github.authme.configme.SettingsHolder; import com.github.authme.configme.SettingsHolder;
import com.github.authme.configme.properties.Property; import com.github.authme.configme.properties.Property;
import javax.inject.Inject;
import java.util.List; import java.util.List;
import static com.github.authme.configme.properties.PropertyInitializer.newListProperty; import static com.github.authme.configme.properties.PropertyInitializer.newListProperty;
@ -78,7 +77,7 @@ public class RestrictionSettings implements SettingsHolder {
@Comment({ @Comment({
"The restricted user feature will kick players listed below", "The restricted user feature will kick players listed below",
"if they don't match the defined IP address.", "if they don't match the defined IP address. Names are case-insensitive.",
"Example:", "Example:",
" AllowedRestrictedUser:", " AllowedRestrictedUser:",
" - playername;127.0.0.1"}) " - playername;127.0.0.1"})
@ -177,13 +176,13 @@ public class RestrictionSettings implements SettingsHolder {
newProperty("settings.GameMode.ForceSurvivalMode", false); newProperty("settings.GameMode.ForceSurvivalMode", false);
@Comment({ @Comment({
"Below you can list all account names that", "Below you can list all account names that AuthMe will ignore",
"AuthMe will ignore for registration or login, configure it", "for registration or login. Configure it at your own risk!!",
"at your own risk!! Remember that if you are going to add", "This option adds compatibility with BuildCraft and some other mods.",
"nickname with [], you have to delimit name with ' '.", "It is case-insensitive! Example:",
"this option add compatibility with BuildCraft and some", "UnrestrictedName:",
"other mods.", "- 'npcPlayer'",
"It is case-sensitive!" "- 'npcPlayer2'"
}) })
public static final Property<List<String>> UNRESTRICTED_NAMES = public static final Property<List<String>> UNRESTRICTED_NAMES =
newLowercaseListProperty("settings.unrestrictions.UnrestrictedName"); newLowercaseListProperty("settings.unrestrictions.UnrestrictedName");