docs: rewrite the phase 0 comments to explain what the numbers mean - #548
Merged
Conversation
0_plains.yml is the reference file admins read first, but it never said
what the numbers after a Material or EntityType are. An admin asked, and
they were right to guess weighting: they are relative weights in a single
raffle - not counts and not percentages - and blocks, mobs and
custom-blocks all draw from that same pool, so a mob weight is directly
comparable to a block weight and pushes every block's share down.
The header now separates the three distinct kinds of number a phase file
contains, since that is the real source of the confusion:
1. blocks/mobs/custom-blocks values are weights, one shared pool
2. fixedBlocks and holograms keys are positions within the phase, from 0
3. the top-level key is the section name - phases_index.yml has owned
phase order and length since 1.26.0
Each section then gets its own explanation with the real Plains numbers
worked out (11450 block weights + 665 mob weights = 12115, so
GRASS_BLOCK: 2000 is 16.5% and COW: 150 is 1.2%), plus the CHEST
two-stage roll, the mob/custom-block types that were missing from the
list, and version gating.
Comments only - every block, mob and weight is unchanged.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017zwLryefnJ6wG76JmYNamx
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
An admin asked:
They were right, and
0_plains.yml— the file we point admins at as the reference — never said so. Nor did it mention the part that actually bites:blocks:,mobs:andcustom-blocks:all draw from one shared pool, so a mob weight is directly comparable to a block weight and adding mobs makes every block rarer.What
Rewritten comments in
0_plains.yml. The header now separates the three distinct kinds of number a phase file contains, since conflating them is the real source of the confusion:blocks:,mobs:andcustom-blocks:values. One shared pool,weight ÷ phase total. Not counts, not percentages.fixedBlocks:andholograms:keys. Block count within this phase, from 0.'0':key. Historically the start block;phases_index.ymlhas owned order and length since 1.26.0.Each section then gets its own explanation:
GRASS_BLOCK: 2000is 16.5%,CHEST: 200is 1.7%,COW: 150is 1.2%,EMERALD_ORE: 10is 0.08%.CHESTas a special case: its weight is the chance of a chest; rarity is a second roll at the hard-coded 62/25/9/4.custom-blocks:'probability:field is a weight in the same pool despite the name, plus themob,itemsadder,nexoandcraftenginetypes that were missing from the list.weight:object form.clear-blocksmakes space).Comments only — verified with
git diffthat every block, mob and weight is byte-identical, and the parsed YAML is unchanged (blockstotal 11450,mobstotal 665, samefixedBlocks/holograms/biome/icon/name).OneBlocksManagerTestpasses.Note for existing servers
Phase files are only copied out of the jar when the
phasesfolder is first created, so existing installs keep their old0_plains.ymland will not see these comments. The companion docs PR covers those admins: BentoBoxWorld/docs#85 adds a "Customizing Phases" page and corrects the AOneBlock overview, which described weights only as "relative probability" and never mentioned the shared pool.