Skip to content

docs: refresh README and testing guidance #28

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 1 commit into from
Oct 8, 2026
Merged

docs: refresh README and testing guidance #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 7 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,16 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/

## Tests

Install the pinned shared plugin dependencies, then run the build with Java 21:
With Java 21 and the [pinned shared dependencies](https://github.com/TF-Minecraft/Docs/blob/main/projects/MarketBlock/README.md#build-and-dependencies)
prepared, run `mvn clean verify`.

```sh
python3 path/to/TLibs/tools/install-plugins.py --pom pom.xml --mode pinned
mvn clean verify
```

Point the installer at your TLibs checkout.

Tests use JUnit, MockBukkit, and Mockito without a live Minecraft server. They
cover trade creation, purchases, menus, persistence, demand recovery, and the
Tests use JUnit 5, MockBukkit, and Mockito without a live Minecraft server. They
cover trade creation, sales, menus, persistence, demand recovery, and the
plugin lifecycle, including regressions for invalid quantities and stale state.
`mvn clean verify` enforces 100% runtime line coverage with no production-code
exclusions. JaCoCo's HTML and XML reports are written to `target/site/jacoco/`.
exclusions. JaCoCo's HTML and XML reports are written to `target/site/jacoco/`;
Surefire test results are in `target/surefire-reports/`. Live furniture, economy,
and food-freshness integrations still need server testing.

## License

Expand Down
Loading