Yatopia/README.md

103 lines
5.0 KiB
Markdown
Raw Normal View History

<img width="200" src="https://yatopia.net/static/img/yatopia-shiny.gif" alt="Yatopia" align="right">
<div align="left">
<h1>Yatopia</h1>
2020-08-03 21:34:41 +02:00
[![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)
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)
<h3>Blazing fast <a href="https://github.com/Spottedleaf/Tuinity">Tuinity</a> fork with no-compromises performance.</h3>
2020-08-03 21:34:41 +02:00
</div>
2020-03-23 22:42:28 +01:00
## 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:
2020-02-26 17:23:57 +01:00
* [Akarin](https://github.com/Akarin-project/Akarin)
* [EMC](https://github.com/starlis/empirecraft)
* [Lithium](https://github.com/jellysquid3/lithium-fabric)
2020-08-06 05:07:50 +02:00
* [Origami](https://github.com/Minebench/Origami)
* [Purpur](https://github.com/pl3xgaming/Purpur)
2020-09-30 05:45:14 +02:00
* [Tic-TACS](https://github.com/gegy1000/tic-tacs/)
## 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).
## Documentation
2020-09-17 17:21:10 +02:00
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)!
2020-09-17 17:21:10 +02:00
## Contributors
2020-09-17 17:32:02 +02:00
[![](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)
2020-09-17 17:21:10 +02:00
2020-06-19 22:25:02 +02:00
## Building and setting up
2020-09-17 17:21:10 +02:00
2020-07-16 00:30:41 +02:00
Run the following commands in the root directory:
2020-02-26 17:23:57 +01:00
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
2020-02-26 17:23:57 +01:00
```
2020-09-17 17:21:10 +02:00
2020-10-19 04:33:55 +02:00
If you are repatching you need to delete `Yatopia-API` and `Yatopia-Server` folders.
2020-09-17 17:21:10 +02:00
## Using Yatopia-API
2020-09-17 21:26:13 +02:00
To build your plugin against the Yatopia-API, first add the CodeMC maven repository:
2020-09-17 21:26:13 +02:00
```xml
<repositories>
<!-- CodeMC -->
<repository>
<id>codemc-repo</id>
<url>https://repo.codemc.io/repository/maven-public/</url>
</repository>
</repositories>
```
And then add the Yatopia-API dependency:
```xml
<dependencies>
<dependency>
<groupId>net.yatopia</groupId>
<artifactId>yatopia-api</artifactId>
2020-09-17 21:28:55 +02:00
<version>1.16.3-R0.1-SNAPSHOT</version>
2020-09-17 21:26:13 +02:00
<scope>provided</scope>
</dependency>
</dependencies>
```
## Why aren't there many API additions?
2020-09-17 17:21:10 +02:00
2020-09-17 21:15:52 +02:00
(Modified from [starlis/empirecraft](https://github.com/starlis/empirecraft/))
2020-09-04 17:39:35 +02:00
<p>
2020-09-18 00:29:47 +02:00
APIs are tough to design. In 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.
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.
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>
2020-02-26 17:23:57 +01:00
## License
2020-02-26 17:23:57 +01:00
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).
2020-08-25 22:21:01 +02:00
## Security
2020-08-25 22:21:01 +02:00
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).
2020-09-17 18:27:38 +02:00
## Statistics
[![bStats Graph Data](https://bstats.org/signatures/server-implementation/Yatopia.svg)](https://bstats.org/plugin/server-implementation/Yatopia)
2020-09-17 18:27:38 +02:00
2020-09-17 21:15:52 +02:00
Made with <span style="color: #e25555;">&#9829;</span> on Earth.