diff --git a/LICENSE.md b/LICENSE.md index 21b6b238e..33eb7335d 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -4,16 +4,17 @@ As such, Akarin is licensed under the [GNU General Public License version 3](licenses/GPL.md); as it inherits it from Paper, who in turn inherits it from the original Spigot projects. -Any author who is _not_ listed below should be presumed to have released their work +Any author who is _not_ listed below should be presumed to have their work released under the original [GPL](licenses/GPL.md) license. In the interest of promoting a better Minecraft platform for everyone, contributors may choose to release their code under the more permissive [MIT License](licenses/MIT.md). -The authors listed below have chosen to release their code under that more permissive +The authors listed below have chosen to release their code under the more permissive [MIT License](licenses/MIT.md). Any contributor who wants their name added below -should submit a pull request to this project to add their name. +should submit a Pull Request to this project and add their name. ```text Sotr -``` \ No newline at end of file +MatrixTunnel +``` diff --git a/README.md b/README.md index a8694638b..2136cb46b 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,33 @@ # Akarin FaceAkarin -[![Build Status](http://ci.pcd.ac.cn/job/Akarin/badge/icon)](http://ci.ilummc.com/job/Akarin/) -[![bStats](https://img.shields.io/badge/bStats-Torch-0099ff.svg?style=flat)](https://bstats.org/plugin/bukkit/Torch) [![Powered by](https://img.shields.io/badge/Powered_by-Akarin_project-ee6aa7.svg?style=flat)](https://akarin.io) +[![bStats](https://img.shields.io/badge/bStats-Torch-0099ff.svg?style=flat)](https://bstats.org/plugin/bukkit/Torch) +[![Build Status](http://ci.pcd.ac.cn/job/Akarin/badge/icon)](http://ci.ilummc.com/job/Akarin/) +[![Circle CI](https://circleci.com/gh/Akarin-project/Akarin/tree/master.svg?style=svg)](https://circleci.com/gh/Akarin-project/Akarin/tree/master) + +Akarin is currently **under heavy development** and contributions are welcome! Introduction --- -> Akarin is a powerful server software form the 'new dimension', formerly known as Torch. +> Akarin is a powerful server software from the 'new dimension', formerly known as Torch. -As a [Paper](https://github.com/PaperMC/Paper) fork, it supports almost all plugins that [Spigot](https://hub.spigotmc.org/stash/projects/SPIGOT/repos/spigot/browse) can use. +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). -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. +Our project has a few key goals: -Akarin is **under heavy development** yet, contribution is welcome and run a test before putting into production. +* **Open Access** - Make more game mechanics configurable. +* **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 Sites -+ [**Jenkins**](http://ci.ilummc.com/job/Akarin/) - *Kudos to [Izzel_Aliz](https://github.com/IzzelAliz)* -+ [![Circle CI](https://circleci.com/gh/Akarin-project/Akarin/tree/master.svg?style=svg) **Circle CI**](https://circleci.com/gh/Akarin-project/Akarin/tree/master) - Checkout the 'Artifacts' tab of the latest build *Login required* +#### Recommended ++ [**Jenkins**](http://ci.ilummc.com/job/Akarin/) - Kudos to [Izzel_Aliz](https://github.com/IzzelAliz) ++ [**Circle CI**](https://circleci.com/gh/Akarin-project/Akarin/tree/master) - Checkout the 'Artifacts' tab of the latest build -*Contact me via the email below or open an [Issue](https://github.com/Akarin-project/akarin/issues) if you want to add your website here* +*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 @@ -34,20 +38,28 @@ Get Akarin ```sh ./scripts/inst.sh --setup --fast ``` -*For non-modification compile, add `--fast` option to skip the test is recommended.* -*Futhermore, if your machine have a insufficient memory, you may add `--remote` option to avoid decompile locally.* -Demonstration servers +**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 --- -+ **demo.akarin.io** +* `demo.akarin.io` (official) -*Contact me via the email below or open an [Issue](https://github.com/Akarin-project/akarin/issues) if you want to add your server here* +*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* Contributing --- -* Feel free to open an [Issue](https://github.com/Akarin-project/akarin/issues) if you have any problem with Akarin. -* [Pull Request](https://github.com/Akarin-project/akarin/pulls) 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](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 an email to `kira@kira.moe` with your experience and necessary information. Besides, welcome to join our [Discord](https://discord.gg/D3Rsukh) to chat. -* Note that you must `--setup` at least once to deploy necessary dependency otherwise some imports cannot be organized. +* Akarin uses [Mixin](https://github.com/SpongePowered/Mixin) to modify the code. You can checkout the `sources` folder to see more. +* 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 us an email with your experience and necessary information. -![Akarin project](https://i.loli.net/2018/05/13/5af7fbbfbcddf.png) \ No newline at end of file +Contact +--- +[Discord](https://discord.gg/D3Rsukh) + +Email: `kira@kira.moe` + +![Akarin project](https://i.loli.net/2018/05/13/5af7fbbfbcddf.png)