Skip to content

Update to the README - #151

Open
mfishma wants to merge 3 commits into
ViaVersion:mainfrom
mfishma:update/readme
Open

mfishma wants to merge 3 commits into
ViaVersion:mainfrom
mfishma:update/readme

Conversation

@mfishma

@mfishma mfishma commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

While I was going through the code, I had a go at documenting v2 and adding little clarity. I know things will change even more soon, so hopefully this makes it easier moving forward.

I'm just hoping my changes are still technically accurate, and I kept as much as I could to reduce diff fatigue.

Comment thread README.md Outdated
Comment on lines +49 to +50
* `last_snapshot.txt` the latest development build ID updated automatically by `download_server.py` (snapshots, prereleases, RCs, e.g., 27.3-snapshot-5)
* `last_custom_model_data.txt` a counter tracking the last assigned CustomModelData number for backwards item remaps (incremented automatically by `--generateDiffStubs`)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really relevant for the readme

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, didn't get what this was helping someone get set up. And I wasn't clear what the "last release ViaVersion requires mappings for" so I just made it explicit about looking in mappings/.

Comment thread README.md
* `id` (byte tag) is `2`
* `at` (int array tag) contains the unmapped ids that have been changed
* `val` (int array tag) contains the mapped ids, indexed by the same index as the unmapped id in `at`
* Optional: `nofill` (byte tag): Unless present, all ids between the ones found in `at` are mapped to their identity

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This still exists

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm so glad you proofread that! Fixed.

@mfishma

mfishma commented Oct 6, 2026

Copy link
Copy Markdown
Contributor Author

Thanks again for proofreading. Made the changes, plus I just added one more # to the subsections of the _Mapping files section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants