Upstream
/
Yatopia
mirror of https://github.com/YatopiaMC/Yatopia.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[ci-skip] more readme improvements

This commit is contained in:
Bud 2020-09-17 14:15:52 -05:00
parent db64f0a942
commit 27ba3e600f
1 changed files with 37 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -1,4 +1,4 @@
<img src="https://raw.githubusercontent.com/YatopiaMC/Yatopia/ver/1.16.3/images/yatopia.gif" alt="Yatopia" align="right" width="256" height="256">
<img src="https://raw.githubusercontent.com/YatopiaMC/Yatopia/ver/1.16.3/images/yatopia.png" alt="Yatopia" align="right">
<div align="center">
<h1>Yatopia</h1>
<h3>The Most Powerful and Feature Rich Minecraft Server Software</h3>
@ -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)
</div>
## 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 @@ A blazing fast fork of [Tuinity](https://github.com/Spottedleaf/Tuinity), featur
* [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 @@ Available at the following places:
[![](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 @@ Also check out the list of patches included in this Project and who created them
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 @@ Run the following commands in the root directory:
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/))
<p>
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.
</p>
## 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).
<link rel="stylesheet" type="text/css" href="//code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css" />
Made with <i class="icon ion-heart"></i> on Earth.
Made with <span style="color: #e25555;">&#9829;</span> on Earth.