Skip to content

Commit fd12685

Browse files
ryanbarlow97claude
andauthored
docs: move planting configuration to Docs and add a Tests section (#63)
Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
1 parent 01298b4 commit fd12685

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,29 @@ Cooking makes food an interactive part of everyday life. Players grow and gather
1515

1616
## A complete food journey
1717

18-
Food crops need an open column above them. Cave ceilings and building roofs prevent vanilla and CustomCrops planting, including automatic replanting. Glass greenhouses are allowed by default. Nether wart, mushrooms, and the CustomCrops yeast crop can still be planted indoors.
19-
20-
The `planting` section of `crops.yml` controls `require-open-sky`, `allow-glass-roofs`, additional `allowed-cover` block materials, and `exempt-vanilla` / `exempt-custom` crop lists. Lists replace their defaults; an empty exemption list requires open sky for those crops too. Reload with `cooking reload`. Existing configs without this section use the defaults above. Adding a roof after planting does not remove existing crops or change their growth rules.
21-
22-
A harvest can become flour, dough, bread, or part of a cooked dish. Milk and meat enter their own preparation chains, and the result can be served through furniture as well as carried as food items. Cooking connects these activities into a shared system for farmers, cooks, and diners.
18+
Crops are planted outdoors under open sky or beneath the glass roof of a greenhouse. A harvest can become flour, dough, bread, or part of a cooked dish. Milk and meat enter their own preparation chains, and the result can be served through furniture as well as carried as food items. Cooking connects these activities into a shared system for farmers, cooks, and diners.
2319

2420
## Documentation
2521

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

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

26+
## Tests
27+
28+
With Java 21 and the pinned plugin dependencies installed (see the build workflow), run:
29+
30+
```sh
31+
mvn -B --no-transfer-progress clean verify
32+
```
33+
34+
The JUnit 5 suite covers food parsing and items, crops, husbandry, nutrition,
35+
fishing and configuration loading, using MockBukkit and Mockito where Bukkit or
36+
plugin APIs are involved. The Build and release workflows run the same command,
37+
and the Build workflow uploads the Surefire reports. No coverage gate is
38+
enforced. The tests do not replace checking kitchens, crops and livestock on a
39+
live Paper server with the pinned integrations.
40+
3041
## License
3142

3243
Copyright (c) 2026 TF-Minecraft contributors.

0 commit comments

Comments
 (0)