From d6711d83b39a4aaa09dcad34907cb790ddc3a024 Mon Sep 17 00:00:00 2001 From: Arvind Kumar Date: Thu, 17 Oct 2019 06:34:27 +0000 Subject: [PATCH] Fixes in documentation (#1927) * Fixed typos and grammer in documentation --- docs/config.md | 18 ++++---- samples/NewConfig.yml | 46 +++++++++---------- .../properties/RegistrationSettings.java | 2 +- src/test/java/tools/docs/config/config.tpl.md | 6 +-- .../resources/fr/xephi/authme/config.test.yml | 6 +-- 5 files changed, 38 insertions(+), 40 deletions(-) diff --git a/docs/config.md b/docs/config.md index 811481d5..e032daa8 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,9 +1,9 @@ - + ## AuthMe Configuration -The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder, -with which you can configure various settings. This following is the initial contents of +The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder, +with which you can configure various settings. The following is the initial contents of the generated config.yml file. ```yml @@ -70,6 +70,8 @@ DataSource: mySQLlastlocYaw: yaw # Column for storing player LastLocation - Pitch mySQLlastlocPitch: pitch + # Column for storing players uuids (optional) + mySQLPlayerUUID: '' # Overrides the size of the DB Connection Pool, default = 10 poolSize: 10 # The maximum lifetime of a connection in the pool, default = 1800 seconds @@ -124,10 +126,6 @@ settings: # By default we schedule async tasks when talking to the database. If you want # typical communication with the database to happen synchronously, set this to false useAsyncTasks: true - # By default we handle the AsyncPlayerPreLoginEvent which makes the plugin faster - # but it is incompatible with any permission plugin not included in our compatibility list. - # If you have issues with permission checks on player join please disable this option. - useAsyncPreLoginEvent: true # The name of the server, used in some placeholders. serverName: Your Minecraft Server restrictions: @@ -327,7 +325,7 @@ settings: removeJoinMessage: false # Should we remove leave messages altogether? removeLeaveMessage: false - # Do we need to add potion effect Blinding before login/reigster? + # Do we need to add potion effect Blinding before login/register? applyBlindEffect: false # Do we need to prevent people to login with another case? # If Xephi is registered, then Xephi can login, but not XEPHI/xephi/XePhI @@ -573,9 +571,9 @@ Converter: ``` -To change settings on a running server, save your changes to config.yml and use +To change settings on a running server, save your changes to config.yml and use `/authme reload`. --- -This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Tue Apr 23 17:17:02 CEST 2019 +This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Thu Oct 17 08:29:25 CEST 2019 diff --git a/samples/NewConfig.yml b/samples/NewConfig.yml index 91e063d0..c0b392c4 100644 --- a/samples/NewConfig.yml +++ b/samples/NewConfig.yml @@ -121,7 +121,7 @@ settings: # If the server change fails the player will be kicked. target: LoginLobby1 failKickMessage: 'Failed to connect to the lobby! Please try to join the server again!' - + # Variables: # %p playername bungee_commands: @@ -174,7 +174,7 @@ settings: # Registration settings. # =========================== - registration: + registration: # After how many time unregistered players should be kicked? # Set to 0 to disable. (default: 30) timeout: 30 @@ -205,12 +205,12 @@ settings: # Login settings. # =========================== - login: + login: # After how many time unlogged players should be kicked? # Set to 0 to disable. (default: 30) timeout: 30 - + # =========================== # Encryption parameters. @@ -235,7 +235,7 @@ settings: unlogged_restrictions: # Deny chat messages send for unlogged users. deny_chat: true - # Hide chat to unlogged users. + # Hide chat to unlogged users. # Only player messages, plugins will be able to send messages to the player anyway. hide_chat: false @@ -257,16 +257,16 @@ settings: # Should unlogged players have speed = 0? # After the login the walking/flying speeed will be reset to the default value. removeSpeed: true - + # End is there atm xD - + # This option will save the quit location of the players. SaveQuitLocation: false # Should not logged in players be teleported to the spawn? # After the authentication, if SaveQuitLocation is enabled, # they will be teleported back to their normal position. teleportUnAuthedToSpawn: false - + # If enabled, after the login, if the ForceSpawnOnTheseWorlds setting contains # the player's world, he will be teleported to the world spawnpoint. # The quit location of the player will be overwritten. @@ -306,22 +306,22 @@ settings: # =========================== # Address restrictions # =========================== - + # Max number of registrations per IP (default: 1) maxRegPerIp: 1 # Maximum allowed number of Logins per IP, 0 to disable (default: 0) maxLoginPerIp: 0 # Maximum allowed number of Joins per IP, 0 to disable (default: 0) maxJoinPerIp: 0 - + # When this setting is enabled, online players can't be kicked out # due to "Logged in from another Location" - # This setting will prevent potetial security exploits. + # This setting will prevent potential security exploits. ForceSingleSession: true - + # To activate the restricted user feature you need # to enable this option and configure the - # AllowedRestrctedUser field. + # AllowedRestrictedUser field. AllowRestrictedUser: false # The restricted user feature will kick players listed below # if they dont match of the defined ip address. @@ -332,35 +332,35 @@ settings: - playername;127.0.0. # Ban ip when the ip is not the ip registered in database banUnsafedIP: false - - + + # =============================== # Other restrictions # =============================== - + # Should we protect the player inventory before logging in? # Warning: Requires the latest version of ProtocolLib! ProtectInventoryBeforeLogIn: true - + # Should unregistered players be kicked immediately? kickNonRegistered: false # Should players be kicked on wrong password? kickOnWrongPassword: false - + # Should we display all other accounts of a player when he joins? # Required permission: authme.admin.accounts displayOtherAccounts: true - + # =============================== # Restrictions compatibility # =============================== - + # Spawn Priority. Avariable values : authme, essentials, multiverse, default spawnPriority: authme,essentials,multiverse,default # AuthMe will NEVER teleport players! noTeleport: false - + GameMode: # Do you want to set player's gamemode to survival when he joins? # This enables also the settings below. @@ -369,9 +369,9 @@ settings: ResetInventoryIfCreative: false # Do you want to force the survival mode ONLY after the /login process? ForceOnlyAfterLogin: false - + # sgdc3: Ok, our configuration is shit.... xD Today I will stop there - + registration: # enable registration on the server? diff --git a/src/main/java/fr/xephi/authme/settings/properties/RegistrationSettings.java b/src/main/java/fr/xephi/authme/settings/properties/RegistrationSettings.java index 324f0f1f..daefe92c 100644 --- a/src/main/java/fr/xephi/authme/settings/properties/RegistrationSettings.java +++ b/src/main/java/fr/xephi/authme/settings/properties/RegistrationSettings.java @@ -97,7 +97,7 @@ public final class RegistrationSettings implements SettingsHolder { public static final Property REMOVE_LEAVE_MESSAGE = newProperty("settings.removeLeaveMessage", false); - @Comment("Do we need to add potion effect Blinding before login/reigster?") + @Comment("Do we need to add potion effect Blinding before login/register?") public static final Property APPLY_BLIND_EFFECT = newProperty("settings.applyBlindEffect", false); diff --git a/src/test/java/tools/docs/config/config.tpl.md b/src/test/java/tools/docs/config/config.tpl.md index 25cf8c2c..1de5c99d 100644 --- a/src/test/java/tools/docs/config/config.tpl.md +++ b/src/test/java/tools/docs/config/config.tpl.md @@ -2,15 +2,15 @@ ## AuthMe Configuration -The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder, -with which you can configure various settings. This following is the initial contents of +The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder, +with which you can configure various settings. The following is the initial contents of the generated config.yml file. ```yml {config} ``` -To change settings on a running server, save your changes to config.yml and use +To change settings on a running server, save your changes to config.yml and use `/authme reload`. {gen_footer} diff --git a/src/test/resources/fr/xephi/authme/config.test.yml b/src/test/resources/fr/xephi/authme/config.test.yml index 54548e62..f77d55dd 100644 --- a/src/test/resources/fr/xephi/authme/config.test.yml +++ b/src/test/resources/fr/xephi/authme/config.test.yml @@ -42,7 +42,7 @@ settings: maxNicknameLength: 16 # When this setting is enabled, online players can't be kicked out # due to "Logged in from another Location" - # This setting will prevent potetial security exploits. + # This setting will prevent potential security exploits. ForceSingleSession: true ForceSpawnLocOnJoin: # If enabled, every player will be teleported to the world spawnpoint @@ -61,7 +61,7 @@ settings: SaveQuitLocation: false # To activate the restricted user feature you need # to enable this option and configure the - # AllowedRestrctedUser field. + # AllowedRestrictedUser field. AllowRestrictedUser: false # The restricted user feature will kick players listed below # if they don't match of the defined ip address. @@ -87,7 +87,7 @@ settings: # After how many time players who fail to login or register # should be kicked? Set to 0 to disable. timeout: 30 - # Regex sintax of allowed characters in the player name. + # Regex syntax of allowed characters in the player name. allowedNicknameCharacters: '[a-zA-Z0-9_]*' # How far can unregistered players walk? Set to 0 # for unlimited radius