Files
MiraiMC/README.md
Etil ff68b1830c [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.
2021-10-22 13:22:37 +02:00

41 lines
1.9 KiB
Markdown

<img src="logo.webp" alt="Mirai Face" align="right">
<div align="center">
<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
- **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.
- **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.
- **Plugin compatibility** with Spigot & Paper plugins.
## 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).**
If you are interested in making a fork, check out this template [there](https://github.com/PaperMC/paperweight-examples)!
## Building
In order to distribute and use this server software, you need a paperclip file:
```bash
./gradlew clean applyPatches && ./gradlew paperclipJar
```
## License
Patches are licensed under GPL-3.0.
All other files are licensed under MIT.