Skip to content

Add a guide for generating streamed SOG data#251

Merged
slimbuck merged 2 commits into
playcanvas:mainfrom
slimbuck:ssog-dev
Jun 3, 2026
Merged

Add a guide for generating streamed SOG data#251
slimbuck merged 2 commits into
playcanvas:mainfrom
slimbuck:ssog-dev

Conversation

@slimbuck

@slimbuck slimbuck commented Jun 3, 2026

Copy link
Copy Markdown
Member

Adds a walkthrough for producing streamed SOG (multi-LOD, spatially chunked) from a single PLY, and surfaces it from the README.

  • New guides/STREAMED_SOG.md: generate an LOD chain by repeatedly decimating with --decimate 50%, then combine the levels into streamed SOG with --lod, writing lod-meta.json plus per-chunk SOG folders. Covers chunk tuning (-C/-X) and troubleshooting.
  • README: add a ## Guides index listing all three guides (Streamed SOG, Collision, Docker), link the new guide from the LOD Output Options section, and reword the lod-meta.json formats-table row to "Streamed LOD data stored in SOG chunks".
  • Docs only, no code changes. Commands verified end-to-end on a generated test scene.

@slimbuck slimbuck requested a review from Copilot June 3, 2026 11:33
@slimbuck slimbuck self-assigned this Jun 3, 2026
@slimbuck slimbuck added the enhancement New feature or request label Jun 3, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds user-facing documentation for producing streamed SOG output (multi-LOD, spatially chunked) from a single PLY input, and surfaces the new guide from the main README so it’s discoverable alongside existing guides.

Changes:

  • Add a new end-to-end guide for generating streamed SOG (guides/STREAMED_SOG.md).
  • Add a “Guides” index section to README.md and link the streamed SOG guide from the LOD output options section.
  • Update the supported-formats table description for lod-meta.json to better reflect the streamed/chunked output.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
README.md Adds a Guides index, links the new streamed SOG guide, and updates lod-meta.json description.
guides/STREAMED_SOG.md New walkthrough covering LOD-chain creation and combining into streamed SOG output, including chunk tuning flags.
guides/COLLISION.md Renames the top-level heading to a clearer, more consistent title.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@slimbuck slimbuck marked this pull request as ready for review June 3, 2026 12:12
@slimbuck slimbuck requested a review from a team June 3, 2026 12:12
@slimbuck slimbuck merged commit 76e35a2 into playcanvas:main Jun 3, 2026
3 checks passed
@slimbuck slimbuck deleted the ssog-dev branch June 3, 2026 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants