About
The plugin was started to create a self managing white list system for server's using the Shivtr system to run their communities based on the characters list. It automatically downloads the the characters.json file and scans it for the user's name upon login. You can use the configuration file to change the frequency that it updates the file. However, this is limited by design so that it must take at least 30 minutes to automatically refresh unless forced by the command.
Origins
Shivtr Auth was originally a libcomponents script. libcomponents scripts can only be used if you have CommandBook another plugin originally written by the famous sk89q known for WorldEdit, WorldGuard, and CraftBook. To use it you would put the script in the component-classes folder.
Usage
To use Shivtr Auth you must have a Shivtr based website with the Characters Feature enabled. Shivtr Auth's white list system uses the list of Characters to determine if the play can login. It's this simple: Install, Configure, add the MineCraft names you want to the Characters list, wait for Shivtr Auth to update its list(s) and you are done :)
Commands
| Command | Permission | What does it do? |
|---|---|---|
| authupdate | shivtrauth.commands.update | Force an update of the list(s) |
Installation
Installation of Shivtr Auth is relatively simple, just drop Shivtr Auth.jar in your plugins folder and then configure config.yml as instructed below. :)
Configuration Guide
Configuring Shivtr Auth is relatively simple. There are two settings these are website-url and update-frequency. As you can imagine the website-url setting should be your website's url. This does support custom domain names. For example you can use http://example.com/ instead of http://example.shivtr.com/ . One critical thing to not about this is the url must be a full url. It must be formatted in the exact manor it is presented in changing out the word example for whatever is relevant to your website.
The second setting update-frequency is also rather self explanatory. This is how often in minutes the server will update the file. One important thing to note is 30 is the minimum value. Anything lower will cause the server to force the time to 30. This is done for the safety of your own server. For example if this feature was not implemented and you made the property 0, it would crash your server because it would schedule the updates faster than you could download them, use them, and faster than your ram could dismiss the task meaning your server would crash within minutes (this problem was actually encountered while testing and creating this plugin and that is one reason while this feature exist).
Mini-Configuration Guide (Short, Simple, Quick)
website-url: http://example.shivtr.com/ - This is your websites url just change out example for what you type to access your website so if you go to http://123abc.shivtr.com/ then change out the word example in this url for 123abc, change nothing else. If you happen to have a full url use it instead but ensure it is prefixed with http:// and suffixed with /.
update-frequency: 30 - This is how often the file is updated in minutes it can be any value equal to or higher than 30.
Default File
website-url: http://example.shivtr.com/ update-frequency: 30
Developers
Want to interact with Shivtr Auth? Learn how here or here (I recommend this one, it has syntax highlighting).