Log inGet started
Package

ShoreCatalog.module

This package holds more than this page lists. See all of its files in its world.

README.md

ShoreCatalog

Registers the shore half of tropicalProps with Props: 41 kinds of rocks, cliffs, coral, sea grass, shore litter and a modular weathered wooden pier, each in 2-3 seeded variants, LOD0/1/2 and all five looks (real, painted and pixel share the default geometry; toon draws a chunkier smoother bake; lowpoly a coarse flat-shaded bake). Meshes come only from BakedShore (literal resolves), materials only from tropicalMaterials.TropicalMaterials.get(surface, { look }).

local Props = require("tropicalProps.Props")
Props.parts("cliffWall", { look = "toon", variant = 2, lod = 0 })        -- { { mesh, material }, ... }
entity.spawn("rock").component.add("tropicalProps.TropicalProp", { kind = "rockBasalt", seed = 17 })
CategoryKinds
rock (mesh collider, surface rock)rockBeach, rockBasalt, rockLimestone, rockMossy, rockCluster, rockShelfTidePool (surface wetRock, walkable, pools of tidePoolWater with urchins / anemones / a red starfish), pebbleScatter (no collider)
cliff (mesh collider)cliffWall (12 m wide, 11-19 m tall, faces +Z out to sea, tiles along X: every variant shares the edge profile at x = +-6, runs 2 m below y = 0), cliffSpire (sea stack 8.5-14.5 m), cliffBoulderPile
coral / seagrass (underwater = true)coralBrain, coralStaghorn, coralTable (mesh collider), coralFinger, coralPink, seaFan (card), coralCluster, seaGrass (cards), kelpClump (cards)
litterdriftwoodLog (mesh collider, wood), driftwoodBranch, shellConch, shellCowrie, shellScallop, shellScatter, starfish (v1-2 orange, v3 red), seaweedStrand, seaweedLine
pier (surface wood)pierDeck, pierDeckBroken, pierPost, pierRailing, pierLadder, pierSteps, pierEnd, pierHut, bollard, lantern, rowboat, signpost, lookoutDeck

Pier grid: pieces snap every 2 m along +Z; deck top is y = 0 at the origin; a deck section spans x -1.2..1.2, z 0..2 (posts at x = +-1.3 at each section start); the end platform x -2..2, z 0..4 (posts at x = +-2.1); a railing runs z 0..2 at its own x = 0; steps go down toward -Z from z = 0 to 1.4 m below; the ladder hangs over an edge facing +Z; the hut and the lookout deck (top at y = 0.4, open toward +Z) are centred on their origin.

pierLayout

ShoreCatalog.pierLayout(length, opts?) -> { { kind, position = {x,y,z}, yaw, variant } }: a whole pier along +Z from the origin in local metres, yaw in radians about +Y, so one parent transform places it. Options: railings ("both" | "left" | "right" | "none"), steps, endPlatform, hut, lanterns, ladder, boat (default true), sign (default false), broken (chance per deck section, default 0.15), seed, deckHeight (added to y), waterY (boat waterline relative to the deck, default -1.1).

Hooks: ShoreCatalog.LIGHTS.lantern = { offset, color, range, intensity } (a point light for the lantern glass at night); ShoreCatalog.SIGN_FACE = the signpost board's face centre / size / normal for a Text3D label.

Budgets (triangles, variant 1, default form)

Rocks LOD0 1.3-3.3k, LOD1 0.3-0.8k, LOD2 <= 400; tide-pool shelf 7.2k / 1.9k / 0.3k; cliffs 4.6-7k / 1.2-2k / <= 280; coral 1.7-5.9k / 0.3-1.6k / <= 620; cards (fans, grass, kelp, wrack) <= 500; shells and starfish <= 2k / 650 / 200; pier pieces 0.25-3.7k / 0.1-1.4k / <= 500 (lookout deck 6.2k). Lowpoly bakes LOD0 only (the LOD2-class shape, flat-shaded); toon bakes LOD0/1. Exact counts per part are in BakedShore.kinds.

Regenerating

Generators: ShoreRocks, ShoreSea, ShorePier (kit: ShoreGeo; table: ShoreGen). After a change, in a task: require("tropicalProps.ShoreBake").run() (all kinds, ~30 s) or .run({ kinds = { "cliffWall" } }). It overwrites meshes under meshes/shore/<kind>/, prunes stale ones and rewrites BakedShore. New .mesh folders are committed file by file: zm add tropicalProps.package/meshes/shore/*/*.mesh.