diff --git a/README.md b/README.md index 7f45a00..1800745 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -DivineMC Face +DivineMC Face

DivineMC

@@ -10,29 +10,36 @@ [![Download](https://img.shields.io/github/downloads/DivineMC/DivineMC/total?&style=for-the-badge&logoColor=ffffff)](https://github.com/DivineMC/DivineMC/releases/latest)
-## Features +## ⚙️ Features -- **DivineMC is a fork of [Purpur](https://github.com/PurpurMC/Purpur)** designed for configurability, new fun and exciting gameplay features. -- **Contains [Lithium](https://github.com/CaffeineMC/lithium-fabric) patches** that optimizing many areas in game. -- **Implements** Linear region support. -- **Bug fixes** for several Minecraft issues. -- **Plugin compatibility** with Spigot & Paper plugins. +- **Based on [Purpur](https://github.com/PurpurMC/Purpur)** - Purpur is a fork of Paper with new fun and exciting gameplay features, and performance boost. +- **Popular mods implemented** - Patches from mods such as Lithium, VMP, C2ME and others. +- **Async Pathfinding** - Makes pathfinding-related work happen asynchronously (by [Petal](https://github.com/Bloom-host/Petal)). +- **[Linear region format](https://github.com/xymb-endcrystalme/LinearRegionFileFormatTools)** - Linear region format saves about 50% of disk space in Overworld and Nether and 95% in The End. +- **Configurable chat reports** - Disallow players from reporting others messages to Mojang. +- **Optimized Default Configuration** - The default configuration files is optimized. +- **Bug fixes** - Fixed Minecraft bugs that reported on Mojira. +- ... and more! -## Downloads +## ⬇️ Downloads In normal case, you can download the latest JAR file from releases tab [here](https://github.com/DivineMC/DivineMC/releases/latest) **Please note:** Java >= 17 is required. -## Building +## 📦 Building In order to distribute and use this server software, you need a paperclip file: ```bash ./gradlew applyPatches && ./gradlew createReobfPaperclipJar ``` -## License +## ⚖️ License Patches are licensed under GPL-3.0. All other files are licensed under MIT. -###### And we don't steal logo from YatopiaMC! [List of all forks](https://gist.github.com/SoSeDiK/1773ef2c239722f7083a25b2f78619ed) +## 📈 bStats + +[![bStats](https://bstats.org/signatures/server-implementation/DivineMC.svg)](https://bstats.org/plugin/server-implementation/DivineMC) + +###### We don't steal logo from YatopiaMC! [List of all forks](https://gist.github.com/NONPLAYT/48742353af8ae36bcef5d1c36de9730a) diff --git a/docs/docs/admin/configuration.md b/docs/docs/admin/configuration.md index e055f41..bad11e4 100644 --- a/docs/docs/admin/configuration.md +++ b/docs/docs/admin/configuration.md @@ -36,21 +36,41 @@ Global settings affect all worlds on the server as well as the core server funct - **description**: Sets whether the server should dump all configuration values to the server log on startup (this maybe not working) ### settings - - #### do-not-process-chat-commands - - **default**: true - - **description**: Commands will not be proceeded while the player is joining the server - - #### disable-chat-reports - - **default**: false - - **description**: Disables chat signing, which was introduced in version 1.19.1 (similar to No Chat Reports mod) - -### region-format - - #### linear - - ##### flush-frequency - - **default**: 10 - - **description**: Time in seconds after which chunks will be flushed - - ##### flush-max-threads - - **default**: 1 - - **description**: Maximum number of threads for flushing chunks +- #### disable-chat-reports + - **default**: false + - **description**: Disables chat signing, which was introduced in version 1.19.1 (similar to No Chat Reports mod) +- #### async-pathfinding + - ##### enable + - **default**: true + - **description**: Enables or disables async pathfinding feature + - ##### max-threads + - **default**: 0 + - **description**: Specifies how many threads to use for async pathfinding. If you specify 0, then the maximum amount will be calculated by itself using the formula: `availableProcessors / 4` + - ##### keepalive + - **default**: 60 + - **description**: The time during which inactive threads will remain in the pool until they are completed after downtime, specified in seconds. +- #### region-format + ##### linear + - ###### flush-frequency + - **default**: 10 + - **description**: Time in seconds after which chunks will be flushed + - ###### flush-max-threads + - **default**: 1 + - **description**: Maximum number of threads for flushing chunks +- #### do-not-process-chat-commands + - **default**: true + - **description**: Commands will not be proceeded while the player is joining the server +- #### optimizations + - ##### recipe-manager-optimization + - **default**: true + - **description**: Enables or disables optimization of recipe manager from the CarpetFixes mod. Optimized by taking out streams & doing extra early checks to quickly remove unrelated recipes + - ##### biome-manager-optimization + - **default**: true + - **description**: Enables or disables optimization of biomes from the CarpetFixes mod. Makes getBiome() method faster by 25% - 75% + - ##### sheep-optimization + - **default**: true + - **description**: Enables or disables optimization of sheep color choosing from the CarpetFixes mod. The game determines the child sheep's color by getting a wool block from the parents, putting them in a crafting +recipe, getting the output wool and getting the color from that. ## world-settings @@ -58,18 +78,6 @@ World settings are on a per-world basis. The child-node `default` is used for al For a more clear explanation of the world settings section of the config, feel free to read through Paper's explanation here: https://docs.papermc.io/paper/per-world-configuration -### region-format -- #### format - - **default**: ANVIL - - **description**: 2 types available: [ANVIL](https://minecraft.wiki/w/Anvil_file_format) and [LINEAR](https://github.com/xymb-endcrystalme/LinearRegionFileFormatTools?tab=readme-ov-file#linear-region-file-format-for-minecraft) -- #### linear - - ##### compression-level - - **default**: 1 - - **description**: Compression ratio of the region files - - ##### crash-on-broken-symlink - - **default**: true - - **description**: Server crashes if the symlink is broken/damaged - ### gameplay-mechanics - #### boat - ##### dont-eject-players-from-boat-underwater @@ -84,3 +92,19 @@ For a more clear explanation of the world settings section of the config, feel f - ##### despawn-bullets-on-player-death - **default**: true - **description**: If player is dead from shulker - bullets disappering for optimization + +- #### suppress-errors-from-dirty-attributes + - **default**: true + - **description**: + +- #### region-format + - ##### format + - **default**: ANVIL + - **description**: 2 types available: [ANVIL](https://minecraft.wiki/w/Anvil_file_format) and [LINEAR](https://github.com/xymb-endcrystalme/LinearRegionFileFormatTools?tab=readme-ov-file#linear-region-file-format-for-minecraft) + - ##### linear + - ###### compression-level + - **default**: 1 + - **description**: Compression ratio of the region files + - ###### crash-on-broken-symlink + - **default**: true + - **description**: Server crashes if the symlink is broken/damaged diff --git a/docs/docs/index.md b/docs/docs/index.md index d78c8f4..78a21eb 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -7,29 +7,36 @@ aside: false DivineMC is the fork of Purpur compatible with Spigot plugins, offering the best performance for your server. -## Features +## ⚙️ Features -- **DivineMC is a fork of [Purpur](https://github.com/PurpurMC/Purpur)** designed for configurability, new fun and exciting gameplay features. -- **Contains [Lithium](https://github.com/CaffeineMC/lithium-fabric) patches** that optimizing many areas in game. -- **Implements** Linear region support. -- **Bug fixes** for several Minecraft issues. -- **Plugin compatibility** with Spigot & Paper plugins. +- **Based on [Purpur](https://github.com/PurpurMC/Purpur)** - Purpur is a fork of Paper with new fun and exciting gameplay features, and performance boost. +- **Popular mods implemented** - Patches from mods such as Lithium, VMP, C2ME and others. +- **Async Pathfinding** - Makes pathfinding-related work happen asynchronously (by [Petal](https://github.com/Bloom-host/Petal)). +- **[Linear region format](https://github.com/xymb-endcrystalme/LinearRegionFileFormatTools)** - Linear region format saves about 50% of disk space in Overworld and Nether and 95% in The End. +- **Configurable chat reports** - Disallow players from reporting others messages to Mojang. +- **Optimized Default Configuration** - The default configuration files is optimized. +- **Bug fixes** - Fixed Minecraft bugs that reported on Mojira. +- ... and more! -## Downloads +## ⬇️ Downloads In normal case, you can download the latest JAR file from releases tab [here](https://github.com/DivineMC/DivineMC/releases/latest) **Please note:** Java >= 17 is required. -## Building +## 📦 Building In order to distribute and use this server software, you need a paperclip file: ```bash ./gradlew applyPatches && ./gradlew createReobfPaperclipJar ``` -## License +## ⚖️ License Patches are licensed under GPL-3.0. All other files are licensed under MIT. -###### [List of all forks](https://gist.github.com/SoSeDiK/1773ef2c239722f7083a25b2f78619ed) \ No newline at end of file +## 📈 bStats + +**TODO** + +###### [List of all forks](https://gist.github.com/SoSeDiK/1773ef2c239722f7083a25b2f78619ed) diff --git a/docs/index.md b/docs/index.md index c4852e1..feab52a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,23 +17,29 @@ hero: features: - icon: 🍴 - title: Fork of Purpur - details: DivineMC is the fork of Purpur compatible with Spigot plugins, offering the best performance for your server. + title: Based on Purpur + details: Purpur is a fork of Paper with new fun and exciting gameplay features, and performance boost. - icon: 📰 - title: Lithium patches - details: DivineMC contains Lithium patches that optimizing many areas in game. + title: Popular mods implemented + details: Patches from mods such as Lithium, VMP, C2ME and others. + - icon: 🐾 + title: Async Pathfinding + details: Makes pathfinding-related work happen asynchronously. - icon: 🏠 - title: Linear region support - details: DivineMC implements Linear region support that 50% smaller than Anvil. + title: Linear region format + details: Linear region format saves about 50% of disk space in Overworld and Nether and 95% in The End. + - icon: 💬 + title: Configurable chat reports + details: Disallow players from reporting others messages to Mojang. + - icon: 😌 + title: Optimized Default Configuration + details: The default configuration files is optimized. - icon: 🐛 title: Bug fixes - details: DivineMC have patches that fixes bugs for several Minecraft issues. - - icon: 🔌 - title: Plugin compatibility - details: DivineMC have full compatibility with Spigot & Paper plugins. + details: Fixed Minecraft bugs that reported on Mojira. - icon: 🔃 title: Always up-to date - details: DivineMC always updated to latest version of Purpur + details: DivineMC checks for updates from Purpur every day. ---