HELIX Docs
CLI & AI toolsCommand reference

helix placements

Bake and inspect instanced placements: prototypes, solid records and rule-generated scatter

CLI version 0.1.27-helix3.551. Run helix placements --help for the text your installed build prints.

helix placements

Bake and inspect instanced placements: prototypes, solid records and rule-generated scatter

helix placements <command>

helix placements bake

helix placements bake [options] <source>
ArgumentRequiredDescription
sourceyeshelix.placements-source/1 JSON rules and prepared asset inventory
OptionDescription
--out <dir>baked placements source folder (required)

helix placements impostors

helix placements impostors [options] <dir>
ArgumentRequiredDescription
diryesvalidated baked placements folder
OptionDescription
--out <dir>new placements folder with reusable distant tree assets (required)
--size <pixels>atlas width and height: 512 or 1024 (default "512")

helix placements attach-impostors

helix placements attach-impostors [options] <scene>
ArgumentRequiredDescription
sceneyeslocal sealed Scene v2 file to update
OptionDescription
--source <dir>impostor bake of the same fine placements (required)

helix placements foliage-lods

helix placements foliage-lods [options] <dir>
ArgumentRequiredDescription
diryesvalidated placement bake with tree LODs
OptionDescription
--out <dir>new placement bake folder (required)
--size <pixels>full-family atlas size: 512, 1024, 2048 (default "1024")
--mid-triangles <n>total triangles of the lowest tree LOD (chains of 3+ levels); 0 keeps the authored count (default "300")
--near-triangles <n>total triangles of the tree LODs between the finest and the lowest; 0 keeps the authored count (default "700")
--mid-pixels <n>screen height in pixels where the first reduced LOD hands over to the lowest; 0 keeps the authored threshold (default "96")

helix placements attach-foliage-lods

helix placements attach-foliage-lods [options] <scene>
ArgumentRequiredDescription
sceneyeslocal sealed Scene v2 file to update
OptionDescription
--source <dir>foliage bake of the same placements (required)

helix placements snap-to-terrain

Re-seat every placement on the final terrain: re-sample each record's ground at the finest stride (after any carve), rewrite the region files and distant tree pages that moved, copy the rest

helix placements snap-to-terrain [options] <dir>
ArgumentRequiredDescription
diryesvalidated placements bake (placements.json + objects/)
OptionDescription
--terrain <dir>the FINAL terrain source folder (terrain.json, tiles/, coarse.*): for a CS2 city, the carved <out>/terrain (required)
--out <dir>new placements bake folder (required)
--scene <file>sealed Scene v2 document to re-point at the snapped bake; needs --scene-out. <out> must be the document's placements/ folder
--scene-out <file>where to write the re-pointed, resealed document
--embed <metres>how far a trunk sits in the ground (default "0.03")
--max-elevated <metres>a base further above the ground than this stands on a roof or deck and keeps its height (default "3")
--jsonmachine-readable report

helix placements inspect

helix placements inspect [options] <dir>
ArgumentRequiredDescription
diryesbaked placements source folder
OptionDescription
--jsonmachine-readable report

On this page