From ff68b1830cc3b42f8051fcef259137fd97ed0edf Mon Sep 17 00:00:00 2001 From: Etil <81570777+etil2jz@users.noreply.github.com> Date: Fri, 22 Oct 2021 13:22:37 +0200 Subject: [PATCH] [ci skip] Rework README.md So people will stop saying bs. It is NOT intended to be used by everyone, consider it as a personal project. --- README.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e196ebd..bed82c2 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,18 @@

Mirai

A powerful Minecraft Server Software coming from the future

Mirai is ❗under heavy development❗ and contributions are welcome!

+
This project is experimental, its usage in production environment is discouraged if you are not ready to face possible bugs.
[![Actions](https://img.shields.io/github/workflow/status/etil2jz/Mirai/Build)](https://github.com/etil2jz/Mirai/actions) ## Features -- **30% faster hoppers** over Paper. -- **Improved entity performance** from a reduction in ticking entity behavior based on how far away they are from the player. -- **Reduced GC times & frequency** from removing useless allocations, which also improves CPU performance. -- **Reduced bandwidth consumption** from avoiding sending useless entity packets. -- **Fast raytracing** which improves performance of any entity which utilizes line of sight, mainly Villagers. -- **Built-in profiler** which has 0 performance hit and easy to read metrics for both server owners and developers. -- **Faster** crafting, reduction in uselessly loaded chunks, entity ticking, block ticking, bat spawning… +- **Based on [Airplane](https://github.com/TECHNOVE/Airplane)** +- **Reduced bandwidth consumption** from avoiding sending useless packets in certain situations. - **New NBT cache** which reduces a lot of I/O operations from the main thread while preserving correct data. - **Pre-tweaked** configuration files to reach optimal performance with minimal impact on normal behaviors. -- **IP and login location** hiding feature, which adds another security layer in the logs. +- **Login location** hiding feature, which adds another security layer in the logs. - **Removed metrics**, no one can collect data, not even us. - **Bugfixes** for several Minecraft issues. - **Safer methods** for Vanilla calls. @@ -27,19 +23,13 @@ ## Downloads The latest JAR file can be downloaded from the [GitHub CI](https://github.com/etil2jz/Mirai/raw/jdk-16/1.17/Mirai-1.17.1-R0.1-SNAPSHOT.jar). You can also clone this repository and build it yourself. -OpenJDK 17 builds are available [here](https://github.com/etil2jz/Mirai/raw/jdk-17/1.17/Mirai-1.17.1-R0.1-SNAPSHOT.jar). +**OpenJDK 17 builds are available [here](https://github.com/etil2jz/Mirai/raw/jdk-17/1.17/Mirai-1.17.1-R0.1-SNAPSHOT.jar).** If you are interested in making a fork, check out this template [there](https://github.com/PaperMC/paperweight-examples)! ## Building -If you want to avoid the patching system: - -```bash -./gradlew clean applyPatches && ./gradlew build -``` - -Otherwise, in order to distribute, you need a paperclip file: +In order to distribute and use this server software, you need a paperclip file: ```bash ./gradlew clean applyPatches && ./gradlew paperclipJar