Skip to content

Commit 520eecb

Browse files
authored
docs: refresh README and testing guidance (#38)
1 parent f474304 commit 520eecb

1 file changed

Lines changed: 4 additions & 23 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,6 @@ finished item.
2222
- **Profession progression** — connect recipes and materials to profession
2323
access and experience rewards.
2424

25-
## Staff equipment grants
26-
27-
`/ac give equipment <recipe> <ingredient.id|alloy.id> [player] [quality]`
28-
gives one finished item using a configured recipe and compatible main material.
29-
For example, `/ac give equipment heavy_chestplate ingredient.steel_ingot Alex 100`.
30-
Tab completion lists loaded recipes, compatible ingredients/alloys and online players.
31-
Omit the player to give to yourself; console must specify an online player.
32-
Quality defaults to 100 and accepts finite values from 0 to 100 (specify the player
33-
before quality). Alloy IDs are the loaded discovery IDs, not display names.
34-
35-
Secondary recipe ingredients use the lowest configured tier, then ingredient ID
36-
alphabetically to break ties. Their stats and appearance participate normally.
37-
The item retains normal stats, quality sockets, appearance, tier and crafting
38-
provenance; no materials are consumed and no XP or activity rewards are granted.
39-
Full inventories drop the item at the recipient's location.
40-
41-
Set `give-equipment-permission` in `config.yml` and run `/ac reload` to change
42-
access. Missing or blank settings default to `advancedcrafting.admin` (operators).
43-
Grant a custom permission only to staff; it does not grant other admin commands.
44-
4525
## Credits
4626

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

5535
## Tests and coverage
5636

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

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

0 commit comments

Comments
 (0)