diff --git a/README.md b/README.md index 551ebadab..88b431dbe 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Akarin FaceAkarin + [![Powered by](https://img.shields.io/badge/Powered_by-Akarin_project-ee6aa7.svg?style=flat)](https://akarin.app/) [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/fw2pJAj) [![bStats](https://img.shields.io/badge/bStats-Torch-0099ff.svg?style=flat)](https://bstats.org/plugin/bukkit/Torch) @@ -10,6 +11,7 @@ Akarin is currently **under heavy development** and contributions are welcome! Introduction --- + > Akarin is a powerful server software from the 'new dimension', formerly known as Torch. As a [Paper](https://github.com/PaperMC/Paper) fork, it should support almost all plugins that work on [Spigot](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/spigot/browse). @@ -17,15 +19,18 @@ As a [Paper](https://github.com/PaperMC/Paper) fork, it should support almost al Our project has a few key goals: * **Open Access** - Make more game mechanics configurable. -* **Bedrock** - Make the server more safe and stable. +* **Bedrock** - Make the server more safe and stable. * **Fast** - Simplify the logic and implement multi-threaded computing. *Issues and Pull Requests will be labeled accordingly* Get Akarin --- + ### Download + #### Recommended + + [**Circle CI**](https://circleci.com/gh/Akarin-project/Akarin/tree/ver/master) - Checkout the 'Artifacts' tab of the latest build *Login required* + [**JosephWorks Jenkins**](http://localhost:8080/job/Akarin-project/job/Akarin/) + [**Melon Jenkins**](https://ci.melon.cat/job/Akarin/) - Offline @@ -33,24 +38,29 @@ Get Akarin *Open an [Issue](https://github.com/Akarin-project/Akarin/issues) or a [Pull Request](https://github.com/Akarin-project/Akarin/pulls) if you want to add your website here* ### Build + #### Requirements + * Java (JDK) 8 or above * Maven #### Compile + ```sh chmod -Rv a+x scripts/ -./scripts/build.sh +./scripts/build.sh ./scripts/inst.sh --setup --fast ``` **Notes** + * You must use `--setup` at least once to deploy necessary dependencies otherwise some imports cannot be organized. * For non-modified projects, it is recommended to add the `--fast` option to skip any tests. * If your machine has insufficient memory, you may want to add the `--remote` option to avoid decompiling locally. Demo Servers --- + * [Fair Server](https://fairserver.ru) * [LoyaltyMC](https://www.loyaltymc.net/) * ~~`demo.akarin.io` (official)~~ @@ -59,6 +69,7 @@ Demo Servers Contributing --- + * You can checkout the `src` folder to see more. Please follow the patch style to do any change, so we are able to update between different Minecraft versions. * Add your name to the [LICENSE](https://github.com/Akarin-project/Akarin/blob/master/LICENSE.md) if you want to publish your code under the [MIT License](https://github.com/Akarin-project/Akarin/blob/master/licenses/MIT.md). * If you want to join the [Akarin-project](https://github.com/Akarin-project) team, you can [send](mailto://kira@kira.moe) us an email with your experience and necessary information.