Yatopia/README.md

<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>

[![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)](https://api.yatopia.net/v2/latestBuild?branch=ver/1.16.3)
</div>

## Introduction ##

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)
* [Rainforest](https://github.com/Proximyst/Rainforest)
* [Origami](https://github.com/Minebench/Origami)
* [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 | ✔️      | ✔️     | ✔️     | ✔️      | ❌     | ❌      | ❌      | ❌        | 
| Resonable PR System                       | ✔️      | ✔️     | ✔️     | ✔️      | ✔️    | ❌      | ❌      | ❌        | 
| Advanced Patching Logic                   | ✔️      | ❌      | ❌      | ❌       | ❌     | ❌      | ❌      | ❌        | 


## Give it a try ##

Available at the following places:

### 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/1)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/1)
[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/2)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/2)
[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/3)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/3)
[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/4)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/4)
[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/5)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/5)
[![](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 ##

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:

```shell
./yatopia in
./yatopia full
```

If you are repatching you need to delete `Yatopa-API` and `Yatopia-Server` folders.

## Why are there not many API additions ##

(Modified from [starlis/empirecraft](https://github.com/starlis/empirecraft/))
<p>
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. 

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 information can be found found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.3/SECURITY.md).

##

Made with <span style="color: #e25555;">&#9829;</span> on Earth.
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`<img src="https://raw.githubusercontent.com/YatopiaMC/Yatopia/ver/1.16.3/images/yatopia.png" alt="Yatopia" align="right">`
Update README.md 2020-08-03 21:34:41 +02:00			`<div align="center">`
[ci-skip] readme stuff 2020-09-17 17:21:10 +02:00			`<h1>Yatopia</h1>`
			`<h3>The Most Powerful and Feature Rich Minecraft Server Software</h3>`
Update README.md 2020-08-03 21:34:41 +02:00
Initial 1.16.2 support This update had major internal changes, which took us 8 hours to figure out and resolve all things untill we have a successful build. YatopiaMC members wish you happy playing using Yatopia for your server software MAKE A BACKUP OF YOUR WORLD BEFORE RUNNING IT ON YOUR SERVER. YOU HAVE BEEN WARNED. People have reported to paper that after upgrading villagers are gone. There could be even more issues we are unknown of. MAKE A BACKUP OF YOUR WORLD BEFORE RUNNING IT ON YOUR SERVER. YOU HAVE BEEN WARNED. Co-authored-by: Ovydux <68059159+Ovydux@users.noreply.github.com> Co-authored-by: Simon Gardling <Titaniumtown@gmail.com> Co-authored-by: budgidiere <sgidiere@gmail.com> 2020-08-13 17:53:32 +02:00			`[![Github-CI](https://github.com/YatopiaMC/Yatopia/workflows/CI/badge.svg)](https://github.com/YatopiaMC/Yatopia/actions?query=workflow%3ACI)`
[ci-skip] update README.md to match CodeMC 1.16.3 builds 2020-09-14 14:13:07 +02:00			`[![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/)`
Update ReadME.md to correct discord link (#168) 2020-08-29 10:27:19 +02:00			`[![Discord](https://img.shields.io/discord/342814924310970398?color=%237289DA&label=Discord&logo=discord&logoColor=white)](https://discord.io/YatopiaMC)`
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`[![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)`
Update README.md 2020-08-03 21:34:41 +02:00			`</div>`
Update README.md 2020-03-23 22:42:28 +01:00
Update README.md 2020-08-03 21:34:41 +02:00			`## Introduction ##`
init 2020-02-26 17:23:57 +01:00
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`A blazing fast feature rich fork of [Tuinity](https://github.com/Spottedleaf/Tuinity), featuring patches/code from the following repos:`
init 2020-02-26 17:23:57 +01:00
Update README.md A folllow up of my previous commit, the config entries should be moved to a wiki imo 2020-08-03 22:46:36 +02:00			`* [EMC](https://github.com/starlis/empirecraft)`
			`* [Akarin](https://github.com/Akarin-project/Akarin)`
Small Bug Fix/General Clean Up 2020-08-06 16:05:19 +02:00			`* [Rainforest](https://github.com/Proximyst/Rainforest)`
Update readme 2020-08-06 05:07:50 +02:00			`* [Origami](https://github.com/Minebench/Origami)`
Update README.md A folllow up of my previous commit, the config entries should be moved to a wiki imo 2020-08-03 22:46:36 +02:00			`* [Purpur](https://github.com/pl3xgaming/Purpur)`
Update README.md 2020-08-06 23:14:34 +02:00			`* [Lithium](https://github.com/jellysquid3/lithium-fabric)`
Update README.md A folllow up of my previous commit, the config entries should be moved to a wiki imo 2020-08-03 22:46:36 +02:00
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`Along with our own additions.`

			`## Comparison with other forks ##`

[ci-skip] fix table 2020-09-17 21:18:08 +02:00			`\| \| 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 \| ✔️ \| ✔️ \| ✔️ \| ✔️ \| ❌ \| ❌ \| ❌ \| ❌ \|`
			`\| Resonable PR System \| ✔️ \| ✔️ \| ✔️ \| ✔️ \| ✔️ \| ❌ \| ❌ \| ❌ \|`
			`\| Advanced Patching Logic \| ✔️ \| ❌ \| ❌ \| ❌ \| ❌ \| ❌ \| ❌ \| ❌ \|`

[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00
Patch credits, readme updates (#54) 2020-08-06 19:18:29 +02:00			`## Give it a try ##`
Update README.md A folllow up of my previous commit, the config entries should be moved to a wiki imo 2020-08-03 22:46:36 +02:00
[chi-skip] more readme updates 2020-09-17 18:27:38 +02:00			`Available at the following places:`
Update README.md A folllow up of my previous commit, the config entries should be moved to a wiki imo 2020-08-03 22:46:36 +02:00
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`### Latest Build ###`
[ci-skip] readme stuff 2020-09-17 17:21:10 +02:00
			`* [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)`

[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`### Build History ###`
[ci-skip] readme stuff 2020-09-17 17:21:10 +02:00
[ci-skip] more README changes 2020-09-14 19:24:55 +02:00			`* [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)`
Update README.md A folllow up of my previous commit, the config entries should be moved to a wiki imo 2020-08-03 22:46:36 +02:00
[ci-skip] fix 2020-09-17 17:32:02 +02:00			`## 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/1)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/1)`
			`[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/2)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/2)`
			`[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/3)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/3)`
			`[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/4)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/4)`
			`[![](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/images/5)](https://sourcerer.io/fame/budgidiere/YatopiaMC/Yatopia/links/5)`
			`[![](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)`
[ci-skip] readme stuff 2020-09-17 17:21:10 +02:00
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`## Documentation ##`
Update README.md 2020-06-19 22:25:02 +02:00
[chi-skip] more readme updates 2020-09-17 18:27:38 +02:00			`You can find a full explanation of the Yatopia configuration file on the [Wiki](https://github.com/YatopiaMC/Yatopia/wiki).`
Update README.md 2020-06-19 22:25:02 +02:00
Patch credits, readme updates (#54) 2020-08-06 19:18:29 +02:00			`Also check out the list of patches included in this Project and who created them [here](PATCHES.md)!`
Update README.md 2020-06-19 22:33:36 +02:00
[chi-skip] more readme updates 2020-09-17 18:27:38 +02:00			`You can also find our recommended config base [here](https://github.com/YatopiaMC/Yatopia/wiki/Configurations-Parameters-recommended)!`

[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`## Building and setting up ##`
[ci-skip] readme stuff 2020-09-17 17:21:10 +02:00
Update README.md 2020-07-16 00:30:41 +02:00			`Run the following commands in the root directory:`
init 2020-02-26 17:23:57 +01:00
[ci-skip] readme stuff 2020-09-17 17:21:10 +02:00			```shell
			`./yatopia in`
[WIP] Better Patch System (#18) * Update build.yml * Remove 3rd party patches * Add Upsteam Submodules * Fix patches * ? * Fix patches * Add Fast Init script * Lots of stuff also it's broke * more broken * fixes * mor stuff * gfhfgh hg * fix patch * fix up script * update submodule * add papercut * update tuinity * update gitmodules * fix var name * fix more var stuff * some how it's not deleting shit anymore * should now use the branch it just made why are we doing this again? * now it does thing thing * return previous so YAPFA can use it * ok now it really does the thing * for REAL it does the thing * don't do the thing because it causes too many problems * fix api * work * use better patching for YAPFA patches * fix better patching * more fixes * new patches stuff * remove old 3rd parry patches add removed akarin patches * make new branch for making patches * hopefully build patches correctly * fix gitignore and add config patches * remove papercut files * fix some weirdness * fix bug * time to do some fixin' :eyes: * New Patch System Rebased Patches * fix full build * exit 1 * fix * Remove patch * Hopefully fix compile errors * fixes * this might work * don't use rej for our patches * tmp disable cache * some times case sensitivity is dumb * my sanity is at an all time low :) * dfg * readd cahce * fix? * Update Upstream * fix perms * fix * fix api * Redo API * rm folders * fix villager brain patch * emc explosion pref * fixed aikar's shit * betterfix * fix lagggg * Origami * Origami Fixes * Update readme * test async path finding * WIP Async Path Finding * WIP fix async path finding * same as bellow * same * update to newer funcs * fix newer funcs * fix author * Updates, Fixes, and new patches * fixes * possibly async flying path finding * minor asnyc pathfinding fix * test remove non asnyc path finder * WIP make all path finding async * Rename everything * Exec flag * Rebuild hashes * remove dupe patch * fix? * Fix packages, redirect config * old nav class is now async and back * add getchatcolor.getbyid and handle patches with a . in them better Co-authored-by: tr7zw <tr7zw@live.de> Co-authored-by: Unknown <unknown@example.com> Co-authored-by: Ovydux <68059159+Ovydux@users.noreply.github.com> 2020-08-03 18:48:42 +02:00			`./yatopia full`
init 2020-02-26 17:23:57 +01:00			```
[ci-skip] readme stuff 2020-09-17 17:21:10 +02:00
			If you are repatching you need to delete `Yatopa-API` and `Yatopia-Server` folders.

[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`## Why are there not many API additions ##`
[ci-skip] readme stuff 2020-09-17 17:21:10 +02:00
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`(Modified from [starlis/empirecraft](https://github.com/starlis/empirecraft/))`
Update README.md 2020-09-04 17:39:35 +02:00			`<p>`
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`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.`
Update README.md 2020-09-04 17:39:35 +02:00
			`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.`

[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`This is a lot of politics that we don't have time in our lives to deal with.`

			`That being said we make light API additions when requested.`
			`</p>`
init 2020-02-26 17:23:57 +01:00
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`## LICENSE ##`
init 2020-02-26 17:23:57 +01:00
[ci-skip] fix 1.16.2 in 1.16.3 readme 2020-09-16 18:08:20 +02:00			`License information can be found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.3/Licensing/LICENSE.md).`
Update README.md 2020-08-25 22:21:01 +02:00
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`## SECURITY ##`
Update README.md 2020-08-25 22:21:01 +02:00
[ci-skip] fix 1.16.2 in 1.16.3 readme 2020-09-16 18:08:20 +02:00			`Security information can be found found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.3/SECURITY.md).`
[chi-skip] more readme updates 2020-09-17 18:27:38 +02:00
[ci-skip] add header 2020-09-17 21:21:08 +02:00			`##`
[chi-skip] more readme updates 2020-09-17 18:27:38 +02:00
[ci-skip] more readme improvements 2020-09-17 21:15:52 +02:00			`Made with <span style="color: #e25555;">♥</span> on Earth.`