OVL: confirm unverified field meanings

Open
#4 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active

Research direction

The issue names no files, tests or entry points, so begin by finding where the listed fields (texture, palette, mesh, scenery, bone, sound) are read in the repository and where the public notes live. Work through the checklist one field at a time, confirming each meaning from observed behaviour rather than inference. Done means every item is either documented in your own words or marked open, and the trailing-data question has a recorded answer on whether the parser can safely skip it.

Written by the indexing model from the issue text.

Description

area:ovl documentation

Several fields are read but their meaning is inferred from data, not confirmed:

  • texture animation value and flag bits
  • paletted texture palette byte order
  • static shape mesh flags, transparency and sides values
  • scenery visual flags and distance semantics
  • bone animation rotation axis order and interpolation
  • sound descriptor float fields

Track each as a checklist item; confirm through observed behaviour and document in public notes in our own words.

Trailing data

Folded in from #3: each file ends with build-time bookkeeping that is currently skipped.

  • Decide whether it carries anything needed at runtime; if not, document that it is safely ignorable and keep the parser tolerant of it.
Dominant language
C++
Stars
4
Forks
1
Avg merge
2h 22m
Merged PRs (30d)
156

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tomast1337/RCT3PlusPlus

All issues in tomast1337/RCT3PlusPlus

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.