You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Mint ships **29** lightweight, vanilla-friendly gameplay modules. Each one can be toggled per-player, integrates with common protection plugins, supports multiple storage backends, and requires no client mods.
18
+
---
17
19
20
+
**Mint** adds **29** lightweight, vanilla-friendly gameplay modules for **Paper** and **Folia**. Modules can be toggled per player, work with common protection plugins, support several storage backends, and require **no client mods**.
21
+
22
+
## Table of contents
23
+
24
+
-[Features](#features)
25
+
-[Installation](#installation)
26
+
-[Commands and permissions](#commands-and-permissions)
27
+
-[Technical details](#technical-details)
28
+
-[Building from source](#building-from-source)
29
+
-[License and credits](#license-and-credits)
30
+
-[Support and contributions](#support-and-contributions)
18
31
19
32
## Features
20
33
21
-
Mint ships 29 lightweight modules grouped by category:
34
+
Modules are documented by category (config keys, permissions, and previews where available):
22
35
23
36
-[Building](docs/building.md)
24
37
-[Farming](docs/farming.md)
@@ -30,61 +43,65 @@ Mint ships 29 lightweight modules grouped by category:
30
43
31
44
## Installation
32
45
33
-
1. Download the latest releases from [Releases](https://github.com/BuddySirJava/Mint/releases).
34
-
2. Drop it into your `plugins/` folder and restart.
35
-
3. Configure settings via `plugins/Mint/config.yml`.
36
-
37
-
**Requirements:** Paper/Folia 1.21.4+ Java 21+.
46
+
1. Download the latest JAR from [Releases](https://github.com/BuddySirJava/Mint/releases).
47
+
2. Place it in your server's `plugins/` directory and restart.
48
+
3. Adjust settings in `plugins/Mint/config.yml` as needed.
38
49
39
-
**Soft Dependencies**PlaceholderAPI, WorldGuard, GriefPrevention, Towny, ProtocolLib and BentoBox
50
+
**Requirements:**Paper or Folia **1.21.4+**, Java **21+**.
-**Performance:** Folia-aware scheduling; async access guarded for region-thread safety.
76
+
-**Protection:** Uses WorldGuard, GriefPrevention, Towny, and BentoBox rules when present.
77
+
-**Customization:** GUI and messages via `gui.yml` and `lang.yml` (MiniMessage).
78
+
-**PlaceholderAPI:**`%mint_modules_total%` (personal module count), `%mint_modules_server_total%`, `%mint_modules_enabled_count%` (enabled for the player). `%mint_module_<key>%` reflects per-player state for personal modules and config for server-wide modules; `%mint_global_<key>%` always reflects config.
79
+
-**Tests:**`mvn test` runs the suite (includes Folia compatibility checks).
62
80
63
-
-**Storage:** Supports YAML (default), H2, MySQL, MariaDB, and MongoDB.
64
-
-**Performance:** Folia-aware scheduling; async access is guarded for region-thread safety.
65
-
-**Protection:** Respects WorldGuard, GriefPrevention, Towny, and BentoBox build rules when those plugins are present.
66
-
-**Customization:** Full GUI and message customization via `gui.yml` and `lang.yml` (MiniMessage supported).
67
-
-**PlaceholderAPI:**`%mint_modules_total%` (personal modules count), `%mint_modules_server_total%`, `%mint_modules_enabled_count%` (personal enabled for the player). `%mint_module_<key>%` uses per-player state for personal modules and config-only for server-wide modules (`%mint_global_<key>%` always reflects config).
68
-
-**Tests:**`mvn test` runs unit tests (including Folia compatibility guards).
81
+
**Config migration:** Reacharound Placement still reads the legacy `modules.bedrock-bridging.enabled` key when `modules.reacharound-placement.enabled` is omitted, so older configs keep working.
Licensed under [AGPL-3.0](LICENSE). Inspired by the [Quark](https://quarkmod.net/) mod by Vazkii and [V-Tweaks](https://mods.oitsjustjose.com/V-Tweaks/) by oitsjustjose.
79
96
80
-
Licensed under [AGPL-3.0](LICENSE). Inspired by the [Quark mod](https://quarkmod.net/) by Vazkii and [V-Tweaks](https://mods.oitsjustjose.com/V-Tweaks/) by oitsjustjose.
97
+
## Support and contributions
81
98
82
-
## Support & Contributions
99
+
Mint is free and open source. Feedback and real-world server use help the most.
83
100
84
-
Mint is, and always will be, free and open-source. My goal is to solve long-standing server limitations that the community has dealt with for years. Simply using the plugin and providing feedback is the best support I could ask for! ❤️
101
+
-**Issues and feature ideas:**[GitHub Issues](https://github.com/BuddySirJava/Mint/issues)
0 commit comments