Skip to content

docs: refresh README and testing guidance #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanbarlow97 merged 2 commits into from
Oct 8, 2026
Merged

docs: refresh README and testing guidance #40

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6371c56
docs: refresh README and testing guidance
ryanbarlow97 Oct 8, 2026
7fdef20
docs: clarify signed book appearance support
ryanbarlow97 Oct 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ These features give other TF-Minecraft plugins common building blocks while also
- **Personalized items** — lorestones add descriptive text and namestones change an item's name through an in-game prompt.
- **Animal whistles** — highlight nearby supported animals to help players locate them.
- **Shared gameplay rules** — custom drop handling and station interactions connect everyday world actions to server content.
- **Player utilities** — shared player commands and resource-pack delivery support everyday server use.
- **Book appearance** — optionally hides the default glint on signed books through ProtocolLib.
- **Cross-plugin statistics** — records supported vehicle, character, crafting, skill, and faction events for staff queries.

TFMC Core works alongside the server's specialist plugins, connecting their systems with the smaller details that make the roleplay world feel consistent.
Expand All @@ -30,9 +32,10 @@ mvn -B --no-transfer-progress clean verify
```

JUnit 5 and Mockito tests cover drops, statistics storage, stone and whistle
configuration, `/tfmc` commands, the Xaero fair-play listener and resource-pack
compaction and delivery, with server and plugin APIs mocked. CI runs the same
command on every push and pull request to `main` and uploads the Surefire reports;
configuration, player commands, signed-book appearance, the Xaero fair-play listener
and resource-pack compaction and delivery, with server and plugin APIs mocked.
Surefire writes test results to `target/surefire-reports/`. CI runs verification
on pushes and pull requests to `main` and uploads those reports;
JaCoCo writes HTML/XML to `target/site/jacoco/` and enforces 100% production
line coverage in `verify`, with no class or package exclusions. CI also uploads
coverage reports. The gate does not require 100% branch coverage. The suite does not start a live Paper server.
Expand Down
Loading