Northlight Tundra
- ..
- .metadata117 B
- ArcticBake.module
- ArcticCatalog.module
- ArcticProp.component
- ArcticProps.module
- BakedCamp.module
- BakedIce.module
- BakedPlants.module
- BakedRemains.module
- BakedStone.module
- CampGen.module
- IceGen.module
- PlantGen.module
- PropGallery.component
- PropGallery.scene
- README.md13.3 KB
- RemainsGen.module
- Shapes.module
- StoneGen.module
- Stylize.module
- meshes
- package.yaml1.4 KB
- tests
README.md
arcticProps
High-Arctic props for tundra and ice worlds: 32 kinds, from 5 cm saxifrage flowers to a 28 m layered ice-shelf cliff wall, every one in five looks (realistic, painted, cartoon with ink outline, low-poly, pixel). Each kind has at least three seeded shapes (the hut and the mast have two; lake cracks and flags have six), three baked levels of detail, colliders where a player needs them (box colliders on everything walkable) and a footstep surface. Materials come only from arcticMaterials. Place one prop with the ArcticProp component; arcticKit scatters them over a whole tundra; every kind is also registered with forestProps' Props, so forestKit's instanced renderer can draw them too.
Quick start
Paste into an empty world's run box:
-- an inuksuk, a research hut with its weather mast, a sled and a fuel cache
local function place(kind, x, z, fields)
local e = entity.spawn(kind, { position = { x, 0, z } })
local f = fields or {}
f.kind = kind
e.component.add("arcticProps.ArcticProp", f)
return e
end
place("inuksuk", 0, 0)
place("researchHut", 8, -4)
place("weatherMast", 13, -6)
place("sled", 5, 2, { variant = 3 })
place("drumCluster", 12, -1, { variant = 2 })
place("lichenBoulder", -4, 3, { look = "cartoon" })
A whole tundra with these props scattered over it comes from arcticKit:
entity.spawn("Tundra").component.add("arcticKit.Tundra", { size = 512, seed = 7 })
Every kind side by side: open PropGallery.scene, or entity.spawn("gallery").component.add("arcticProps.PropGallery", {}).
From code
local AP = require("arcticProps.ArcticProps")
AP.kinds() -- all 32, catalog order
AP.kindsOf("ice") -- ice, snow, rock, structure, remains, plant (forestProps categories work too)
AP.info("researchHut") -- { kind, category, variants, radius, height, collider, colliders, surface, walkable, lodBand, budget, byVariant }
AP.parts("serac", { look = "pixel", variant = 2, lod = 0 }) -- { { mesh, material, part, surface, spin? } }
AP.tris("shelfCliff", { look = "realistic", lod = 1 }) -- triangles drawn
look:"realistic" | "painted" | "cartoon" | "lowpoly" | "pixel"; nil or"auto"follows the world look (arcticMaterials.ArcticLook.get()).outline = falsedrops the cartoon ink hull;snow = falsedrops the snow dusting parts.info(kind).collideris one{ shape = "box", size = {x,y,z}, offset = {x,y,z} }in prop space at scale 1 (the median variant);info(kind).byVariant[v].colliderslists every box of that variant (the hut has one per wall plus roof, deck and steps; the ridge has three stepped boxes up to its crest). Plants and small things have none.info(kind).lodBand = { near, mid, far }metres: LOD1 fromnear, LOD2 frommid, gone pastfar.- Parts with
spin = { pivot, rate, mode }(the mast's anemometer cups and wind vane) are baked in prop space, so an instanced renderer can draw them still;ArcticPropturns them about their pivot.
ArcticProp component
| Field | Meaning |
|---|---|
kind | any kind AP.kinds() lists |
variant | shape 1..n (wraps); used when seed is 0 |
look | auto (world look, rebuilds when it changes) or one of the five |
seed | non-zero picks the variant and a yaw from the seed |
lod | auto (MeshLod swaps by screen size), or near, mid, far to pin one |
collide | static BoxColliders from the catalog, tagged forestSurface = footstep surface |
outline | cartoon ink outline on or off |
snow | snow dusting on rocks, ice, roofs and drum lids |
Children are temporary and rebuilt from the synced fields, so every player sees the same prop and a reload rebuilds it.
Kinds
Triangle counts are read from the baked indexes (range over variants, all parts, ink excluded). Budgets for the browser at 30 fps: plants 300, rocks and small ice 2000, structures and big ice 6000, shelf cliff 8000 at LOD0; LOD1 about 30 to 40 percent, LOD2 about 10 percent.
| Kind | Category | forestProps | Variants | LOD0 | LOD1 | LOD2 | Lowpoly | Pixel | Footstep | Collider |
|---|---|---|---|---|---|---|---|---|---|---|
pressureRidge | ice | ice | 3 | 2282-3517 | 1204-2108 | 221-415 | 613-1087 | 1248-1784 | ice | walkable |
iceRubble | ice | ice | 3 | 386-779 | 329-550 | 95-128 | 219-388 | 1082-1296 | ice | walkable |
serac | ice | ice | 3 | 1879-2044 | 1078-1304 | 102-114 | 161-178 | 1494-1866 | ice | solid |
iceBlock | ice | ice | 3 | 1041-1197 | 260-299 | 36-40 | 20-29 | 470-670 | ice | walkable |
shelfCliff | ice | cliff | 3 | 5268-5316 | 1520-1552 | 152 | 716-744 | 1472-1960 | ice | walkable |
crevasseLip | ice | ice | 3 | 3600 | 1248 | 288 | 600 | 200-418 | ice | walkable |
lakeCrack | ice | ice | 6 | 276-530 | 240-436 | 40-82 | 140-278 | 54-678 | ice | none |
snowDrift | snow | snow | 3 | 1922 | 512 | 98 | 162 | 148-208 | freshSnow | walkable |
sastrugiPatch | snow | snow | 3 | 1922 | 512 | 72 | 200 | 12-144 | crust | none |
cornice | snow | snow | 3 | 780 | 364 | 130 | 208 | 724-952 | freshSnow | walkable |
lichenBoulder | rock | rock | 3 | 599-635 | 146-160 | 32 | 32 | 1054-1092 | rock | walkable |
erratic | rock | rock | 3 | 781-828 | 125-134 | 60-63 | 65-69 | 1232-1402 | rock | walkable |
frostRockPile | rock | rock | 3 | 689-1193 | 393-702 | 119-208 | 474-790 | 1078-1626 | rock | walkable |
rockOutcrop | rock | rock | 3 | 433-1647 | 316-433 | 134-186 | 235-339 | 1532-1908 | rock | walkable |
inuksuk | structure | structure | 3 | 626-1260 | 622-745 | 192-228 | 268-348 | 1144-1414 | rock | solid |
researchHut | structure | structure | 2 | 2926 | 1458 | 420 | 560 | 1228-1308 | wood | walkable |
weatherMast | structure | structure | 2 | 676-1178 | 584-806 | 272-276 | 287-477 | 1124-1288 | metal | solid |
sled | structure | structure | 3 | 636-962 | 420-614 | 96-188 | 144-236 | 256-608 | wood | solid |
fuelDrum | structure | structure | 3 | 588-630 | 180-204 | 60 | 80 | 76-156 | metal | solid |
drumCluster | structure | structure | 3 | 2460-4452 | 792-1524 | 240-540 | 320-680 | 396-882 | metal | solid |
markerStake | structure | structure | 3 | 141 | 36 | 9 | 28 | 24-68 | wood | none |
flag | structure | structure | 6 | 108-700 | 33-258 | 21-80 | 25-103 | 24-648 | metal | expedition pole |
whaleBones | remains | log | 3 | 808-888 | 424-552 | 120-144 | 200-248 | 754-2344 | rock | solid |
caribouAntlers | remains | log | 3 | 350-732 | 216-464 | 30-68 | 156-320 | 658-1028 | scrub | none |
driftwood | remains | log | 3 | 304-1520 | 102-510 | 32-160 | 40-200 | 108-664 | wood | solid |
dwarfWillow | plant | bush | 3 | 270 | 112 | 26 | 112 | 240-270 | scrub | none |
cottongrass | plant | grass | 3 | 200-272 | 64-76 | 32 | 80-104 | 180-264 | scrub | none |
mossHummock | plant | moss | 3 | 128 | 32 | 8 | 32 | 234-278 | scrub | none |
purpleSaxifrage | plant | flower | 3 | 208-288 | 92 | 28 | 92 | 112-280 | scrub | none |
arcticPoppy | plant | flower | 3 | 108-228 | 40-88 | 28 | 56-104 | 178-236 | scrub | none |
mossCampion | plant | flower | 3 | 228-288 | 112 | 18 | 112 | 240-274 | scrub | none |
sedgeTuft | plant | grass | 3 | 108-192 | 56 | 12 | 48 | 242-292 | scrub | none |
Categories registered with forestProps: the standard rock, bush, grass, flower, moss, log, cliff, structure, plus new ice and snow.
Sizes are real: inuksuk about 1.6 to 1.8 m, research hut 4 x 3 m and 3.3 m to the stovepipe cap, drum 0.88 m tall, weather mast 4.5 or 6.5 m, pressure ridge 9 to 18 m long, shelf cliff 24 m wide and 21 to 28 m tall (its ends share one profile so sections tile side by side along a coast, face toward +Z), flowers 5 to 15 cm.
Crevasses, lake cracks and flags
crevasseLip is a crevasse you can look into: a jagged slot 15, 22 or 30 m long along the prop's +Z (variants 3, 1, 2), 1.9 to 3.2 m across, with overhanging snow cornice lips on both edges, a band of layered firn under them, blue ice walls that ledge and narrow as they drop and darken to blue-black, and a near-black floor 3.6 to 6 m down. Its ends are snow ramps (grade 0.72) so anyone who falls in walks out. A snow apron runs 6.4 m out from each wall, its outer edge buried 6 cm under the ground. The walls go below ground level, so the ground under it must be cut for the slot to open: AP.crevasse(variant) answers the cut at scale 1 (floor(u) depth and wall(u) half-width along the axis, full, apron, gap): flat at the prop's origin under the apron, and floor(u) + gap deep within wall(u) * 1.1 + full of the axis. arcticKit's tundra does this itself (TundraCrevasse). Colliders: four chord boxes per side hold the lips and walls (they never stand out into the slot) and one box per side under the apron holds the cut ground; the floor and ramps are the real ground. Placed alone on uncut ground it reads as a lipped scar in the snow.
lakeCrack is a flat crack decal for lake ice, 6 mm above the ice, about 8 to 15 m across: variants 1 to 3 are bright white-cyan fractures for clear black ice (a radial star with a spider web of rings, a long pressure crack doubled over part of its run with a refrozen grey band and feather fractures, a polygonal network), 4 to 6 the same forms in blue-grey for white ice. No colliders, no shadows (info("lakeCrack").shadow == false); its pixel look is a flat raster, not voxels.
flag stands on its own, in three forms and two colours each:
| Variant | Form | Colour | Height | Collides |
|---|---|---|---|---|
| 1 | expedition flag on a guyed aluminium pole, snow collar | red, white band | 2.9 m | yes |
| 3 | expedition flag | blue, white band | 2.6 m | yes |
| 2 | survey pennant on a wooden lath, flagging-tape tail | orange | 1.75 m | no |
| 5 | survey pennant | yellow | 1.55 m | no |
| 4 | small marker flag on a steel wire | lime | 0.92 m | no |
| 6 | small marker flag | red | 0.78 m | no |
The cloth is baked in a wind-blown curve flying toward the prop's local +X (static: arcticMaterials' canvas has no wind sway). Place one flying downwind:
local AP = require("arcticProps.ArcticProps")
local wind = { 0.3, -0.95 } -- the way the wind blows
local e = entity.spawn("flag", { position = { 4, 0, 2 }, rotation = { Transform.quatFromAxisAngle(0, 1, 0, AP.flagYaw(wind[1], wind[2])) } })
e.component.add("arcticProps.ArcticProp", { kind = "flag", variant = AP.flagVariant("pennant", "yellow") })
AP.FLAGS lists the forms and colours; AP.flagVariant(form, colour?) picks the variant.
Looks
- realistic, painted, cartoon share the smooth meshes and differ by material (arcticMaterials'
realistic,painted,cartoon). Cartoon adds an ink outline: a baked inverted hull (the surface pushed out along welded normals, wound inward) drawn with arcticMaterials'inksurface, the same technique the published toon content uses. - lowpoly draws its own bake: a deliberately coarse cage of each prop (fewer facets, fewer stones, low subdivision) with every triangle split off and shaded by its face normal, one flat colour per face, with arcticMaterials' flat-colour
lowpolymaterials. - pixel draws a voxel bake: all parts of a prop sampled onto one grid (about 10 to 44 cells across, coarser per LOD), each cell owned by the part with most surface in it, only faces toward open air kept and merged into rectangles of one colour, with arcticMaterials' point-sampled
pixelmaterials. That gives the blocky read ofdesign/references/arctic/styles_sheet.png.
Baking
Meshes are baked files (meshes/<kind>/<kind>_v<variant>_<set><lod>_<part>.mesh, sets s smooth, l lowpoly, p pixel, i ink), so every machine loads identical geometry. The generators (IceGen, StoneGen, CampGen, RemainsGen, PlantGen, on top of Shapes and alpineProps' GroundKit) and ArcticBake are authoring tools; the game only reads the Baked* indexes. To change a kind, edit its generator and run require("arcticProps.ArcticBake").run({ kinds = { "serac" } }), one kind at a time.
Tests
tests/arcticProps (tools.use("tests", "run", "arcticProps")) checks registration, every kind x look x variant x LOD resolving to baked meshes and live materials, the outline and snow switches, distinct meshes per look, triangle budgets, colliders on walkable kinds, the mast's spinning parts, and the component (rebuild on look change, seeded variants, rays landing on walkable colliders).
Known limits
- In the browser a first sight of many new meshes can hitch while they load (#22751); a whole gallery streams in over a few seconds.
- Destroying an entity whose ArcticProp parts carry
MeshLodlogs one harmless "component this proxy names was removed" error per part from the engine's MeshLodonDestroy. Changing fields to rebuild does not. - Plants are true to scale (5 to 40 cm), so they read only up close or in numbers; scatter them in drifts.
- The pixel look of very flat kinds (sastrugi patch) is a near-flat slab of blocks: their relief is smaller than a cell.
- Spinning mast parts only turn on an
ArcticProp; instanced renderers draw them still.