Skip to content

Commit e38897e

Browse files
docs(readme): polish layout, badges, TOC, and copy
Add Java and CI shields, horizontal rule below hero, table of contents, clearer installation and requirements wording, simpler command table, sentence-case section titles, GitHub Issues link, build output note, and restore reacharound config migration note. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent a28a75b commit e38897e

1 file changed

Lines changed: 54 additions & 37 deletions

File tree

README.md

Lines changed: 54 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,30 @@
88

99
<p>
1010
<img src="https://img.shields.io/badge/Minecraft-Paper%20%7C%20Folia-orange" alt="Minecraft" />
11+
<img src="https://img.shields.io/badge/Java-21-ea9c1b?logo=openjdk&logoColor=white" alt="Java 21" />
12+
<img src="https://img.shields.io/github/actions/workflow/status/BuddySirJava/Mint/ci.yml?branch=main&label=CI" alt="CI" />
1113
<img src="https://img.shields.io/github/license/BuddySirJava/Mint?label=License&color=blue" alt="License" />
1214
</p>
1315

1416
</div>
1517

16-
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+
---
1719

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)
1831

1932
## Features
2033

21-
Mint ships 29 lightweight modules grouped by category:
34+
Modules are documented by category (config keys, permissions, and previews where available):
2235

2336
- [Building](docs/building.md)
2437
- [Farming](docs/farming.md)
@@ -30,61 +43,65 @@ Mint ships 29 lightweight modules grouped by category:
3043

3144
## Installation
3245

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.
3849

39-
**Soft Dependencies** PlaceholderAPI, WorldGuard, GriefPrevention, Towny, ProtocolLib and BentoBox
50+
**Requirements:** Paper or Folia **1.21.4+**, Java **21+**.
4051

41-
## Commands & Permissions
52+
**Soft dependencies (optional):** PlaceholderAPI, WorldGuard, GriefPrevention, Towny, ProtocolLib, BentoBox.
4253

54+
## Commands and permissions
4355

44-
| Command | Description | Permission |
45-
| ------------------------------------------ | ----------------------------------- | ---------------------------------------------------------- |
46-
| `/mint` | Open personal module GUI | `mint.gui` (Default: true) |
47-
| `/mint help` / `about` | Standard info commands | |
48-
| `/mint admin reload` | Reload configuration | `mint.admin`, `mint.reload` |
49-
| `/mint admin modules` | List all module states | `mint.admin` |
50-
| `/mint admin toggle <mod> [player]` | Toggle a module | `mint.toggle`; `mint.toggle.others` when `[player]` is set |
51-
| `/mint admin global <mod> <on/off>` | Globally toggle a module in config | `mint.admin.global` |
52-
| `/mint admin profile list` | List saved module presets | `mint.admin.profile` |
53-
| `/mint admin profile save <name> [player]` | Snapshot a player's enabled modules | `mint.admin.profile` |
54-
| `/mint admin profile load <name> [player]` | Apply a preset to a player | `mint.admin.profile` |
55-
| `/mint admin profile delete <name>` | Remove a preset from config | `mint.admin.profile` |
56-
| `/mint admin save` | Save config to disk | `mint.reload` |
56+
| Command | Description | Permission |
57+
| --- | --- | --- |
58+
| `/mint` | Open personal module GUI | `mint.gui` (default: true) |
59+
| `/mint help` / `about` | Show plugin info ||
60+
| `/mint admin reload` | Reload configuration | `mint.admin`, `mint.reload` |
61+
| `/mint admin modules` | List all module states | `mint.admin` |
62+
| `/mint admin toggle <mod> [player]` | Toggle a module | `mint.toggle`; `mint.toggle.others` when `[player]` is set |
63+
| `/mint admin global <mod> <on/off>` | Globally toggle a module in config | `mint.admin.global` |
64+
| `/mint admin profile list` | List saved module presets | `mint.admin.profile` |
65+
| `/mint admin profile save <name> [player]` | Snapshot a player's enabled modules | `mint.admin.profile` |
66+
| `/mint admin profile load <name> [player]` | Apply a preset to a player | `mint.admin.profile` |
67+
| `/mint admin profile delete <name>` | Remove a preset from config | `mint.admin.profile` |
68+
| `/mint admin save` | Save config to disk | `mint.reload` |
5769

70+
*Bypass protection checks in supported plugins with permission `mint.bypass.protection`.*
5871

59-
*Bypass region protections using `mint.bypass.protection`.*
72+
## Technical details
6073

61-
## Technical Details
74+
- **Storage:** YAML (default), H2, MySQL, MariaDB, MongoDB.
75+
- **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).
6280

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.
6982

70-
## Building from Source
83+
## Building from source
7184

7285
```bash
7386
git clone https://github.com/BuddySirJava/Mint.git
7487
cd Mint
7588
mvn clean package
7689
```
7790

78-
## License & Credits
91+
Build output is under `target/`.
92+
93+
## License and credits
94+
95+
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.
7996

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
8198

82-
## Support & Contributions
99+
Mint is free and open source. Feedback and real-world server use help the most.
83100

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)
102+
- **Contribute:** [CONTRIBUTING.md](CONTRIBUTING.md)
85103

86-
If you'd like to support development further:
104+
If you'd like to support development:
87105

88106
- **TON:** `UQCW9EFr3jexVjVvQm-njUV-oY6bVKq6e4rZbe1D4Hcmw0sX`
89-
- **Contribute:** See [CONTRIBUTING.md](CONTRIBUTING.md)
90107

0 commit comments

Comments
 (0)