AuthMeReloaded/README.md

<hr>
<p align="center"><img src="http://www.imagestorming.com/media/cys/1328692322/authme.png"></p>
<p align="center"><strong>The most used authentication plugin for CraftBukkit/Spigot!</strong></p>
<hr>
#####Development tools:

- Developers ChatRoom: [![Join the chat at https://gitter.im/Xephi/AuthMeReloaded](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Xephi/AuthMeReloaded?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

- Build status (Travis): [![Build Status](https://travis-ci.org/Xephi/AuthMeReloaded.svg?branch=master)](https://travis-ci.org/Xephi/AuthMeReloaded)

- Build status (CircleCI): [CircleCI project Page](https://travis-ci.org/Xephi/AuthMeReloaded)

- Build Server (<strong>DEVELOPMENT BUILDS</strong>): <a href="http://ci.xephi.fr">Xephi's Jenkins</a>

- JavaDocs: <a href="http://xephi.github.io/AuthMeReloaded/index.html">AuthMe Javadoc</a>

- Maven Repo: <a href="http://xephi.fr:8080/plugin/repository/everything/">AuthMe Repo</a>

#####Statistics:

McStats: http://mcstats.org/plugin/AuthMe

<img src=http://i.mcstats.org/AuthMe/Global+Statistics.borderless.png>

<img src=http://i.mcstats.org/AuthMe/Version+Demographics.borderless.png>

<hr>

#####Compiling Requirements:
>- JDK 1.7
>- Maven
>- Git/Github (Optional)

#####How to compile the project:
>- Clone the project with Git/Github
>- Execute command "mvn clean install"

#####Running Requirements:
>- Java 1.7 (should work also with Java 1.8)
>- Spigot or CraftBukkit

<hr>
###Plugin Description:

#####"The best authentication plugin for the Bukkit/Spigot API!"

<p>Prevent username stealing on your server! Full compatible with UUIDs and Craftbukkit/Spigot 1.8.X!<br>
Use it to secure your Offline mode server or to incrase your Online mode server's protection!</p>

<p>AuthMeReloaded disallows players who aren't authenticated to do actions like placing blocks, moving,<br>
typing commands or use the inventory. It can also kick players with uncommon long or short player names or kick players from banned countries.</p>
<p>With the Session Login feature you don't have to execute the authentication command everytime you connect to the server! Each command and every feature can be enabled or disabled from our well structured configuration file.</p>
<p>You can also create your own translation file and if you want you can share it with us!</p>

####Features:
<ul>
  <li><strong>E-Mail Recovery System !!!</strong></li>
  <li>Username spoofing protection.</li>
  <li>Countries Whitelist/Blacklist! <a href="http://dev.bukkit.org/bukkit-plugins/authme-reloaded/pages/countries-codes/">(countries codes)</a></li>
  <li><strong>Built-in AntiBot System!</strong></li>
  <li><del>Passpartu Feature: Admin can login with all account more info <a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/how-to-install-and-initial-configuration/">here</a></del> <strong>Deprecated</strong></li>
  <li><strong>Avoid the "Logged in from another location" message!</strong></li>
  <li>Session Login!</li>
  <li>Editable translations and messages!</li>
  <li><strong>MySQL and SQLite Backend support!</strong></li>
  <li>Supported password encryption algorithms: MD5, SHA1, SHA256, <a href="https://github.com/CypherX/xAuth/wiki/Password-Hashing">xAuth</a>, <a href="http://en.wikipedia.org/wiki/Whirlpool_(cryptography)">Whirlpool</a></li>
  <li>Support for PLAINTEXT password storage
</li><li>Support for PHPBB, VBullettin forum registration: <strong>MD5VB - PHPBB</strong>
</li><li>Support for MyBB : <strong>MYBB</strong>
</li><li>Support for IPB3 : <strong>IPB3</strong>
</li><li>Support for PhpFusion : <strong>PHPFUSION</strong>
</li><li>Support for Xenforo SHA1 with : <strong>XFSHA1</strong>
</li><li>Support for Xenforo SHA256 with : <strong>XFSHA256</strong>
</li><li>Support for Joomla with : <strong>JOOMLA</strong>
</li><li>Support for WBB3 with : <strong>WBB3*</strong>
</li><li>Support for SHA512 with : <strong>SHA512</strong>
</li><li>Support DoubleSaltedMD5 password with : <strong>SALTED2MD5</strong>
</li><li>Support WordPress integration, password with : <strong>WORDPRESS</strong>
</li><li>Custom MySQL tables/columns (useable for forums, other scripts)
</li><li>Database queries can be cached
</li><li><em>Compatible with Citizens NPC plugin and CombatTag plugin</em>
</li><li>Compatible with Minecraft mods like <strong>BuildCraft or RedstoneCraft</strong>
</li><li><em>Account restriction through IP and name</em>
</li><li><em>Permissions group switching on un-logged-in</em>
</li><li>Different permission group for Registered and unRegistered users
</li><li>Support for permissions onJoin with transient vault system
</li><li>Cache on file for all inventories and enchants for un-logged-in players
</li><li>Save Quit location to prevent loss of position
</li><li>Possible to use without a Permissions plugin
</li><li><strong>Spoutcraft Login GUI</strong>
</li><li>Automatic backup system of all your user password data
</li><li>Default Language Style: en, de, br, cz, pl, fr, uk, ru, hu, sk, es, fi, zhtw, zhhk, zhcn, lt, it, ko, pt, nl, gl, bg, eu, tr ( feel free to send new translations )
</li><li>Convert the FlatFile auths.db to an usefull authme.sql that you can use on a MySQL database !
</li><li>Import your database from Rakamak, xAuth, CrazyLogin, RoyalAuth, vAuth !
</li></ul>
####Configuration
<a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/configure-auth-me/">How to Configure Authme</a>
####Email Recovery Dependency
<a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/how-to-configure-email-recovery-system/">How to configure email recovery system?</a>
####Commands
<a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/command/">Command list and usage</a>
####Permissions
<ul><li>authme.player.* - for all user command
</li><li>authme.admin.* - for all admin command
</li><li>authme.* - for all user and admin command
</li><li><a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/permissions/">List of all single permissions</a>
</li></ul>
####How To
<ul><li><a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/how-to-install-and-initial-configuration/">How to Install and Setup</a>
</li><li><a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/how-to-import-database-from-xauth/">How to import database from xAuth</a>
</li><li><a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/web-site-integration/">WebSite Integration</a>
</li><li><a href="https://raw.githubusercontent.com/Xephi/AuthMeReloaded/master/src/main/resources/config.yml">Click here for an example of the Config file</a>
</li><li><a href="http://dev.bukkit.org/server-mods/authme-reloaded/pages/how-to-import-database-from-rakamak/">How to convert from Rakamak</a>
</li><li>Convert from FlatFile (auths.db but not the sqlite one ) to MySQL : /converter
</li></ul>
<hr>

#####GeoIP
<p>This product includes and download automatically GeoLite data created by MaxMind, available from <a href="http://www.maxmind.com">http://www.maxmind.com</a></p>
<hr>

#####Donate
<p>Do you like my work ? Or just want to buy me a coffee for quickly update?<br>
Use this link in EUR: <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=QLMM9SNCX825Y"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif"></a>
Or this link in USD: <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=PWQMYCP2SAH6L"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif"></a></p>

#####Credits
<p>Credit for old version to d4rkwarriors, fabe1337 , Whoami and pomo4ka</p>
<p>Thanks to : AS1LV3RN1NJA, Hoeze, eprimex</p>