Skip to content

docs: refresh README and testing guidance #22

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 #22

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c10e288
docs: refresh README and testing guidance
ryanbarlow97 Oct 8, 2026
6cb5b68
docs: correct contribution policy attribution
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
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,24 @@ This repository is TF-Minecraft's fork of CoreProtect, developed by [PlayPro](ht

CoreProtect supports both investigation and recovery; the recorded history available to staff depends on the server's logging settings.

Named ordinary items are marked as renamed; a display name alone does not prove
MMOItems or MythicMobs identity. These labels also apply to historical records
where the required metadata was saved. MythicLib and MythicMobs integrations are
optional, and the vanilla type remains the fallback. Existing material filters,
aggregate counts and rollback payloads keep their original meaning; custom-ID
search and custom mob restoration are not added by this change.
See [CONTRIBUTING.md](CONTRIBUTING.md) for the repository contribution policies.

## Documentation

[Project documentation](https://github.com/TF-Minecraft/Docs/blob/main/projects/CoreProtect/README.md)

Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/TF-Minecraft/Docs).

## Credits and license
## Tests

CoreProtect is an upstream [PlayPro project](https://github.com/PlayPro/CoreProtect), distributed under the [Artistic License 2.0](LICENSE). See [CONTRIBUTING.md](CONTRIBUTING.md) for its contribution policies.
Run `mvn clean verify` with Java 21 from `master`. JUnit and Mockito tests cover
custom item and mob labels, MythicMobs identity capture, metadata serialization,
and kill logging. Surefire writes reports to `target/surefire-reports/`, which
CI uploads. No coverage report or minimum coverage gate is configured.

The suite does not exercise a live Paper server, real provider plugins, database
servers, or end-to-end rollback and restore operations.

## License

CoreProtect is distributed under the [Artistic License 2.0](LICENSE).