From ed9c878270411699ab0517502ad0d5b8b7effaba Mon Sep 17 00:00:00 2001 From: Sotr Date: Thu, 17 May 2018 01:44:56 +0800 Subject: [PATCH] Update README w/ scripts enchanced --- README.md | 36 ++++++++++++++++++++++++++++++++++++ scripts/build.sh | 2 +- work/Paper | 2 +- 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..5e4cb839d --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Akarin +[![Minecraft](https://img.shields.io/badge/Minecraft-1.12-blue.svg?style=flat)](https://www.minecraft.net/) +[![bStats](https://img.shields.io/badge/bStats-Torch-blue.svg?style=flat)](https://bstats.org/plugin/bukkit/Torch) + +Introduction +--- +> Akarin is a powerful server software form the 'new dimension', formerly known as [Torch](https://github.com/GelandiAssociation/Torch). + +As a [Paper](https://github.com/PaperMC/Paper) fork, it supports almost plugins that [Spigot](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/spigot/browse) can use. + +It has a few key goals: +* Open Access - Make more game mechanism configurable. +* Bedrock - Safety and stable is important for a server. +* Fast - Simplify the logic and import the multi-thread compute. + +Akarin is **under heavy development** yet, contribution is welcome and run a test before putting into production. + +Build/Compile +--- +#### Requirements +* Java (JDK) 8 or above +* Maven + +#### Build +```sh +./scripts/inst.sh --setup --fast +``` +*For non-modification compile, add `--fast` option to skip the test is recommended.* + +Contributing +--- +* Feel free to open an issue if you have any problem with Akarin. +* Pull Request is welcomed, Akarin use [Mixin](https://github.com/SpongePowered/Mixin) to modify the code, you can checkout `sources` folder to see them. Moreover, add your name to the [LICENSE](.github/LICENSE.md) if you want to publish your code under the [MIT License](.github/licenses/MIT.md). +* If you want to join the Akarin-project team, you can send an email to `kira@kira.moe` with your experience and necessary information. Besides, welcome to join our [TIM Group](https://jq.qq.com/?_wv=1027&k=59q2kV4) to chat. + +![Akarin project](https://i.loli.net/2018/05/13/5af7fbbfbcddf.png) \ No newline at end of file diff --git a/scripts/build.sh b/scripts/build.sh index 81921195b..36f4184cf 100644 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -22,7 +22,7 @@ echo "[Akarin] Ready to build" yes|cp -rf "$basedir/sources/server/pom.xml" "$paperbasedir/Paper-Server/" cd "$paperbasedir" - if [ "$2" == "--fast" ]; then + if [ "$2" == "--fast" || "$3" == "--fast" ]; then echo "[Akarin] Test has been skipped" mvn clean install -DskipTests else diff --git a/work/Paper b/work/Paper index 9cf714090..dbd5bd6e8 160000 --- a/work/Paper +++ b/work/Paper @@ -1 +1 @@ -Subproject commit 9cf714090eaa3a9716b0260b905bb7b58699e464 +Subproject commit dbd5bd6e82123472e90e4c445ac91281bea6c164