From 3019e339457bae2d0471a0481aaa5f95cba4930b Mon Sep 17 00:00:00 2001 From: DGun Otto Date: Wed, 12 Jul 2023 00:37:53 +0800 Subject: [PATCH] Update README.md --- README.md | 145 +----------------------------------------------------- 1 file changed, 2 insertions(+), 143 deletions(-) diff --git a/README.md b/README.md index 9f57cf40..2fcf281e 100644 --- a/README.md +++ b/README.md @@ -1,144 +1,3 @@ -# AuthMeReloaded -**"The best authentication plugin for the Bukkit modding API!"** +# AuthMeReReloaded +**"A fork of the best authentication plugin for the Bukkit modding API!"** -AuthMeLogo - -| Type | Badges | -|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **General:** | ![](https://tokei.rs/b1/github/AuthMe/AuthMeReloaded?category=code) ![](https://tokei.rs/b1/github/AuthMe/AuthMeReloaded?category=files) | -| **Code quality:** | [![Code Climate](https://codeclimate.com/github/AuthMe/AuthMeReloaded/badges/gpa.svg)](https://codeclimate.com/github/AuthMe/AuthMeReloaded) [![Coverage status](https://coveralls.io/repos/AuthMe-Team/AuthMeReloaded/badge.svg?branch=master&service=github)](https://coveralls.io/github/AuthMe-Team/AuthMeReloaded?branch=master) | -| **Jenkins CI:** | [![Jenkins Status](https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=ci.codemc.org)](https://ci.codemc.org/) [![Build Status](https://ci.codemc.org/buildStatus/icon?job=AuthMe/AuthMeReloaded)](https://ci.codemc.org/job/AuthMe/job/AuthMeReloaded) ![Build Tests](https://img.shields.io/jenkins/t/https/ci.codemc.org/job/AuthMe/job/AuthMeReloaded.svg) | -| **Other CIs:** | [![Build Status](https://www.travis-ci.com/AuthMe/AuthMeReloaded.svg?branch=master)](https://www.travis-ci.com/AuthMe/AuthMeReloaded) | - -## Description - -Prevent username stealing on your server!
-Use it to secure your Offline mode server or to increase your Online mode server's protection! - -AuthMeReloaded disallows players who aren't authenticated to do actions like placing blocks, moving,
-typing commands or using the inventory. It can also kick players with uncommonly long or short player names or kick players from banned countries. - -With the Session Login feature you don't have to execute the authentication command every time you connect to the server! -Each command and every feature can be enabled or disabled from our well structured configuration file. - -You can also create your own translation file and, if you want, you can share it with us! :) - -#### Features: - - -#### Configuration -[How to configure AuthMe](https://github.com/AuthMe/AuthMeReloaded/blob/master/docs/config.md) -#### Commands -[Command list and usage](https://github.com/AuthMe/AuthMeReloaded/blob/master/docs/commands.md) -#### Permissions -- authme.player.* - for all user commands -- authme.admin.* - for all admin commands -- [List of all permission nodes](http://github.com/AuthMe/AuthMeReloaded/blob/master/docs/permission_nodes.md) - -#### How To -- [How to use the converter](https://github.com/AuthMe/AuthMeReloaded/wiki/Converters) -- [How to import database from xAuth](https://dev.bukkit.org/projects/authme-reloaded/pages/how-to-import-database-from-xauth) -- [Website integration](https://github.com/AuthMe/AuthMeReloaded/tree/master/samples/website_integration) -- [How to convert from Rakamak](https://dev.bukkit.org/projects/authme-reloaded/pages/how-to-import-database-from-rakamak) -- Convert between database types (e.g. SQLite to MySQL): /authme converter - - -## Links and Contacts - - - **Support:** - - [GitHub issue tracker](https://github.com/AuthMe/AuthMeReloaded/issues) - - [Discord](https://discord.gg/Vn9eCyE) - - [BukkitDev page](https://dev.bukkit.org/projects/authme-reloaded) - - [Spigot page](https://www.spigotmc.org/resources/authmereloaded.6269/) - -- **Dev resources:** - - JavaDocs - - Maven Repository - ```xml - - - codemc-repo - https://repo.codemc.org/repository/maven-public/ - - - - - - fr.xephi - authme - 5.6.0-SNAPSHOT - provided - - - ``` - -- **Statistics:** - ![Graph](https://bstats.org/signatures/bukkit/AuthMe.svg) - -## Requirements - -##### Compiling requirements: ->- JDK 11 (JDK 17 is recommended) ->- Maven ->- Git/Github (Optional) - -##### How to compile the project: ->- Clone the project with Git/GitHub ->- Execute command "mvn clean package" - -##### Running requirements: ->- Java 8 (Java 17 is recommended) ->- Paper or Spigot (1.8.X and up)
- (In case you use Thermos, Cauldron or similar, you have to update the SpecialSource library to support Java 8 plugins. - HowTo: https://github.com/games647/FastLogin/issues/111#issuecomment-272331347) ->- ProtocolLib (optional, required by some features) - -## Credits - -##### Contributors: -Team members: developers, translators - -Credits for the old version of the plugin: d4rkwarriors, fabe1337, Whoami2 and pomo4ka - -Thanks also to: AS1LV3RN1NJA, Hoeze and eprimex - -##### GeoIP License: -This product uses data from the GeoLite API created by MaxMind, available at https://www.maxmind.com