Repo-Mirror/MiraiMC
9
0
Fork 0
Code Issues Pull Requests Releases Activity

[ci skip] Rework README.md

Browse Source 
So people will stop saying bs.
It is NOT intended to be used by everyone, consider it as a personal project.
This commit is contained in:
Etil
2021-10-22 13:22:37 +02:00
committed by GitHub
parent fe314156e5
commit ff68b1830c
1 changed files with 6 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -3,22 +3,18 @@
<h1>Mirai</h1>
<h3>A powerful Minecraft Server Software coming from the future</h3>
<h4>Mirai is ❗under heavy development❗ and contributions are welcome!</h4>
<h5><b>This project is experimental, its usage in production environment is discouraged if you are not ready to face possible bugs.</b></h5>
[![Actions](https://img.shields.io/github/workflow/status/etil2jz/Mirai/Build)](https://github.com/etil2jz/Mirai/actions)
</div>
## 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