1.2.1

README.md

@@ -1,4 +1,7 @@
-# SimpleAuthHelper
+<img src="https://raw.githubusercontent.com/alejandroliu/bad-plugins/master/Media/helper.alt-icon.png" style="width:64px;height:64px" width="64" height="64"/>
+
+SimpleAuthHelper
+================
 
 * Summary: Simplifies the SimpleAuth login process
 * Dependency Plugins: n/a
@@ -7,8 +10,10 @@
 * OptionalPlugins: -
 * Categories: General
 * Plugin Access: Commands
+* WebSite: [github](https://github.com/alejandroliu/bad-plugins/tree/master/SimpleAuthHelper)
 
-## Overview
+Overview
+--------
 
 Very simple plugin that simplifies the login process... Instead of
 asking for commands, users simply chat away...
@@ -24,15 +29,74 @@ password (again without */register*).
 
 ### Login process
 
-Player connects agian.  They are prompted to enter their login
+Player connects again.  They are prompted to enter their login
 password.  They type their login password directly (without
 */login*).  And they are in.
 
-## Changes
+Documentation
+-------------
+
+As a bonus, it can start a player with initial inventory upon
+registration.  This is configured through the `nest-egg` setting.
+
+### Commands
+
+* *chpwd* _<old-pwd>_  
+  Used by players to change their passwords.
+* *resetpwd* _<player>_  
+  Used by ops to reset a players password.  This actually unregisters
+  the password.
+
+### Configuration
+
+	---
+	messages:
+	  re-enter pwd: 'Please re-enter password to confirm:'
+	  passwords dont match: |-
+	    Passwords do not match.
+	    Please try again!
+	    Enter a new password:
+	  register ok: You have been registered!
+	  no spaces: |-
+	    Password should not contain spaces
+	    or tabs
+	  not name: Password should not be your name
+	  too many login: You have attempted to login too many times.
+	  login timeout: Login timer expired!
+	nest-egg:
+	- "272:0:1"
+	- "17:0:16"
+	- "364:0:5"
+	- "266:0:10"
+	max-attempts: 5
+	login-timeout: 60
+	...
+
+* The section `messages` can be used to configure displayed texts.
+* `nest-egg` section contains list of items that will be given to the
+player upon registration.
+* `max-attempts` counts the number of tries to login.
+* `login-timeout` will kick the player out if not authenticated in
+  that number of seconds.
+
+Changes
+-------
 
+* 1.2.1: CallbackTask deprecation
+  * Removed CallbackTask deprecation warnings
+* 1.2.0: max-logins
+  * Suggestion from MCPEPIG
+    - kick user out after `max-attempts`.
+    - Added a chpwd command.
+  * Kick user out if not authenticated after `timeout` seconds.
+  * Added resetpwd command for ops
+* 1.1.0: Small update
+  * Added `nest-egg`
+  * Messages can be configured.
 * 1.0.0: First release
 
-## Copyright
+Copyright
+---------
 
     SimpleAuthHelper
     Copyright (C) 2015 Alejandro Liu  

plugin.yml

@@ -1,9 +1,27 @@
 main: aliuly\helper\Main
 api: 1.10.0
 load: POSTWORLD
+depend: [SimpleAuth]
 
 name: SimpleAuthHelper
 description: Simplifies the way people authenticate to servers
-version: 1.0.0
+version: 1.2.1
 author: aliuly
 
+commands:
+  chpwd:
+    description: "Change password"
+    usage: "/chpwd <old_password>"
+    permission: simpleauthhelper.command.chpwd
+  resetpwd:
+    description: "Reset password"
+    usage: "/resetpwd <player>"
+    permission: simpleauthhelper.command.resetpwd
+
+permissions:
+  simpleauthhelper.command.chpwd:
+    default: true
+    description: "Allow users to change passwords"
+  simpleauthhelper.command.resetpwd:
+    default: op
+    description: "Allow ops to reset other's passwords"