Upstream/Yatopia
1
0
Fork 0
mirror of https://github.com/YatopiaMC/Yatopia.git synced 2024-11-26 04:25:39 +01:00
Code Issues Projects Releases Wiki Activity

[CI-SKIP] Clean up the README (#231)

Browse Source 
* Clean up the README

* Update headings and dev build download link

* Minor spelling shit
This commit is contained in:
Mykyta 2020-10-03 12:05:10 -07:00 committed by GitHub
parent 8a67951956
commit 960b9733e5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
README.md
View File

@ -1,62 +1,34 @@
<img width="300" src="https://raw.githubusercontent.com/YatopiaMC/Yatopia/ver/1.16.3/images/yatopia-shadow.png" alt="Yatopia" align="right"> <img width="200" src="https://yatopia.net/static/img/yatopia-shiny.gif" alt="Yatopia" align="right">
<div align="center"> <div align="left">
<h1>Yatopia</h1> <h1>Yatopia</h1>
<h3>The Most Powerful and Feature Rich Minecraft Server Software</h3>
[![Github-CI](https://github.com/YatopiaMC/Yatopia/workflows/CI/badge.svg)](https://github.com/YatopiaMC/Yatopia/actions?query=workflow%3ACI) [![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/) [![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) [![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)](https://api.yatopia.net/v2/latestBuild?branch=ver/1.16.3) [![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)
<h3>Blazing fast <a href="https://github.com/Spottedleaf/Tuinity">Tuinity</a> fork with no-compromises performance.</h3>
</div> </div>
## Introduction ## ## So what is Yatopia?
Yatopia combines the best patches from many Paper forks and optimization mods, as well as many unique optimizations. We borrow some of our patches 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) * [Akarin](https://github.com/Akarin-project/Akarin)
* [Rainforest](https://github.com/Proximyst/Rainforest) * [EMC](https://github.com/starlis/empirecraft)
* [Lithium](https://github.com/jellysquid3/lithium-fabric)
* [Origami](https://github.com/Minebench/Origami) * [Origami](https://github.com/Minebench/Origami)
* [Purpur](https://github.com/pl3xgaming/Purpur) * [Purpur](https://github.com/pl3xgaming/Purpur)
* [Lithium](https://github.com/jellysquid3/lithium-fabric) * [Rainforest](https://github.com/Proximyst/Rainforest)
* [Tic-TACS](https://github.com/gegy1000/tic-tacs/) * [Tic-TACS](https://github.com/gegy1000/tic-tacs/)
Along with our own additions.
## Comparison with other forks ## ## Try it out
The latest stable builds of Yatopia are always available over at our [downloads page](https://yatopia.net/download.html). You can also download the latest development build [here](https://api.yatopia.net/v2/latestBuild/download?branch=ver/1.16.3).
| | Yatopia | Purpur | Akarin | Tuinity | Paper | Spigot | Bukkit | Vanillia | ## Documentation
|-------------------------------------------|---------|--------|--------|---------|-------|--------|--------|----------|
| 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 | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ❌ | ❌ | ❌ |
## Give it a try ## You can find a full explanation of the Yatopia configuration file on the [wiki](https://github.com/YatopiaMC/Yatopia/wiki). Check out the list of patches included in this project and who created them [here](PATCHES.md). You can also find our recommended config base [here](https://github.com/YatopiaMC/Yatopia/wiki/Configurations-Parameters-recommended)!
Available at the following places: ## Contributors
### 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 ###
* **[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)
* **[GitHub Releases](https://github.com/YatopiaMC/Yatopia/releases/tag/1.16.1)** - 1.16.1 (Unsupported)
* **[GitHub Actions](https://github.com/YatopiaMC/Yatopia/actions?query=branch%3Aver%2F1.15.2+is%3Asuccess+event%3Apush)** - 1.15.2 (Unsupported)
## Contributors ##
[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/0)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/0) [![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/0)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/0)
[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/1)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/1) [![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/1)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/1)
@ -67,19 +39,8 @@ ## 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/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) [![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/7)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/7)
## (b)Stats ##
[![bStats Graph Data](https://bstats.org/signatures/server-implementation/Yatopia.svg)](https://bstats.org/plugin/server-implementation/Yatopia) ## Building and setting up
## Documentation ##
You can find a full explanation of the Yatopia configuration file on the [Wiki](https://github.com/YatopiaMC/Yatopia/wiki).
Also check out the list of patches included in this Project and who created them [here](PATCHES.md)!
You can also find our recommended config base [here](https://github.com/YatopiaMC/Yatopia/wiki/Configurations-Parameters-recommended)!
## Building and setting up ##
Run the following commands in the root directory: Run the following commands in the root directory:
@ -90,10 +51,9 @@ ## Building and setting up ##
If you are repatching you need to delete `Yatopa-API` and `Yatopia-Server` folders. If you are repatching you need to delete `Yatopa-API` and `Yatopia-Server` folders.
## Using Yatopia-API ## ## Using Yatopia-API
To build your plugin against the Yatopia-API, To build your plugin against the Yatopia-API, first add the CodeMC maven repository:
First add the CodeMC maven repository:
```xml ```xml
<repositories> <repositories>
<!-- CodeMC --> <!-- CodeMC -->
@ -116,7 +76,7 @@ ## Using Yatopia-API ##
</dependencies> </dependencies>
``` ```
## Why are there not many API additions ## ## Why aren't there many API additions?
(Modified from [starlis/empirecraft](https://github.com/starlis/empirecraft/)) (Modified from [starlis/empirecraft](https://github.com/starlis/empirecraft/))
<p> <p>
@ -129,14 +89,15 @@ ## Why are there not many API additions ##
That being said we make light API additions when requested. That being said we make light API additions when requested.
</p> </p>
## LICENSE ## ## License
License information can be found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.3/Licensing/LICENSE.md). 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). Security information can be found found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.3/SECURITY.md).
## ## Statistics
[![bStats Graph Data](https://bstats.org/signatures/server-implementation/Yatopia.svg)](https://bstats.org/plugin/server-implementation/Yatopia)
Made with <span style="color: #e25555;">&#9829;</span> on Earth. Made with <span style="color: #e25555;">&#9829;</span> on Earth.