Files
rivencraft/docs/DESERT_VEGETATION.md
T
2026-11-17 18:12:07 -05:00

105 lines
5.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Desert vegetation Pages — issue #108
Applies to Minecraft 1.21.1 and 26.3. Local test builds: **1.21.1.0.4** and
**26.3.0.7**. Minecraft 1.21.1 (including BOP Dryland) passed player validation. The 26.3
Flat soil correction awaits player retest; not committed or published.
## Classification
The biome tag `rivencraft:desert_vegetation` includes vanilla Desert and the
optional common tag `c:is_desert`. No TerraBlender dependency or biome-ID
substring guessing is used. In the installed BOP 21.1.0.14 and 26.3.0.0.16
assets, Dryland and Lush Desert have that common tag; Cold Desert does not.
Cold Desert therefore retains the ordinary non-desert behavior. Hot/dry
climate alone does not classify a biome as desert.
Data packs can extend `data/rivencraft/tags/worldgen/biome/desert_vegetation.json`
with additional biome IDs using `replace: false`. The existing exclusion of
Nether/End/cave biomes for generic surface vegetation still applies.
## Authored effects
| Page | Desert effect per occurrence per chunk |
| --- | --- |
| Flowers | 16 attempts to place individual dead bushes |
| Trees | 8 attempts to place 1–3-block cactus columns |
| Huge Trees | 4 attempts to place 5–9-block cactus columns |
Repeated Pages add independent, deterministic attempts within the existing
feature-page limit. Space and ground checks still apply: attempts are not a
guarantee of a fixed number of plants. Vanilla biome decoration runs normally
before authored vegetation. Non-desert candidates keep the existing vanilla
flower, plains-tree and old-growth-spruce features.
Placement checks the actual candidate biome. Desert writes and neighbor reads
stay within the decorating chunk, leave existing structures/plants intact, and
require clear air. Cacti require horizontal clearance for their full height.
Sand/red sand are preserved. Supported dirt/grass can have just the cactus's
base converted to sand, permitting grass-layer Flat Ages without repainting
the terrain. Soil over an unsupported block is skipped to avoid falling bases.
Dead bushes can grow on supported sand/soil. Other materials are left alone.
The 1.21.1 Flat generator now applies these three authored plant Pages too;
previously that path did not run them. Both versions use the same cactus/bush
placement algorithm; version-specific adapters retain their vanilla placement
APIs. No new item, recipe, generated texture or hard dependency is introduced.
Existing Creative/JEI Pages receive updated tooltip descriptions.
## Saves
Only newly decorated chunks change. Existing plants/chunks are not rewritten.
Saved written Page order/count and Age seed remain the inputs, with no new
saved plan field. Reopening/restarting retains the same placement inputs;
it does not rerun decoration on existing chunks.
## Verification
Run `python3 scripts/test_desert_vegetation.py` for storage-free checks of all
three effects, repeatability, repeated attempts, biome boundaries, chunk
bounds, invalid ground, obstruction, Flat base conversion and ceiling limits.
Temporary Java outputs are deleted. Test fixtures stay outside production JARs.
### Player checks, both versions
1. Create fresh Standard + Desert + Single Biome Ages with a Link Panel and
separately Flowers, Trees or Huge Trees. Use a no-feature control and a
four-copy version of each page; matching Age seeds improve comparisons.
2. Expect additional dead bushes, ordinary cacti, or visibly taller cactus
columns respectively. Repeated pages increase attempts; no generic
flowers/oak/spruce should be added by these pages in Desert.
3. Repeat on Flat + Desert + Single Biome, including the grass-layer surface.
Cactus bases may be single sand blocks; other Flat layers remain intact.
4. Repeat in BOP Dryland/Lush Desert when installed. Check nearby Plains and
Cold Desert keep their previous non-desert behavior.
5. Revisit after restart, then explore new chunks. Existing vegetation must
remain intact; new chunks should continue the selected behavior.
6. Check mixed-biome Ages and occupied/rocky surfaces: vegetation respects the
candidate biome, solid obstructions and ground rules.
No test server or saved test world is required by the offline checks. If a
future runtime test stalls, stop it and hand it to the player without retry.
## 26.3 Flat Dryland regression
The saved `drybones` Age uses Flat terrain, Single BOP Dryland, and all three
plant pages. Its writing and runtime desert tags were correct. In Minecraft
26.3, `minecraft:dirt` no longer contains grass blocks; the old soil check
therefore rejected the grass surface. The 26.3 adapter now checks both
`minecraft:dirt` and `minecraft:grass_blocks`. No 1.21.1 code change was needed.
An isolated 26.3 server with BOP, TerraBlender and GlitchCore reproduced zero
cactus blocks before the fix. With the same seed and pages, the corrected
first chunk contained 22 cactus blocks / 15 dead bushes in vanilla Desert and
12 cactus blocks / 17 dead bushes in BOP Dryland. These are one-seed observations,
not guaranteed densities. The test world and isolated build output were removed;
the retained log is `build/verification/desert108/mc263.log`.
Run `python3 scripts/regression_desert263.py` for this optional-mod runtime
check using the local Dev 26.3 mod files. It uses the single-server lock and
a 60-second timeout, hands off a stalled test without retry, and removes its
temporary world regardless of result.
## Release validation (2026-11-17)
Player in-game checks passed. Included in releases 1.21.1.0.6 and 26.3.0.10 (Seamless integration applies to 26.3 only). Earlier candidate notes above describe development history. Known Reborn/Seamless acknowledgement and rendering failures remain tracked in [#118](https://git.paddedcell.org/dnorberg/rivencraft/issues/118); this release does not resolve them.