Skip to content

Commit 91e3e2d

Browse files
authored
Merge pull request #2 from jamjet3/main
Update README.md
2 parents f2bb691 + 9a5cd78 commit 91e3e2d

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Modern, transparent community voting for PaperMC 1.21.x**
44

5-
A privacy‑first, lightweight, and production‑ready **yes/no voting plugin** for Minecraft servers designed for modern communities that value fairness, trust, and data integrity.
5+
A privacy‑first, lightweight, and production‑ready **yes/no voting plugin** for Minecraft servers - designed for modern communities that value fairness, trust, and data integrity.
66

77
ModNVote is built by [**MODN METL LTD**](https://modnmetl.com) and open‑sourced to promote transparent community decision‑making.
88

@@ -16,7 +16,7 @@ ModNVote is built by [**MODN METL LTD**](https://modnmetl.com) and open‑source
1616

1717
## ✨ Features (v1.1.5)
1818

19-
- **GUI voting** `/modnvote` opens a simple Yes/No GUI; players click to vote, in total privacy.
19+
- **GUI voting** - `/modnvote` opens a simple Yes/No GUI; players click to vote, in total privacy.
2020
- **Single vote per player** (per round) using UUID.
2121
- **IP‑based duplicate prevention** with configurable bypass permission.
2222
- **Cryptographic integrity seal** over:
@@ -32,12 +32,12 @@ ModNVote is built by [**MODN METL LTD**](https://modnmetl.com) and open‑source
3232
- `/modnvote status` reports YES/NO counts **and** whether the tally currently has a valid integrity seal.
3333
- It also tells the viewer whether *their* own vote is included in the tally.
3434
- **Admin audit tools**:
35-
- `/modnvote audit` quick summary of total voters, bypass voters, and tallies.
36-
- `/modnvote fullaudit` groups voters by IP to highlight clusters and potential alts (does not reveal how they voted).
37-
- `/modnvote reset` admin command to clear all votes and reset the integrity seal.
38-
- **Config‑driven messaging** all player‑facing messages live in `config.yml`.
39-
- **SQLite persistence** votes survive restarts.
40-
- **PlaceholderAPI support** expose YES/NO counts and percentages for scoreboards, sidebars, etc.
35+
- `/modnvote audit` - quick summary of total voters, bypass voters, and tallies.
36+
- `/modnvote fullaudit` - groups voters by IP to highlight clusters and potential alts (does not reveal how they voted).
37+
- `/modnvote reset` - admin command to clear all votes and reset the integrity seal.
38+
- **Config‑driven messaging** - all player‑facing messages live in `config.yml`.
39+
- **SQLite persistence** - votes survive restarts.
40+
- **PlaceholderAPI support** - expose YES/NO counts and percentages for scoreboards, sidebars, etc.
4141
- Built for **Paper 1.21.x** and Java 21.
4242

4343
> ModNVote is the spiritual successor to the older PineVote plugin, rebuilt for broader use under the MODN METL brand.
@@ -48,8 +48,8 @@ ModNVote is built by [**MODN METL LTD**](https://modnmetl.com) and open‑source
4848

4949
ModNVote is designed around two principles:
5050

51-
1. **Privacy** make it difficult for anyone (including staff) to link a player to a specific vote via logs alone.
52-
2. **Integrity** make it easy to detect if someone has quietly tampered with vote data.
51+
1. **Privacy** - make it difficult for anyone (including staff) to link a player to a specific vote via logs alone.
52+
2. **Integrity** - make it easy to detect if someone has quietly tampered with vote data.
5353

5454
### How privacy is protected
5555

@@ -140,7 +140,7 @@ modnvote.bypass – allow voting even if someone on the same IP has alr
140140

141141
By default, only OPs get the `modnvote.admin.*` permissions. Regular players typically get `modnvote.use`, `modnvote.vote`, and `modnvote.status`.
142142

143-
The bypass node is configurable in `config.yml` you can keep `modnvote.bypass` or point it at an existing alt‑account / VPN‑detection plugin’s bypass node.
143+
The bypass node is configurable in `config.yml` - you can keep `modnvote.bypass` or point it at an existing alt‑account / VPN‑detection plugin’s bypass node.
144144

145145
---
146146

@@ -166,16 +166,16 @@ These are backed by the same cached tallies used in `/modnvote status` and are s
166166

167167
On first run, ModNVote generates a `config.yml` with sections for:
168168

169-
- `messages.*` all player‑facing messages, including:
169+
- `messages.*` - all player‑facing messages, including:
170170
- voted_yes, voted_no
171171
- already_voted, duplicate_ip
172172
- reset_done, reloaded
173173
- audit and fullaudit texts
174174
- verify_valid / verify_invalid summaries
175-
- `cache.refresh_seconds` how often to refresh tally caches asynchronously.
176-
- `logging.*` whether to log votes and bypass usage to console (these avoid logging which option was chosen).
177-
- `permissions.bypass_node` the permission string treated as a bypass flag.
178-
- `integrity.pepper_file_pattern` where per‑round secret keys are stored on disk.
175+
- `cache.refresh_seconds` - how often to refresh tally caches asynchronously.
176+
- `logging.*` - whether to log votes and bypass usage to console (these avoid logging which option was chosen).
177+
- `permissions.bypass_node` - the permission string treated as a bypass flag.
178+
- `integrity.pepper_file_pattern` - where per‑round secret keys are stored on disk.
179179

180180
You are encouraged to customise messages to match your server’s tone.
181181

@@ -200,7 +200,7 @@ You are encouraged to customise messages to match your server’s tone.
200200
- Optional player‑visible confirmation tokens (for external audits)
201201
- REST / webhook hooks for dashboards or external tooling
202202

203-
Suggestions are welcome open an issue or discussion on GitHub.
203+
Suggestions are welcome - open an issue or discussion on GitHub.
204204

205205
---
206206

@@ -229,7 +229,7 @@ If you discover a vulnerability or serious integrity issue:
229229

230230
## 📜 License
231231

232-
This project is licensed under the **MIT License** see the [LICENSE](./LICENSE) file for details.
232+
This project is licensed under the **MIT License** - see the [LICENSE](./LICENSE) file for details.
233233

234234
```text
235235
Copyright (c) 2025 MODN METL LTD
@@ -245,5 +245,5 @@ Developed by Jamie E. Thompson (@jamjet3)
245245
- **Community Testing:** Pinecraft Equestrian SMP
246246
- **Build System:** Gradle (Java 21, PaperMC 1.21.x)
247247

248-
> “Trust, but verify.” The guiding principle behind **ModNVote**.
249-
> Built to help communities make fair, transparent decisions the modern way.
248+
> “Trust, but verify.” - The guiding principle behind **ModNVote**.
249+
> Built to help communities make fair, transparent decisions - the modern way.

0 commit comments

Comments
 (0)