From 27ba3e600f6e925fb185389243e508a5f65544ef Mon Sep 17 00:00:00 2001 From: Bud Date: Thu, 17 Sep 2020 14:15:52 -0500 Subject: [PATCH] [ci-skip] more readme improvements --- README.md | 52 +++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 37 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6d491c7e..6a1679ec 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Yatopia +Yatopia

Yatopia

The Most Powerful and Feature Rich Minecraft Server Software

@@ -6,12 +6,12 @@ [![Github-CI](https://github.com/YatopiaMC/Yatopia/workflows/CI/badge.svg)](https://github.com/YatopiaMC/Yatopia/actions?query=workflow%3ACI) [![CodeMC](https://ci.codemc.io/buildStatus/icon?job=YatopiaMC%2FYatopia%2Fver%252F1.16.3)](https://ci.codemc.io/job/YatopiaMC/job/Yatopia/job/ver%252F1.16.3/) [![Discord](https://img.shields.io/discord/342814924310970398?color=%237289DA&label=Discord&logo=discord&logoColor=white)](https://discord.io/YatopiaMC) -![API](https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=API&up_color=green&up_message=online&url=http%3A%2F%2Fapi.yatopia.net%2F) +[![API](https://img.shields.io/website?down_color=lightgrey&down_message=offline&label=API&up_color=green&up_message=online&url=http%3A%2F%2Fapi.yatopia.net%2F)](https://api.yatopia.net/v2/latestBuild?branch=ver/1.16.3)
## Introduction ## -A blazing fast fork of [Tuinity](https://github.com/Spottedleaf/Tuinity), featuring patches/code from the following repos: +A blazing fast feature rich fork of [Tuinity](https://github.com/Spottedleaf/Tuinity), featuring patches/code from the following repos: * [EMC](https://github.com/starlis/empirecraft) * [Akarin](https://github.com/Akarin-project/Akarin) @@ -20,16 +20,36 @@ ## Introduction ## * [Purpur](https://github.com/pl3xgaming/Purpur) * [Lithium](https://github.com/jellysquid3/lithium-fabric) +Along with our own additions. + +## Comparison with other forks ## + + |**Yatopia**|**Purpur**|**Akarin**|**Tuinity**|**Paper**|**Spigot**|**Bukkit**|**Vanillia** +:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----: +Actively Updated|✔️|✔️|❌|✔️|✔️|✔️|✔️|❌ +Basic API|✔️|✔️|✔️|✔️|✔️|✔️|✔️|❌ +Advanced API|✔️|✔️|✔️|✔️|✔️|❌|❌|❌ +Fast|✔️|✔️|✔️|✔️|✔️|❌|❌|❌ +Very Fast|✔️|✔️|✔️|✔️|❌|❌|❌|❌ +Extremely Fast|✔️|❌|✔️|❌|❌|❌|❌|❌ +Blazing Fast|✔️|❌|❌|❌|❌|❌|❌|❌ +Basic Configuration|✔️|✔️|✔️|✔️|✔️|✔️|✔️|❌ +Advanced Configuration|✔️|✔️|✔️|✔️|✔️|❌|❌|❌ +Feature Rich Configuration|✔️|✔️|❌|❌|❌|❌|❌|❌ +Designed with Large Player Counts in Mind|✔️|✔️|✔️|✔️|❌|❌|❌|❌ +Reasonable PR System|✔️|✔️|✔️|✔️|✔️|❌|❌|❌ +Advanced Patching Logic|✔️|❌|❌|❌|❌|❌|❌|❌ + ## Give it a try ## Available at the following places: -### Latest Build +### Latest Build ### * **[Yatopia-API](https://api.yatopia.net/v2/latestBuild/download?1.16.3=:1.16.3)** - 1.16.3 (Fully supported) * **[Yatopia-API](https://api.yatopia.net/v2/latestBuild/download?1.16.2=:1.16.2)** - 1.16.2 (Security updates only) -### Build History +### Build History ### * **[CodeMC](https://ci.codemc.io/job/YatopiaMC/job/Yatopia/job/ver%252F1.16.3/)** - 1.16.3 (Fully supported) * **[CodeMC](https://ci.codemc.io/job/YatopiaMC/job/Yatopia/job/ver%252F1.16.2/)** - 1.16.2 (Security updates only) @@ -47,7 +67,7 @@ ## Contributors ## [![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/6)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/6) [![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/7)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/7) -## Documentation +## Documentation ## You can find a full explanation of the Yatopia configuration file on the [Wiki](https://github.com/YatopiaMC/Yatopia/wiki). @@ -55,7 +75,7 @@ ## Documentation You can also find our recommended config base [here](https://github.com/YatopiaMC/Yatopia/wiki/Configurations-Parameters-recommended)! -## Building and setting up +## Building and setting up ## Run the following commands in the root directory: @@ -66,24 +86,26 @@ ## Building and setting up If you are repatching you need to delete `Yatopa-API` and `Yatopia-Server` folders. -## Why are there not many API additions +## Why are there not many API additions ## -(Copied from [starlis/empirecraft](https://github.com/starlis/empirecraft/)) +(Modified from [starlis/empirecraft](https://github.com/starlis/empirecraft/))

-API's are tough to design. In public projects such as Bukkit, Spigot, Sponge etc, once an API is commited. It's almost forever. You can't go breaking it without solid justification. This is the politics game. +APIs are tough to design. In public projects such as Bukkit, Spigot, Sponge, Paper, etc once an API is commited. It's almost forever. You can't go breaking it without solid justification. This is the politics game. With that in mind, much thought has to be given to the API in now and future use cases and applications to ensure it can be extended without breaking. -This is a lot of politics that we don't have time in our lives to deal with. +This is a lot of politics that we don't have time in our lives to deal with. -## LICENSE +That being said we make light API additions when requested. +

+ +## LICENSE ## License information can be found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.3/Licensing/LICENSE.md). -## SECURITY +## SECURITY ## Security information can be found found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.3/SECURITY.md). - -Made with on Earth. \ No newline at end of file +Made with ♥ on Earth.