Move guides to the developer site, add version/asset metadata to LOD and voxel headers#261
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds formal on-disk format specifications for streamed SOG and voxel outputs, and updates the voxel/LOD writers to emit identifying asset metadata and additional header fields to support versioning and compatibility.
Changes:
- Added new format specification docs for streamed SOG (
lod-meta.json) and voxel (.voxel.json/.voxel.bin) outputs. - Extended LOD (
lod-meta.json) and voxel headers to includeasset.generator; LOD headers also gainversion, totalcount, and per-LODcounts, and omitenvironmentwhen absent. - Updated README and guides to link to the new specifications.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/lib/writers/write-voxel.ts | Adds asset.generator to .voxel.json metadata using the tool version. |
| src/lib/writers/write-lod.ts | Extends lod-meta.json schema with version/asset metadata and splat counts; omits environment when absent. |
| README.md | Adds links to the new format specification documents. |
| guides/VOXEL_FORMAT.md | Introduces voxel format v1.1 specification (header + binary layout + octree semantics). |
| guides/STREAMED_SOG.md | Links the streamed SOG guide to the new streamed SOG format specification. |
| guides/STREAMED_SOG_FORMAT.md | Introduces streamed SOG format v1 specification (lod-meta.json schema + semantics). |
| guides/COLLISION.md | Links collision guide voxel output to the voxel format specification. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
This PR moves repo documentation to the PlayCanvas developer site and extends the LOD and voxel output headers with identifying metadata.
guides/directory (COLLISION.md, DOCKER.md, STREAMED_SOG.md and all guide images). These guides now live on developer.playcanvas.com, alongside new on-disk format specifications for streamed SOG and voxel output.lod-meta.jsonnow includesversion: 1,asset.generator, total splatcount, and per-LOD-levelcounts. Theenvironmentkey is omitted when the scene has no environment splats instead of being written asnull..voxel.jsonheader now includesasset.generator, matching the SOG and LOD writers.