Yatopia/README.md

103 lines
5.0 KiB
Markdown
Raw Normal View History

2020-12-02 16:55:51 +01:00
<img width="200" src="https://yatopiamc.org/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.4)](https://ci.codemc.io/job/YatopiaMC/job/Yatopia/job/ver%252F1.16.4/)
[![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.yatopiamc.org%2F)](https://api.yatopiamc.org/v2/latestBuild?branch=ver/1.16.4)
<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?
2020-11-07 12:35:44 +01:00
Yatopia combines the best patches from many [Paper](https://github.com/PaperMC/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)
* [AirplaneLite](https://github.com/Technove/AirplaneLite)
## Try it out
The latest stable builds of Yatopia are always available over at our [downloads page](https://yatopiamc.org/download.html). You can also download the latest development build [here](https://api.yatopiamc.org/v2/latestBuild/download?branch=ver/1.16.4).
## 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
Updated Upstream and Sidestream(s) (Tuinity/EMC/Purpur) (FIRST 1.16.4) Upstream/An Sidestream has released updates that appears to apply and compile correctly This update has NOT been tested by YatopiaMC and as with ANY update, please do your own testing. Tuinity Changes: d7f2b6e Updated Upstream (Paper) 0850468 Properly ignite entities that stand in fire 4ff2d15 More cleanup to delay chunk unloads 52f4d08 Cleanup post dev branch merge f2eef4a Fixup dev branch patches and store reverted patches in revert folder 85aba13 Merge branch 'dev/some-opts' c3a9e41 Remove deprecated function usage in github actions (#200) dde7028 Merge branch 'master' into dev/some-opts 083e162 Updated Upstream (Paper) - Update to 1.16.4 576e2cc Rate limit incoming packets 7f251e0 Updated Upstream (Paper) 7d45836 Updated Upstream (Paper) cff9ec0 Updated Upstream (Paper) c3d5d24 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 c12d582 Merge branch 'master' into dev/some-opts cbffdcc Do not mark entities in unloaded chunks as being in blocks 988e550 Updated Upstream (Paper) 84aecdb Merge https://github.com/Spottedleaf/Tuinity into ver/1.16.3 f7b8e25 Split dev branch 3200930 Merge branch 'master' into dev/some-opts 82e5dfb Updated Upstream (Paper) d41103d Updated Upstream (Paper) 1d73f6c Updated Upstream (Paper) 8ba1bab Updated Upstream (Paper) ac6b72e Updated Upstream (Paper) 8d982c4 Updated Upstream (Paper) 2c7bad9 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 903f580 Merge remote-tracking branch 'origin/dev/some-opts' into dev/some-opts 0179ea8 Re-Add region manager and notify patch 6886867 Merge branch 'master' into dev/some-opts fb292c1 Updated Upstream (Paper) 442890b Fix decompression with Velocity natives (#191) 57fed71 Fix decompression with Velocity natives 102d60b Rebuild patches 968512b Add Velocity natives for encryption and compression (#188) e2dcdd1 Correct return value for ChunkCache#getCubes 4a99f3e Updated Upstream (Paper) f5d537e Merge https://github.com/Spottedleaf/Tuinity into ver/1.16.3 784b838 Some fixes be0b91f Merge branch 'master' into dev/some-opts 2cb36ca Optimise non-flush packet sending be68938 Hey git, may I know what happened here? 1cac0a2 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 d72e062 Merge branch 'master' into dev/some-opts 76777f0 Updated Upstream (Paper) 6465aba Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 d82174a Merge branch 'master' into dev/some-opts 460581d Fix getClosestEntity not working d39cda0 Updated Upstream (Paper) 2110847 Rewrite getClosestEntity 3e45700 Do not return complex parts for entity by class lookup c9cfdba Updated Upstream (Paper) 5994cb0 Updated Upstream (Paper) 7dfe18c Merge https://github.com/Spottedleaf/Tuinity into ver/1.16.3 363973d Merge branch 'master' into dev/some-opts 1c05858 Updated Upstream (Paper) adaafb4 Git merge doesn't update submodules ab71ded Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 54db338 Merge branch 'master' into dev/some-opts 483289c Updated Upstream (Paper) e36359e Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.2 ef8cd34 Fix NPE b770af9 Merge branch 'master' into dev/some-opts d479e12 Merge https://github.com/Spottedleaf/Tuinity into ver/1.16.2 a1b90f8 Merge branch 'master' into dev/some-opts 30c5ca5 Merge branch 'master' into dev/some-opts e59b60b Updated Upstream (Paper) 09f62a7 Rebuild patches b041d11 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.2 27fca2d Merge branch 'master' into dev/some-opts a218f5d Updated Upstream (Paper) f7c5428 Updated Upstream (Paper) a17dc2c Attempt to fix incorrect nearest village distance tracker updating 8830cef Remove streams for poi searching in some zombie pathfinding 89276ac Fix villagers aggressively looking at people db64f14 Make sure to despawn entities if they are outside the player general area range ba0bfda Updated Upstream (Paper) 200f825 Actually unload POI data 3dc7b9e Updated Upstream (Paper) 30f6ca0 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 3b008f5 Optimisations c628aa4 Updated Upstream (Paper) 1ed41fc Updated Upstream (Paper) 193d9bf Updated Upstream (Paper) f2ac649 Updated Upstream (Paper) a63298f Upstream a12e1f6 Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 9eed723 Rebuild patches d03dbcc Updated paper c1002c5 Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 27084eb Updated paper bfb0ded Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 763aa6c Updated Upstream (Paper) 49898d0 Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 199edf5 Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 78bfcfb Update everything bbbe82e change upstream EMC Changes: 4da58340 clear more entity tasks with reloads 2f3d567f Improve temp meta reloading efd7ea89 Updated Paper 25426b02 Updated Paper 35099319 Fix blockbreaknaturally event not always having the loc stored Purpur Changes: 306e9ac Add missing repos for deps 67be68c Updated Upstream (Tuinity) cf3e3e7 Fix last patch :3 a43bb36 Arrows should not reset despawn counter f0b8bd7 Updated Upstream (Paper) f15d3f0 Updated Upstream (Tuinity) 39ce110 Fix missed obf method rename in Tuinity patches bae5baa Updated Upstream (Paper) 5569d02 Updated Upstream (Paper) 72c4c5e Updated Upstream (Paper) 7fa8baf Update readme 03654a6 Update to 1.16.4 ^_^ 0fa478d Updated Upstream (Paper & Tuinity) 3fec5da Rebuild patches 2f7a0a0 Fix client lag on advancement loading 3f325b8 Fix #86 Move pathfinders into NMS package to satisfy Paper's AI API 7cfd3d7 Updated Upstream (Paper) cc6c167 Updated Upstream (Paper)
2020-11-07 08:02:33 +01:00
./yatopia init
[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>org.yatopiamc</groupId>
2020-09-17 21:26:13 +02:00
<artifactId>yatopia-api</artifactId>
Updated Upstream and Sidestream(s) (Tuinity/EMC/Purpur) (FIRST 1.16.4) Upstream/An Sidestream has released updates that appears to apply and compile correctly This update has NOT been tested by YatopiaMC and as with ANY update, please do your own testing. Tuinity Changes: d7f2b6e Updated Upstream (Paper) 0850468 Properly ignite entities that stand in fire 4ff2d15 More cleanup to delay chunk unloads 52f4d08 Cleanup post dev branch merge f2eef4a Fixup dev branch patches and store reverted patches in revert folder 85aba13 Merge branch 'dev/some-opts' c3a9e41 Remove deprecated function usage in github actions (#200) dde7028 Merge branch 'master' into dev/some-opts 083e162 Updated Upstream (Paper) - Update to 1.16.4 576e2cc Rate limit incoming packets 7f251e0 Updated Upstream (Paper) 7d45836 Updated Upstream (Paper) cff9ec0 Updated Upstream (Paper) c3d5d24 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 c12d582 Merge branch 'master' into dev/some-opts cbffdcc Do not mark entities in unloaded chunks as being in blocks 988e550 Updated Upstream (Paper) 84aecdb Merge https://github.com/Spottedleaf/Tuinity into ver/1.16.3 f7b8e25 Split dev branch 3200930 Merge branch 'master' into dev/some-opts 82e5dfb Updated Upstream (Paper) d41103d Updated Upstream (Paper) 1d73f6c Updated Upstream (Paper) 8ba1bab Updated Upstream (Paper) ac6b72e Updated Upstream (Paper) 8d982c4 Updated Upstream (Paper) 2c7bad9 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 903f580 Merge remote-tracking branch 'origin/dev/some-opts' into dev/some-opts 0179ea8 Re-Add region manager and notify patch 6886867 Merge branch 'master' into dev/some-opts fb292c1 Updated Upstream (Paper) 442890b Fix decompression with Velocity natives (#191) 57fed71 Fix decompression with Velocity natives 102d60b Rebuild patches 968512b Add Velocity natives for encryption and compression (#188) e2dcdd1 Correct return value for ChunkCache#getCubes 4a99f3e Updated Upstream (Paper) f5d537e Merge https://github.com/Spottedleaf/Tuinity into ver/1.16.3 784b838 Some fixes be0b91f Merge branch 'master' into dev/some-opts 2cb36ca Optimise non-flush packet sending be68938 Hey git, may I know what happened here? 1cac0a2 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 d72e062 Merge branch 'master' into dev/some-opts 76777f0 Updated Upstream (Paper) 6465aba Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 d82174a Merge branch 'master' into dev/some-opts 460581d Fix getClosestEntity not working d39cda0 Updated Upstream (Paper) 2110847 Rewrite getClosestEntity 3e45700 Do not return complex parts for entity by class lookup c9cfdba Updated Upstream (Paper) 5994cb0 Updated Upstream (Paper) 7dfe18c Merge https://github.com/Spottedleaf/Tuinity into ver/1.16.3 363973d Merge branch 'master' into dev/some-opts 1c05858 Updated Upstream (Paper) adaafb4 Git merge doesn't update submodules ab71ded Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.3 54db338 Merge branch 'master' into dev/some-opts 483289c Updated Upstream (Paper) e36359e Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.2 ef8cd34 Fix NPE b770af9 Merge branch 'master' into dev/some-opts d479e12 Merge https://github.com/Spottedleaf/Tuinity into ver/1.16.2 a1b90f8 Merge branch 'master' into dev/some-opts 30c5ca5 Merge branch 'master' into dev/some-opts e59b60b Updated Upstream (Paper) 09f62a7 Rebuild patches b041d11 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into ver/1.16.2 27fca2d Merge branch 'master' into dev/some-opts a218f5d Updated Upstream (Paper) f7c5428 Updated Upstream (Paper) a17dc2c Attempt to fix incorrect nearest village distance tracker updating 8830cef Remove streams for poi searching in some zombie pathfinding 89276ac Fix villagers aggressively looking at people db64f14 Make sure to despawn entities if they are outside the player general area range ba0bfda Updated Upstream (Paper) 200f825 Actually unload POI data 3dc7b9e Updated Upstream (Paper) 30f6ca0 Merge branch 'master' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 3b008f5 Optimisations c628aa4 Updated Upstream (Paper) 1ed41fc Updated Upstream (Paper) 193d9bf Updated Upstream (Paper) f2ac649 Updated Upstream (Paper) a63298f Upstream a12e1f6 Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 9eed723 Rebuild patches d03dbcc Updated paper c1002c5 Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 27084eb Updated paper bfb0ded Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 763aa6c Updated Upstream (Paper) 49898d0 Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 199edf5 Merge branch 'ver/1.16.2' of https://github.com/Spottedleaf/Tuinity into 1.16.2tmp 78bfcfb Update everything bbbe82e change upstream EMC Changes: 4da58340 clear more entity tasks with reloads 2f3d567f Improve temp meta reloading efd7ea89 Updated Paper 25426b02 Updated Paper 35099319 Fix blockbreaknaturally event not always having the loc stored Purpur Changes: 306e9ac Add missing repos for deps 67be68c Updated Upstream (Tuinity) cf3e3e7 Fix last patch :3 a43bb36 Arrows should not reset despawn counter f0b8bd7 Updated Upstream (Paper) f15d3f0 Updated Upstream (Tuinity) 39ce110 Fix missed obf method rename in Tuinity patches bae5baa Updated Upstream (Paper) 5569d02 Updated Upstream (Paper) 72c4c5e Updated Upstream (Paper) 7fa8baf Update readme 03654a6 Update to 1.16.4 ^_^ 0fa478d Updated Upstream (Paper & Tuinity) 3fec5da Rebuild patches 2f7a0a0 Fix client lag on advancement loading 3f325b8 Fix #86 Move pathfinders into NMS package to satisfy Paper's AI API 7cfd3d7 Updated Upstream (Paper) cc6c167 Updated Upstream (Paper)
2020-11-07 08:02:33 +01:00
<version>1.16.4-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
License information can be found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.4/Licensing/LICENSE.md).
2020-08-25 22:21:01 +02:00
## Security
2020-08-25 22:21:01 +02:00
Security information can be found found [here](https://github.com/YatopiaMC/Yatopia/blob/ver/1.16.4/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.