Yatopia/README.md

55 lines
4.8 KiB
Markdown
Raw Normal View History

2020-08-01 18:14:57 +02:00
# Yatopia (formerly YAPFA)
[![Github-CI](https://github.com/tr7zw/Yatopia/workflows/CI/badge.svg)](https://github.com/tr7zw/Yatopia/actions?query=workflow%3ACI) [![CodeMC-CI](https://ci.codemc.io/job/Tr7zw/job/Yatopia/badge/icon?style=plastic)](https://ci.codemc.io/job/Tr7zw/job/YAPFA/)
[![Discord](https://img.shields.io/discord/342814924310970398?color=%237289DA&label=Discord&logo=discord&logoColor=white)](https://discordapp.com/invite/yk4caxM)
[![Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.herokuapp.com%2Ftr7zw%2Fpledges&style=for-the-badge)](https://www.patreon.com/tr7zw)
2020-03-23 22:42:28 +01:00
2020-02-26 17:23:57 +01:00
## What ##
2020-08-01 19:30:21 +02:00
This Fork tries to import universal/performance patches from [EMC](https://github.com/starlis/empirecraft), [Lithium](https://github.com/jellysquid3/lithium-fabric), [Akarin](https://github.com/Akarin-project/Akarin), [Papercut](https://github.com/Minevictus/Papercut/) and [Purpur](https://github.com/pl3xgaming/Purpur) while adding a few more (optional via config) "extreme" patches that modify the vanilla Minecraft gameplay for more performance (notable killing entity pushing/collision boxes). This fork was based on [Paper](https://github.com/PaperMC/Paper) but is now based on [Tuinity](https://github.com/Spottedleaf/Tuinity).
2020-02-26 17:23:57 +01:00
2020-06-19 22:25:02 +02:00
## Config entries
### disableEntityStuckChecks
2020-07-20 16:48:25 +02:00
``Default``: ``false`` Entities don't check if they are stuck in a wall and should suffocate. E.g useful in hubs where player damage is canceled anyway.
2020-06-19 22:25:02 +02:00
### disablePlayerOutOfWorldBorderCheck
2020-07-20 16:33:25 +02:00
``Default``: ``false`` Players don't check if they are outside of the world border (to take damage). Can be used everywhere where the world border doesn't apply anyway like hubs/minigames.
2020-06-19 22:25:02 +02:00
### disableEntityCollisions
2020-07-20 16:33:25 +02:00
``Default``: ``false`` All entities stop pushing each other. The only exception is that players still will be pushed since this is clientside and controlled by a scoreboard team flag. This also breaks the entity cramming (which players can bypass anyway with ladders). Greatly improves performance where entity pushing is not required.
2020-06-19 22:25:02 +02:00
### disableEntityCollisionboxes
2020-07-20 16:48:25 +02:00
``Default``: ``false`` Removes the collision box from entities. This only really affects shulker mobs (not shulker boxes) so that mobs will fall through them like any other mob. Players still can walk over them since that is clientside. Greatly improves performance, with minimal impact on in-game behavior.
2020-06-19 22:25:02 +02:00
2020-07-20 15:14:27 +02:00
### onlyPlayerCollisions
2020-07-20 16:33:25 +02:00
``Default``: ``false`` Does the same as ``disableEntityCollisions`` except that players are still able to push other entities.
2020-06-19 22:25:02 +02:00
2020-06-19 22:33:36 +02:00
### pistonPushLimit
2020-07-20 16:33:25 +02:00
``Default``: ``12`` Just a fun option that enables you to modify the maximum amount of blocks that a piston can push. Together with slime/honey blocks and pushable tiles from Tuinity this allows a lot of new machines/doors.
2020-06-19 22:33:36 +02:00
2020-07-20 15:14:27 +02:00
### itemStuckSleepTicks
2020-07-20 16:33:25 +02:00
``Default``: ``1`` Controls how often a dropped item checks rather it's stuck inside a block (their most expansive operation). Higher values like ``15`` can be safely used and greatly improves dropped item performance if your server has thousands of them (from big farms/TNT/farming players etc).
2020-07-20 15:14:27 +02:00
2020-06-19 22:33:36 +02:00
### villager.simplerVillagerBehavior
2020-07-20 16:48:25 +02:00
``Default``: ``false`` Replaces the entire villager AI to the old AI system that all other mobs use. This breaks iron farms/villager breeders/villages (WIP to fix these problems), all villagers get a random profession (if they didn't have one) like in 1.8, don't need nor use workstations and refresh their trades after some time (trades are completely unaffected). This makes villagers as performant as all the other mobs by getting rid of their "brain" (Mojang's name^^) and behavior controller system, instead using the normal goal selector system. This way villagers are over twice as performant, but with the drawbacks that for now Iron farms/villager breeders are broken, so they can just be used for trading systems.
2020-06-19 22:33:36 +02:00
### villager.villagersHideAtNight
2020-07-20 16:33:25 +02:00
``Default``: ``false`` Addon for ``villager.simplerVillagerBehavior``, gives villagers the ability to drink an invisibility potion like wandering traders at night to make it less likely for them to be killed since (for now) they don't stay at the village/use their houses at night and no ability for them to respawn.
2020-06-19 22:33:36 +02:00
2020-02-26 17:23:57 +01:00
## Building and setting up
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-07-16 00:30:41 +02:00
git submodule update --init --recursive --force
2020-07-15 21:09:04 +02:00
./yapfa jar
2020-02-26 17:23:57 +01:00
```
## LICENSE
2020-07-20 16:33:25 +02:00
Everything is licensed under the MIT license and is free to be used in your own fork.
2020-02-26 17:23:57 +01:00
2020-08-01 19:30:21 +02:00
See [EMC](https://github.com/starlis/empirecraft), [Lithium](https://github.com/jellysquid3/lithium-fabric), [Akarin](https://github.com/Akarin-project/Akarin), [Purpur](https://github.com/pl3xgaming/Purpur), [Papercut](https://github.com/Minevictus/Papercut/) and [Tuinity](https://github.com/Spottedleaf/Tuinity)
2020-02-26 17:23:57 +01:00
for the license of material used/modified by this project.
2020-07-20 15:31:00 +02:00
**To use this project you'll have to accept the Mojang EULA!**