Skip to content

docs: refresh README and testing guidance #38

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

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
27 changes: 4 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,6 @@ finished item.
- **Profession progression** — connect recipes and materials to profession
access and experience rewards.

## Staff equipment grants

`/ac give equipment <recipe> <ingredient.id|alloy.id> [player] [quality]`
gives one finished item using a configured recipe and compatible main material.
For example, `/ac give equipment heavy_chestplate ingredient.steel_ingot Alex 100`.
Tab completion lists loaded recipes, compatible ingredients/alloys and online players.
Omit the player to give to yourself; console must specify an online player.
Quality defaults to 100 and accepts finite values from 0 to 100 (specify the player
before quality). Alloy IDs are the loaded discovery IDs, not display names.

Secondary recipe ingredients use the lowest configured tier, then ingredient ID
alphabetically to break ties. Their stats and appearance participate normally.
The item retains normal stats, quality sockets, appearance, tier and crafting
provenance; no materials are consumed and no XP or activity rewards are granted.
Full inventories drop the item at the recipient's location.

Set `give-equipment-permission` in `config.yml` and run `/ac reload` to change
access. Missing or blank settings default to `advancedcrafting.admin` (operators).
Grant a custom permission only to staff; it does not grant other admin commands.

## Credits

Originally authored by **Drefvelin**.
Expand All @@ -54,8 +34,8 @@ Technical documentation is maintained in [TF-Minecraft/Docs](https://github.com/

## Tests and coverage

Use Java 21 and Maven 3.9. Install the pinned plugin dependencies with the
repository's existing `.github/scripts/prepare-release.sh` workflow, then run:
Use Java 21 and Maven, and prepare the shared and private dependencies in the
[build guide](https://github.com/TF-Minecraft/Docs/blob/main/projects/AdvancedCrafting/setup.md#build-from-source), then run:

```sh
mvn -B --no-transfer-progress clean verify -DskipTests=false -Dmaven.test.skip=false
Expand All @@ -65,7 +45,8 @@ The JUnit 5 suite uses MockBukkit for server state and Mockito at external plugi
boundaries. JaCoCo measures every production class; no production packages,
classes, or methods are excluded. `verify` requires **100% instruction, branch,
and line coverage**, and fails when any counter falls below that threshold.
The HTML report is `target/site/jacoco/index.html`; XML/CSV are alongside it.
Surefire test results are in `target/surefire-reports/`. The JaCoCo HTML report is
`target/site/jacoco/index.html`; XML/CSV are alongside it.
Build and release CI upload the coverage report as an artifact, including failed
runs when a report was generated.

Expand Down
Loading