From ed29ae231880a6db08a4b8b91caf4361c9ff8485 Mon Sep 17 00:00:00 2001 From: ljacqu Date: Sun, 13 Nov 2016 12:27:52 +0100 Subject: [PATCH] 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 --- README.md | 14 +++++-------- docs/config.md | 20 +++++++++---------- .../properties/RestrictionSettings.java | 17 ++++++++-------- 3 files changed, 23 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index a5fa9fb52..ceb5b85bd 100644 --- a/README.md +++ b/README.md @@ -38,10 +38,6 @@ McStats: http://mcstats.org/plugin/AuthMe -#####Development history: -Outdated! -[![Gource AuthMe History Video](http://img.youtube.com/vi/hJRzNfYyd9k/hqdefault.jpg)](https://www.youtube.com/watch?v=hJRzNfYyd9k) -
#####Compiling Requirements: @@ -104,11 +100,11 @@ You can also create your own translation file and, if you want, you can share it
  • Cached database queries!
  • Fully compatible with Citizens2, CombatTag, CombatTagPlus and ChestShop!
  • Compatible with Minecraft mods like BuildCraft or RedstoneCraft
    • -
  • Restricted users (associate a Username with an IP)
    • -
  • Protect player's inventory until a correct Authentication
    • +
  • Restricted users (associate a username with an IP)
    • +
  • Protect player's inventory until correct authentication
  • Saves the quit location of the player
    • -
  • Automatic database Backup
    • -
  • 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)
    • +
  • Automatic database backup
    • +
  • 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)
  • Built-in Deprecated FlatFile (auths.db) to SQL (authme.sql) converter!
  • Import your old database from other plugins like Rakamak, xAuth, CrazyLogin, RoyalAuth and vAuth!
    • @@ -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/) - [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/) -- 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
    diff --git a/docs/config.md b/docs/config.md index efe739cd3..99e428dfe 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,5 +1,5 @@ - + ## AuthMe Configuration 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. AllowRestrictedUser: false # 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: # AllowedRestrictedUser: # - playername;127.0.0.1 @@ -214,13 +214,13 @@ settings: # Force survival gamemode when player joins? ForceSurvivalMode: false unrestrictions: - # Below you can list all account names that - # AuthMe will ignore for registration or login, configure it - # at your own risk!! Remember that if you are going to add - # nickname with [], you have to delimit name with ' '. - # this option add compatibility with BuildCraft and some - # other mods. - # It is case-sensitive! + # Below you can list all account names that AuthMe will ignore + # for registration or login. Configure it at your own risk!! + # This option adds compatibility with BuildCraft and some other mods. + # It is case-insensitive! Example: + # UnrestrictedName: + # - 'npcPlayer' + # - 'npcPlayer2' UnrestrictedName: [] security: # 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 diff --git a/src/main/java/fr/xephi/authme/settings/properties/RestrictionSettings.java b/src/main/java/fr/xephi/authme/settings/properties/RestrictionSettings.java index 87e0419e3..3fb681913 100644 --- a/src/main/java/fr/xephi/authme/settings/properties/RestrictionSettings.java +++ b/src/main/java/fr/xephi/authme/settings/properties/RestrictionSettings.java @@ -4,7 +4,6 @@ import com.github.authme.configme.Comment; import com.github.authme.configme.SettingsHolder; import com.github.authme.configme.properties.Property; -import javax.inject.Inject; import java.util.List; import static com.github.authme.configme.properties.PropertyInitializer.newListProperty; @@ -78,7 +77,7 @@ public class RestrictionSettings implements SettingsHolder { @Comment({ "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:", " AllowedRestrictedUser:", " - playername;127.0.0.1"}) @@ -177,13 +176,13 @@ public class RestrictionSettings implements SettingsHolder { newProperty("settings.GameMode.ForceSurvivalMode", false); @Comment({ - "Below you can list all account names that", - "AuthMe will ignore for registration or login, configure it", - "at your own risk!! Remember that if you are going to add", - "nickname with [], you have to delimit name with ' '.", - "this option add compatibility with BuildCraft and some", - "other mods.", - "It is case-sensitive!" + "Below you can list all account names that AuthMe will ignore", + "for registration or login. Configure it at your own risk!!", + "This option adds compatibility with BuildCraft and some other mods.", + "It is case-insensitive! Example:", + "UnrestrictedName:", + "- 'npcPlayer'", + "- 'npcPlayer2'" }) public static final Property> UNRESTRICTED_NAMES = newLowercaseListProperty("settings.unrestrictions.UnrestrictedName");