Upstream/LuckPerms
1
0
Fork 0
mirror of https://github.com/LuckPerms/LuckPerms.git synced 2024-11-27 21:29:47 +01:00
Code Issues Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Luck 2018-04-04 17:10:33 +01:00
parent 6a5b7ce3a1
commit 96f0f46b3e
No known key found for this signature in database
GPG Key ID: EFA9B3EC5FD90F8B
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -5,24 +5,23 @@ LuckPerms is an advanced permissions implementation aiming to be a fast, reliabl
LuckPerms also includes an extensive API for developers, and support for a variety of Minecraft server software & data storage options. LuckPerms also includes an extensive API for developers, and support for a variety of Minecraft server software & data storage options.
The main features of the project are detailed on this wiki page: [Why LuckPerms?](https://github.com/lucko/LuckPerms/wiki/Why-LuckPerms) Still not convinced? More information can be found on the wiki, under: [Why LuckPerms?](https://github.com/lucko/LuckPerms/wiki/Why-LuckPerms)
* [Spigot Plugin Release Page](https://www.spigotmc.org/resources/luckperms-an-advanced-permissions-system.28140/ "Spigot Plugin Page")
* [Sponge Plugin Release Page](https://forums.spongepowered.org/t/luckperms-an-advanced-permissions-system/14274 "Sponge Plugin Page")
## Useful Links ## Useful Links
* **Downloads** - <https://ci.lucko.me/job/LuckPerms>
* **Wiki** - <https://github.com/lucko/LuckPerms/wiki> The latest **downloads** can be found on the [project's homepage](https://luckperms.github.io/).
More information about the project & how to use the plugin can be found in the [wiki](https://github.com/lucko/LuckPerms/wiki).
## Building ## Building
LuckPerms uses Maven to handle dependencies. LuckPerms uses Maven to handle dependencies.
#### Requirements #### Requirements
* Java 8 JDK * Java 8 JDK or newer
* Maven 3.3.x (the older versions will not work.) * Maven 3.3.x or newer (the older versions will not work.)
* Git * Git
#### Then run #### Compiling from source
```sh ```sh
git clone https://github.com/lucko/LuckPerms.git git clone https://github.com/lucko/LuckPerms.git
cd LuckPerms/ cd LuckPerms/
@ -42,7 +41,7 @@ The project is split up into 5 seperate modules.
* **API** - The public, semantically versioned API used by other plugins wishing to integrate with and retrieve data from LuckPerms. This module (for the most part) does not contain any implementation itself, and is provided by the plugin. * **API** - The public, semantically versioned API used by other plugins wishing to integrate with and retrieve data from LuckPerms. This module (for the most part) does not contain any implementation itself, and is provided by the plugin.
* **Common** - The common module contains most of the code which implements the respective LuckPerms plugins. This abstract module reduces duplicated code throughout the project. * **Common** - The common module contains most of the code which implements the respective LuckPerms plugins. This abstract module reduces duplicated code throughout the project.
* **Bukkit, BungeeCord & Sponge** - Each use the common module to implement plugins on the respective server platforms. * **Bukkit, BungeeCord, Sponge & Nukkit** - Each use the common module to implement plugins on the respective server platforms.
## License ## License
LuckPerms is licensed under the permissive MIT license. Please see [`LICENSE.txt`](https://github.com/lucko/LuckPerms/blob/master/LICENSE.txt) for more info. LuckPerms is licensed under the permissive MIT license. Please see [`LICENSE.txt`](https://github.com/lucko/LuckPerms/blob/master/LICENSE.txt) for more info.