diff --git a/README.md b/README.md index 0a79714..11fb2fd 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,28 @@ [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/BX-Team/DivineMC/build-1217.yml?logo=GoogleAnalytics&logoColor=ffffff&style=for-the-badge)](https://github.com/BX-Team/DivineMC/actions) [![Discord](https://img.shields.io/discord/931595732752953375?color=5865F2&label=discord&style=for-the-badge)](https://discord.gg/qNyybSSPm5) -DivineMC is a high-performance [Purpur](https://github.com/PurpurMC/Purpur) fork focused on maximizing server performance while maintaining plugin compatibility. - +DivineMC is a multi-functional fork of [Purpur](https://github.com/PurpurMC/Purpur), which focuses on the flexibility of your server and its optimization -> [!WARNING] -> DivineMC is a performance-oriented fork. Make sure to take backups **before** switching to it. We also welcome a new contributor to help us improve the fork. - ## ⚙️ Features -- **Based on [Purpur](https://github.com/PurpurMC/Purpur)** that adds a high customization level to the server. -- **Regionized Chunk Ticking** feature that allows to tick chunks in parallel, similar to how Folia does it. -- Implemented **Parallel world ticking** feature, that allows to server take advantage of multiple CPU cores to tick worlds. -- Implemented **Secure Seed** mod that changes default 64-bit seed to a 1024-bit seed, making it almost impossible to crack the seed. -- **Optimized chunk generation** that can generate chunks up to 70% faster than vanilla. -- **Async** pathfinding, entity tracker, mob spawning and chunk sending. -- Implemented **Linear region file format** -- **Fully compatible** with Bukkit, Spigot and Paper plugins -- **Fixes** some Minecraft bugs -- Integrated with [Sentry](https://sentry.io/welcome/) to easy track all errors coming from your server in excruciating detail (original by [Pufferfish](https://github.com/pufferfish-gg/Pufferfish)) -- and more... + +### 🚀 Core Performance +- **Based on [Purpur](https://github.com/PurpurMC/Purpur)** - Adds a high customization level to your server +- **Regionized Chunk Ticking** - Tick chunks in parallel, similar to how Folia does it +- **Parallel World Ticking** - Leverage multiple CPU cores for world processing +- **Async Operations** - Pathfinding, entity tracker, mob spawning, joining and chunk sending + +### 🔧 Advanced Features +- **Secure Seed** - Enhanced 1024-bit seed system (vs standard 64-bit) for maximum security +- **Linear Region File Format** - Optimize your world with the old V1/V2 linear format and the new Buffered format +- **Mod Protocols Support** - Compatible with Syncmatica, Apple Skin, Jade and Xaero's Map + +### 🔌 Compatibility & Reliability +- **Fully Compatible** - Works seamlessly with Bukkit, Spigot and Paper plugins +- **Bug Fixes** - Resolves various Minecraft issues (~10) +- **Sentry Integration** - Detailed error tracking and monitoring (original by [Pufferfish](https://github.com/pufferfish-gg/Pufferfish)) + +*...and much more!* ## 📥 Downloading & Installing If you want to install DivineMC, you can read our [installation documentation](https://bxteam.org/docs/divinemc/getting-started/installation). @@ -81,21 +84,19 @@ We also have a [Javadoc](https://repo.bxteam.org/javadoc/snapshots/org/bxteam/di DivineMC is licensed under the GNU General Public License v3.0. You can find the license [here](LICENSE). ## 📜 Credits -DivineMC includes patches from other forks, and without these forks, DivineMC wouldn't exist today. Here are the list of these forks: +DivineMC includes patches from other projects, and without these projects, DivineMC wouldn't exist today. Here is a small list of projects that DivineMC takes patches from: - [Purpur](https://github.com/PurpurMC/Purpur) --
- 📜 Expand to see forks that DivineMC takes patches from. -

- • Petal
- • Carpet Fixes
- • Parchment
- • Leaves
- • SparklyPaper
- • Matter
- • Canvas
- • Leaf
-

-
+- [Petal](https://github.com/Bloom-host/Petal) +- [carpet-fixes](https://github.com/fxmorin/carpet-fixes) +- [Parchment](https://github.com/ProjectEdenGG/Parchment) +- [Leaves](https://github.com/LeavesMC/Leaves) +- [SparklyPaper](https://github.com/SparklyPower/SparklyPaper) +- [matter](https://github.com/plasmoapp/matter) +- [Leaf](https://github.com/Winds-Studio/Leaf) +- [C2ME](https://github.com/RelativityMC/C2ME-fabric) +- [VMP](https://github.com/RelativityMC/VMP-fabric) +- [EntityCulling](https://github.com/tr7zw/EntityCulling) +- ... and others If you want to know more about other forks and see other Minecraft projects, you can go to our [list of different Minecraft server Software](https://gist.github.com/NONPLAYT/48742353af8ae36bcef5d1c36de9730a).