lanternStair.package
README.md
lanternStair
A Japanese mountain shrine in one component. A long stone stairway climbs a cedar-dark mountain from a
misty valley floor to a torii on a saddle that frames the eastern sky, where a big full moon rises. Eight
whole shrines are one setting away (layout: a grand terraced stair, a small hillside shrine, a festival
stair of paper lanterns, a zigzag up a cliff, a switchback in a waterfall gorge, a wide temple approach, a
winding forest path, a ruined shrine), and every part also swaps on its own: six stair shapes (straight,
switchback, winding, terraced, a sweeping arc, a steep zigzag) and nine kinds of traditional lantern:
Kasuga, Yukimi and Oki stone lanterns, tall tachi-doro on stepped pedestals, bronze tsuri-doro hung from
timber posts or under small gabled frames, red paper chochin on posts and paper andon floor lanterns, alone,
as a festival mix of paper lanterns, or all the stone and bronze kinds mixed. They line both sides and
light one by one, bottom to top, each flaring as it catches and then flickering like a candle. A
waterfall pours off a rock spur beside the steps, between broken cliff faces, into a plunge pool with spray
and drifting mist, and a stream winds away across the valley. Moss grows on the cheek walls, the plinths and
the ground; tall Japanese cedars (sugi) line the approach and fill the valley; a shrine hall or hokora and
cherry trees stand on the top terrace. Torii come in myojin, shinmei or ryobu form, in vermilion lacquer,
natural stone and timber, or weathered: faded, chipped vermilion with moss at the feet. Three light moods,
a misty golden-hour dusk with god rays through the cedars, a deep blue hour and a moonlit night with warm
lantern pools, follow worldClockKit's time of day out of the box and blend into one another, and the air and
mist size themselves to the shrine, light on a low hill and deep in a gorge. The same seed is the same shrine
for every player. To use it, install lanternStair from ZeroMind (search "lanternStair japanese
shrine", or zero zeromind installAsset 06902ffc-9552-4aa5-8a29-cf6eb7582b9a; worldClockKit, ambientDrift
and the prop kits come with it), then add a WorldClock and a lanternStair.LanternStair component with
layout = "grandStair" to your scene and press play (see "Put a shrine in your world").
Version 1.7.3. Built on (installed with it): sengokuProps (lanterns, torii, hall, cherry trees), alpineProps (cliff faces, rock outcrops and boulders; the cedars are the package's own procedural sugi), forestProps (ferns, moss, mossy rocks and stumps), worldClockKit (sun, moon, stars, sky, time), cloudburst (valley mist), ambientDrift (spray and mist wisps at the plunge pool), tidewater (the waterfall itself: feed reach, ballistic curtains, churned plunge pool and drips), and the stone, ground, alpine, forest and sengoku material packages.
Put a shrine in your world
In a scene's build.luau (inside content()):
-- the shared clock the moods drive (one per scene, on a synced entity)
entity.spawnSynced("WorldClock").component.add("WorldClock", { startDay = 8, weather = "mist" })
-- the shrine: unturned, so the stair climbs east toward the moonrise
local shrine = entity.spawn("Shrine")
shrine.component.add("lanternStair.LanternStair", { shape = "terraced", mood = "blueHour", seed = 7 })
From any script, at any moment (a film cue, a button, a trigger):
local Shrine = require("lanternStair.Shrine")
Shrine.lightUp(20) -- lanterns light bottom to top over 20 s
Shrine.setLit(0.3) -- the lowest 30 % lit, the rest dark
Shrine.setMood("moonlitNight", 8) -- blend to the moonlit night over 8 s
local p = Shrine.landmarks() -- named world positions for cameras
Fields (lanternStair.LanternStair)
| Field | Default | What it does |
|---|---|---|
seed | 7 | The same seed is the same shrine (trees, stones, lanterns, ground) for every player |
layout | custom | A whole shrine in one word (see Layouts): grandStair, hillside, gorgeFalls, cliffZigzag, templeApproach, forestPath, festivalStair, ruinedShrine. Each sets the stair, lanterns, torii, hall, waterfall and trees together, over the fields below; custom builds from the fields alone |
shape | terraced | straight; switchback (four legs, a landing at every turn); winding (an S-curve with two rests); terraced (straight, with wide landings every ~13 m of height); arc (one long sweeping bend with a rest at the middle); zigzag (seven short steep legs up a cliff face, a landing at every turn) |
rise, run | 80, 190 | Height climbed and horizontal length, metres. Accepted: rise 20-160, run 40-420; a value outside is clamped to the nearest end (rise 200 builds as 160). Reads best with run about 1.8 to 3 times rise |
width | 3.2 | Width of the treads |
lanternStyle | mixed | kasuga, yukimi, oki (stone lanterns on mossy plinths), tachi (a Kasuga head on a tall stepped granite pedestal), chochin (long paper chochin hung from timber posts), andon (paper floor lanterns on low plinths), paper (chochin and andon alternating: a festival stair), toro (bronze tsuri-doro hung from a timber post's arm reaching over the steps), tsuri (bronze tsuri-doro hung under a small gabled timber frame) or mixed (all six in turn along the climb, Yukimi on the landings) |
lanternSpacing | 9 | Metres between lantern pairs |
toriiStyle | myojin | myojin (curved kasagi), shinmei (straight, plain), ryobu (with supporting posts) |
toriiFinish | vermilion | vermilion lacquer, natural (granite myojin, hinoki shinmei and ryobu), or weathered (sengoku's weathered look: faded, chipped vermilion over grey timber, grimy black kasagi, moss cushions round the post feet) |
footTorii | true | A smaller torii where the approach meets the stair |
waterfall, waterfallSide | true, right | The falls, pool and stream, on the right (south) or left of the climb |
cedarDensity | 1 | How thick the cedar forest grows (0.2-2) |
cherryTrees | 7 | Cherry trees round the top terrace (plus two by the lower landings) |
hall | templeHall | templeHall, hokora or none on the top terrace |
mist | -1 (auto) | Valley mist, relative (0-2). Auto follows the shrine's size: light on a low hill (0.45 at rise 25 m or less), full in a deep gorge (1 at rise 70 m or more). Set a number to hold it |
mood | auto | auto: the shrine follows the time of day of the scene's WorldClock: goldenHour by day, blueHour from sunset with the lanterns lighting one by one up the stair, moonlitNight after dark, back at dawn (blue hour if the scene has no clock). A named mood (goldenHour, blueHour, moonlitNight) holds that light and drives the shared clock to its hour (see Moods) |
quality | auto | auto (low on phones, tablets and small browser screens, medium in a desktop browser, high natively), high, medium, low |
postFx | auto | Who owns the colour grade: auto = the shrine's bloom, grade, colour tables and vignette step aside while a cutscene plays, so a film's lens is the only grade (exposure and the volumetric air stay the shrine's); on; off |
driveClock | true | With a named mood: let it drive the scene's WorldClock. Ignored with mood = "auto" (the shrine follows the clock instead) |
followClock | true | With driveClock = false (or mood = "auto"), the mood (lanterns, mist, air, grade) follows the scene's WorldClock hour |
air | -1 (auto) | Volumetric air, relative to each mood's density (0-3). Auto follows the shrine's size: 0.35 on a low hill or open valley (rise 25 m or less), rising to 1 in a deep gorge (rise 70 m or more), so a small valley is never washed white at blue hour. Set a number to hold it |
Methods on the component: lightUp(seconds), setLit(fraction, fade), putOut(seconds), litFraction(),
setMood(name, seconds, { shared? }), followShared(seconds), isLocal(), landmarks(), rebuild(). The
Shrine module offers the same for the scene's shrine without finding it first (plus resume(seconds), an
alias of followShared), and find(), layout(), lanterns(), setViewPoint(pos|nil) and stats().
Moods
| Mood | Clock | Look |
|---|---|---|
goldenHour | sun low in the west (solar 17:12), just above the western ridge | a moody misty dusk: warm low sun, layered valley mist between the cedar ranks, god rays down the valley through thin low air, so the trunks and their shadows stand apart, warm grade, lanterns dark |
blueHour | just after sunset (solar 18:33, the sun a few degrees below the horizon: a readable dusk, not night) | deep blue sky, the full moon held 24° up so it hangs in the torii as you climb, dark cedar masses with a cool rim, lanterns lit, thick cool mist |
moonlitNight | solar 20:00 | the full moon ~26° up over the torii, silver-blue moonlight and stars, warm pools of lantern light; the soft sky fill is a quarter of the moonlight, so trunks, steps and the torii have a lit side and a shadow side, with ambient occlusion and contact shadows in the corners and under things |
The resting mood. With mood = "auto" (the default) the shrine follows the scene's WorldClock: every
second it reads the clock's solar hour and, when the hour crosses into another mood (blue hour from solar
18.0, moonlit night from 19.4, golden hour again from 6.2), it blends there over 20 s, lighting the lanterns
up the stair at dusk and putting them out at dawn. It never moves the clock, so a day/night cycle of your own
keeps running. With a named mood, the synced mood field sets the shared clock (held paused) to its hour on
day 8, the evening of the full moon, with the tsukimichi sky look (worldClockKit's realistic sky with a
large bright moon and a night that still reads); only the clock's authority moves the clock, and every
player follows it.
How a film hands back to the clock. A film (filmRig or your own cues) calls Shrine.setMood(name, seconds)
for each shot: that is local, so only the watching machine changes. When the film ends, call
Shrine.followShared(3) (filmRig's filmEnded event is the place): the shrine slides back over 3 s to the
resting mood, which with mood = "auto" is the mood of the clock's hour right now. A visitor who arrives
mid-day after a dusk film gets golden hour, one who arrives at night gets the moonlit night. Nothing else is
needed: no clock calls, no stored state.
Local moods (films). setMood(name, seconds) is LOCAL by default: it changes only the calling machine's
sun, moon, sky, ambient light, fog, valley mist and lanterns, sliding there over seconds, and writes no
synced field and no shared clock record. After worldClockKit's director lights the scene each frame, the kit
re-evaluates the environment at the local hour and applies it on this machine (Director.onTick). When the
film ends, followShared(seconds) (or Shrine.resume) slides back to the shared hour and the synced mood's
lanterns and mist, then stops overriding. While a machine is local, shared mood changes leave its lanterns and
mist alone. setMood(name, seconds, { shared = true }) is the synced path: it sets the field and the shared
clock for everyone.
Lantern calls (lightUp, setLit, putOut) always act only on the machine that calls them.
Layouts: a whole shrine in one setting
layout swaps the whole shrine the way ambientDrift's style swaps the particles. Fields a layout does not
name still apply (so seed, mood, quality and the rest stay yours), and layout = "custom" builds from
the fields alone.
| Layout | Stair | Lanterns | Torii and hall | Setting |
|---|---|---|---|---|
grandStair | terraced, rise 80 m over 190 m | mixed (all six) | vermilion myojin, foot torii, shrine hall | the full mountain shrine with waterfall and cherry trees (the kit's own defaults) |
hillside | straight, 30 m over 80 m, narrow | yukimi | natural shinmei, hokora | a small open hill, light cedars, no waterfall |
gorgeFalls | switchback, 120 m over 230 m | toro (bronze, on posts) | vermilion myojin, foot torii, shrine hall | a deep cedar gorge beside the waterfall |
cliffZigzag | zigzag, 90 m over 150 m | tsuri (gabled frames) | vermilion ryobu, hokora | a steep cliff stair with the falls |
templeApproach | terraced, a wide 5 m stair, 24 m over 140 m | tachi (tall pedestals) | natural myojin, shrine hall | a grand, gentle approach lined with cherry trees |
forestPath | winding, 45 m over 160 m | oki | natural shinmei, hokora | a quiet path through dense cedars, no foot torii |
festivalStair | arc, 50 m over 130 m, wide | paper (chochin and andon) | vermilion myojin, shrine hall | a festival stair: lanterns close together, cherry trees |
ruinedShrine | winding, 60 m over 150 m | oki, sparse | weathered myojin, no hall | a forgotten shrine with the falls, almost no blossom |
shrine.component.add("lanternStair.LanternStair", { layout = "hillside" }) -- a small hill shrine
shrine.component.get("lanternStair.LanternStair").layout = "festivalStair" -- rebuilds as a festival stair
Forest sightlines: keeping shots clear of trees
The cedars are planted everywhere except along the shots listed in Layout.SIGHTLINES. Each entry is
{ eye, target, upto?, pad?, cutGround? } in the shrine's own frame (x up the stair, y up, z across):
- What is cleared. Every tree whose trunk or crown would stand in the line of sight within
padmetres (default 1.5). Where the line runs through the crowns, the whole crown is kept clear; where it runs at eye height below them, the trunks are kept 2.2 + 0.8 × pad metres away (3.4 m at the default) and the crowns stay overhead, so an eye-level shot looks down an avenue rather than across a clearing. - How far. To 2 m short of the target unless
uptogives another distance in metres from the eye. - Ground.
cutGround = truealso lowers the ground under the line (a camera path through a hillside). - Where to put it, and when. Anywhere, at any time:
Shrine.setSightlines({ ... })from a module or scene script every machine runs. A shrine that is already built notices within a second and rebuilds, so the order of scripts does not matter.Shrine.setSightlines({})plants everywhere,Shrine.setSightlines(nil)restores the kit's own lines (the Tsukimichi film's shots).
local Shrine = require("lanternStair.Shrine")
Shrine.setSightlines({
{ { -60, 2, 0 }, { 40, 20, 0 } }, -- from the valley floor up the stair
{ { 20, 30, -40 }, { 80, 40, 0 }, nil, 3 }, -- a high side view, a wider gap
})
Landmarks
Shrine.landmarks() answers world positions { x, y, z } (they follow the shrine's entity if it is moved
or turned): valleyFloor and valleyAvenue (eye height on the valley floor and in the cedar avenue),
footTorii, stairFoot, stairQuarter, stairMid, stairThreeQuarter, stairTop, torii (its foot) and
toriiTopBeam, hall, terrace, overlook (the open eastern edge), waterfallLip, waterfallPool,
waterfallView (a good spot to film the falls from), streamMouth, and moonDirection (a unit vector).
Performance
Cedars (procedural Sugi meshes: a trunk and a crown of crossed spray cards, three levels of detail), rocks,
ferns, moss, lantern stones and posts are hardware-instanced (one draw per part per level of detail) with three
levels by distance. While a cutscene plays (filmRig or any other), each shot's levels are chosen once for the
whole of its camera path, prepared before its cut and put in a frame or two before it, so nothing changes detail in
the middle of a shot and the new shot is settled on its first frame; otherwise the groups follow every camera
drawing (including a transition's second camera), a few per frame, with hysteresis, and all at once after a jump.
Cedars, cliffs and outcrops cast shadows at every level; small undergrowth only up close. Atmos sets a shadow
caster cutoff per tier (240 m / 170 m / 110 m, and a minimum on-screen size). The far
ridges are one unlit mesh. Lantern papers glow through a dozen shared glow-level materials, and only a handful
of real point lights (10 high / 4 medium / 3 low) stand in the lit lanterns nearest every viewpoint: a lantern keeps
its light until another is clearly nearer, a light that has to move fades out (0.8 s) and fades up on its new
lantern (0.6 s), and on high the nearest 3 shadow-capable lanterns fade their shadows in and out (0.9 s) through a
shadowed twin light, so posts, plinths and ferns throw shadows across the moss without popping. High and medium also run the engine's ambient occlusion (@builtin::systems.ambientOcclusion) and screen-space contact shadows (@builtin::systems.contactShadows), set per mood by Atmos; low runs neither.
quality (auto = low on phones and tablets, medium in a browser, high natively) thins the cedars (up to 1500
high), undergrowth and ground resolution (2.5 m / 3 m / 4 m) and sets how finely the volumetric air is marched
(32 steps high, 10 medium, off on low). Medium is the browser tier and is kept lean for it (1.6): half the air steps, shadow-free lantern lights, a 25 m volumetric shadow reach and a 110 m shadow caster cutoff.
Measured in the Tsukimichi world (native desktop editor, high, default fields, edit mode): build 0.9-1.5 s;
1,002 cedars + 2,112 undergrowth/rock instances + 50 lanterns, 484 steps; the shrine's own script 0.3-0.8 ms a
frame. GPU at 3200x1756 with the volumetric air on: 44 ms of timed passes (volumetric scatter ~6 ms, static
shadow raster ~6 ms); in a headless 1920x1080 client the frame went from 151 ms (126 ms GPU, 64 ms of it the
static shadow raster) before the 1.1 rework to 36 ms. Not yet measured in a browser or on a tablet.
Guides
- How to make a Japanese shrine scene with a torii gate and stone lanterns (
guides/how-to-make-a-japanese-shrine-scene-with-torii-gate-and-stone-lanterns.guide): every field, stair shape, lantern, torii, hall and mood, lighting lanterns on cue, landmarks for cameras. - Example: a small hillside shrine with lanterns that light up at night (
guides/example-a-small-hillside-shrine-with-lanterns-that-light-up-at-night.guide): a step-by-step small level with lanterns lit at dusk, fireflies and a short filmRig intro.
Parts
LanternStair (component), Shrine (API), Layout (the plan and ground height, pure), Build (ground,
stair, colliders), Lanterns (the chain), Forest (cedars, undergrowth, rocks), Waterfall, Moods,
Looks (runtime materials), Instancer (instanced LOD draws), Sugi (procedural cedars), Ridges (layered far
ridgelines), Atmos (volumetric air, grade and post per mood and tier), shaders/shrineGround, shaders/shrineRidge.
The shots kept clear of trees (and of ground, where marked) are Layout.SIGHTLINES, set with Shrine.setSightlines
at any time (see Forest sightlines).
What changed in 1.7.0 (no more popping)
- Lantern lights no longer pop or jump. The real lights used to be re-handed to the nearest lanterns every fifth of a second, so light pools switched on and off in one frame as the camera moved. Now a lantern keeps its light, a light that has to move fades out and fades up again on its new lantern, and lantern shadows fade in and out instead of switching (a shadowed and an unshadowed twin light, crossfaded).
- Dissolves and wipes keep the outgoing shot lit. The lights and levels of detail now serve every camera that is drawing (a film's second camera filming the outgoing shot into a texture), not only the active one, and while a cutscene plays they also prepare the next shot before its cut.
- Trees, rocks, ferns and moss hold their detail through a shot. During a cutscene each shot's levels are set once for its whole camera path; no level changes in the middle of a shot, and a new shot is fully settled on its first frame instead of over several. Far cedars, cliffs and outcrops keep their shadows.
- The sunset (any mood change) blends smoothly. Golden hour's contrasty AgX Punchy look is now an amount
(
shaders/agxPunch, a display-space pass on the plainagxcurve) that blends with the mood, instead of the display curve switching fromagxPunchytoagxhalfway through, which flipped the picture to flat grey in one frame. - Lanterns whose prop says their light casts no shadow never take a shadow, so they always light the stair all
the way round; the shadow goes to the nearest lanterns that can cast one. From sengokuProps 1.0.5 that is every
stone lantern (Kasuga, Yukimi, Oki, and the Kasuga head of
tachi): their light sits in a stone fire box with a few small windows. The paper and bronze lanterns (tsuri,chochin,toro) keep their shadows. Each lantern's light now stands at the prop's own light point, turned with it. - Cheaper per frame: lantern glow flicker is written 30 times a second instead of every frame, and a local mood blend re-lights the sky at 15 Hz.
- 1.7.3: built on ambientDrift 1.0.21, recorded against it, so one ambientDrift is installed with the shrine and its particle fields (fireflies, petals, dust, spray) fade out next to the camera instead of flashing for a frame. 1.7.2 still pinned an older ambientDrift for the waterfall and the shrine's clock link, so a fresh install held the old fields and a second card shader beside them.
- 1.7.2: every stone lantern (Kasuga, Yukimi, Oki and the
tachiKasuga head) now lights the stair all the way round and casts no shadow, because sengokuProps 1.0.5 marks all three stone styles that way (1.0.4's Yukimi line never reached its release). The shadowed lights go to the paper and bronze lanterns. Built on sengokuProps 1.0.5 and ambientDrift 1.0.20 (particles fade out next to the camera instead of flashing for a frame), and on Cloudburst 1.5.2, the same release worldClockKit 1.7.8 uses, so a world that installs both holds one Cloudburst (1.7.1 pinned a second, nested copy). - 1.7.1: a shrine built before the kit was updated (a live update while the shrine stands) no longer throws an error every frame from the light pool; it keeps its lights until it rebuilds.
- New:
Viewers(every viewpoint now and next, from cameras and the playing cutscene) andLanterns:lightState()for checks.
Known limits
- The cedars are procedural (crossed spray cards textured with alpine spruce needles); the silhouette and trunk are a sugi's, the needle texture up close is a spruce's.
- In free flight (no cutscene playing) a tree or rock can still change level of detail in one frame when the camera crosses a band edge (the cedar and rock materials come from forestMaterials and the engine PBR, which cannot dither a crossfade); hysteresis keeps it from flickering back and forth. During a film no level changes mid-shot.
- The camera-side look (volumetric air, display curve
agxwith thelsPunchpass, bloom, colour tables, vignette) is set by the shrine on every machine; another system that drives the same post passes or the scene's volumetric lighting will fight it. - The ground is a runtime mesh, not the engine's terrain system, so terrain tools do not edit it; change the seed or fields instead.
- Turn the shrine only about Y; the torii frames the moonrise only when the stair climbs east (unturned).
- Blue hour keeps a strong sky fill (about as strong as the moonlight,
fill = 1). Lowered, the blue-hour frame goes black, because of engine issue #26516 (how night-sky light reaches the scene at dusk); the night mood does not have the problem. LeaveMoods.PRESETS.blueHour.fillat 1 until engine issue #26516 is fixed.
1.6.3 notes
- The opening paragraph (what ZeroMind shows on the package's card) says how to install the kit and add the first shrine, and no longer loses its lantern list to a line that began with a bracket. Built on ambientDrift 1.0.19. No change to the shrine.
1.6.2 notes
- The README's version line says the release it belongs to (1.6.1 still said 1.6.0). No other change.
1.6.1 notes
- Docs say what 1.6 holds. The top of this README and the package description name the eight layouts, the six stair shapes and the nine lantern kinds (they still said four shapes and six lanterns).
- The kit's world has a working showcase again: it opens on
layout = "grandStair", and a panel (or keys 1-8) swaps between all eight layouts and the three moods while you walk. - Built on the current engine library (ca6727b) and ambientDrift 1.0.18. No change to the shrine itself.
1.6.0 notes
- Whole shrines in one setting. New
layoutfield with eight shrines (grandStair,hillside,gorgeFalls,cliffZigzag,templeApproach,forestPath,festivalStair,ruinedShrine), each swapping the stair, lanterns, torii, hall, waterfall and trees together.custom(the default) is the fields as before. - More stairs and lanterns. Two new stair shapes,
arc(one long sweeping bend) andzigzag(seven short steep legs up a cliff). Three new lantern styles:chochin(long paper lanterns on timber posts),andon(paper floor lanterns) andpaper(the two alternating, a festival stair). - Follows the time of day out of the box.
moodnow defaults toauto: the shrine follows the scene's WorldClock (golden hour by day, blue hour with the lanterns lighting at sunset, moonlit night after dark) without driving it. A named mood behaves exactly as before. After a film,Shrine.followShared(3)lands on the clock's mood of that moment. - Right for a small valley and a deep gorge without tuning.
airandmistdefault to auto (-1) and follow the shrine's size: thin air and light mist on a low hill, the full depth in a gorge. - Sightlines that clear what you expect. A line now clears to 2 m short of its target (was 12 m), an
eye-level line keeps the trunks 3.4 m away (was 2.3 m), and
Shrine.setSightlinesworks at any time: a built shrine rebuilds within a second. The README section "Forest sightlines" says what is cleared and where to put the call. - Dusk you can see. Golden-hour sky fill 1.35 (was 1) and blue-hour fill 1.7 with exposure 2.1 (were 1 and 1.6), so ground, moss and steps read in the dusk foregrounds instead of falling to black.
- Lighter in the browser. The medium tier (what a desktop browser gets) marches the air in 10 steps (was 16), its lantern lights cast no shadow maps, 4 real lantern lights (was 6), shorter shadow reach.
- Built on the current engine library (2c02fe3).
1.5.1 notes
- The shrine follows the time of day without driving it. New
followClockfield (default on; used only withdriveClock = false): the shrine's own mood (lanterns, mist, air, grade) follows the scene's WorldClock: goldenHour by day, blueHour from sunset (solar 18.0) with the lanterns lighting up the stair, moonlitNight from 19.4, back at dawn, blended over 20 s. Late joiners andfollowSharedland on the clock's mood. Fixes the shrine coming back golden at night after a film. No effect without a WorldClock. - Thinner air for small shrines. New
airfield (0-3, default 1) scales each mood's volumetric air; 0.3-0.5 suits a low hill or an open valley that 1 washes white at blue hour (Atmos.setAir). - Docs that match the code.
riseandrunstate their clamps (20-160 and 40-420) in the field hints, README and guides. TheLayout.SIGHTLINESdocs say how the forest really clears (crown radius plus pad where the line runs at crown height, only the trunk below it, 1.4 + 0.6 × pad; lines stop 12 m short of the target unlessuptois given) and that the table must be set in a module every machine requires. - Tidewater 1.1.12 (river docs, Tidewater issue #11).
- Contributed through pull request #6, released as 1.5.1 (the pull request branch published its own 1.5.0). Its Cloudburst teardown fix is in Cloudburst 1.5.4; this kit still installs the Cloudburst release ZeroMind serves for it (1.4.5), which logs harmless
entity(...) returned nillines on a scene reload.
1.4.10 notes
- Current engine library (33551d3), on ambientDrift 1.0.16. Built in a world holding an untouched install of the ambientDrift 1.0.16 release, so a world that installs lanternStair, alone or beside ambientDrift 1.0.16, holds one ambientDrift. No change to the shrine.
1.4.9 notes
- Current engine library (c98faf2), on ambientDrift 1.0.15. Built in a world holding an untouched install of the ambientDrift 1.0.15 release, so a world that installs lanternStair, alone or beside ambientDrift 1.0.15, holds one ambientDrift. No change to the shrine.
1.4.8 notes
- One ambientDrift, the released one. The kit's world held 16 ambientDrift files as edits of its own (the effect graphs, its thumbnail and api module, rewritten by engine-library updates), so each lanternStair push carried its own altered copy of ambientDrift, and 1.4.4 to 1.4.7 pinned that copy instead of the release. ambientDrift is now a fresh, untouched install of the 1.0.14 release in the kit world, so 1.4.8 pins ambientDrift 1.0.14 itself: a world that installs lanternStair, alone or beside ambientDrift, holds one copy. No change to the shrine.
1.4.7 notes
- One ambientDrift in every world that installs it. The kit's world had committed an engine-redrawn ambientDrift thumbnail, so 1.4.4 to 1.4.6 were published against that world's own altered ambientDrift instead of the 1.0.14 release, and a world installing lanternStair beside ambientDrift ran it twice. The kit world now holds the release byte for byte, and 1.4.7 pins ambientDrift 1.0.14 itself. No change to the shrine.
1.4.6 notes
- One ambientDrift, for real. The engine had redrawn ambientDrift's preview thumbnail in this kit's world, so 1.4.4 and 1.4.5 were published against this world's own copy of ambientDrift instead of the 1.0.14 release, and a world installing lanternStair ran ambientDrift twice. The thumbnail is back to the release's, so 1.4.6 pins ambientDrift 1.0.14 itself. No change to the shrine.
1.4.5 notes
- Pins the ambientDrift 1.0.14 release itself. 1.4.4 was published together with the update of its own ambientDrift copy, so it pinned this kit world's copy instead of the release; a world installing it then ran ambientDrift twice. 1.4.5 is published with that copy untouched, so it pins the 1.0.14 release and a world that installs both holds one copy. No change to the shrine.
1.4.4 notes
- Takes ambientDrift 1.0.14, the newest release, so a world that already held an earlier lanternStair moves forward to a single ambientDrift copy (1.4.3 pinned 1.0.13, which a world holding 1.4.2 could not move back to). No change to the shrine.
1.4.3 notes
- Golden hour with contrast. The golden air is back at density 0.0048 (falloff 0.04, anisotropy 0.62, light scale 1.3), but its ambient in-scatter colour is about a third as bright (
color = { 0.34, 0.27, 0.2 }), so the low sun still cuts shafts while the frame no longer sits in a beige veil: trunks stand apart from their shadows on the ground and the far trunks hold. The golden sky fill is back at 1. - Night exposure 3.1 (was 3.4): deeper night with the same quarter-of-the-moon fill and contact shadowing; the stair, lanterns and torii still read.
- Blue-hour fill stays at 1; the limit now names the engine issue it waits on, #26516.
- One ambientDrift. Published against the unmodified ambientDrift 1.0.13 release, so an install places one copy of it.
- Engine library moved to the current version.
1.4.2 notes
- The engine library (
@builtin) moved to the current version (a85225d), and the kit world was tidied: ambientDrift is the unmodified 1.0.13 release, the sengokuProps install the shrine builds from is kept, and leftover waterfall-effect install records nothing used were removed. No change to the shrine.
1.4.1 notes
- From a newcomer's install of 1.4.0 in an empty world (the shrine built, the lanterns lit, all three moods and the stair, lantern and torii variants swapped with one change). The README now states its own version, and the package ships only its two current guides: the superseded
how-to-build-a-japanese-mountain-shrine-with-a-lantern-stairwayandexample-a-small-hillside-shrine-with-a-torii-and-lanterns-that-light-at-duskguides, which a pull request could not delete, are removed. No code changes.
1.4.0 notes
- Depth in the moonlit night. The soft sky fill at night is now about a quarter of the moonlight (it was as strong as the moon), so trunks, steps, lanterns and the torii have a lit side and a shadow side; exposure is raised (1.7 to 3.4, neutral
agxcurve) so the shot still reads, and the night air is thinner (0.0055 to 0.0014) so the cedar avenue is no longer a flat blue wash while moon shafts still cut through. Per mood, inMoods.PRESETS:fill(sky fill against the sun or moon) andmoonMin(the lowest the moon stands, in degrees); both blend by hour with a mood change and apply on the shared clock as well as in a local film view (Moods.shape). - Contact shadowing. High and medium quality run the engine's ambient occlusion and screen-space contact shadows, set per mood in
Atmos.PRESETS(ao,aoRadius,contact): darker corners, seams where the trunks, plinths and steps meet the ground. - Lanterns cast real shadows. The 3 lantern lights nearest the camera (1 on medium, none on low) cast shadows: lantern posts, plinths and ferns throw long shadows across the moss (
Lanterns.buildoptionshadowLights). - Golden hour is clearer. The golden air is thinner (0.0048 to 0.0026, falloff 0.05) so the cedar avenue no longer washes out; the trunks and their shadows stand apart while the shafts stay.
- The moon stands over the torii at blue hour. It was hugging the horizon (7°) and hidden behind the ridge; it is held at least 24° up, so it hangs in the torii as you climb.
1.3.11 notes
- Really one copy of ambientDrift 1.0.12. 1.3.9 and 1.3.10 still installed extra ambientDrift copies next to the real one: the engine had recomputed the effect's preview thumbnail in this kit's world (the thumbnail comes out slightly different on every machine), so the copy counted as edited and was published as this world's own version, with no code in it. The thumbnail is back to the one the release ships, so the copy is 1.0.12 exactly and the dependency entry and every file take that one release.
1.3.10 notes
- One whole copy of ambientDrift 1.0.12. 1.3.9 updated the particle kit in place, and three of its files plus this kit's dependency entry kept pointing at older ambientDrift releases. 1.3.10 carries a clean install of 1.0.12, so every file and the dependency entry take that one release.
1.3.9 notes
- Takes ambientDrift 1.0.12, the release whose README has a "Known limits" section: a field can take tens of seconds to appear when many effects start at once (this kit starts its spray, mist wisps and firefly fields together), editing a playing effect makes it vanish for a while, and a frame-by-frame recording can miss a field. No change to the shrine itself. Built on the current engine library.
1.3.8 notes
- One whole copy of the drifting-air particles kit. 1.3.5 still pinned ambientDrift at two releases: the complete 1.0.10 for nearly every file, and an incomplete one for the shared particle part every effect builds on (
parts/field.procGraph) and for this kit's own dependency entry. In a new world the waterfall's spray and mist wisps then failed with "no node is called '~/parts/field'". Every ambientDrift file, and the dependency entry, now come from the one complete ambientDrift 1.0.11 release (1.0.10's latest release was a pull-request merge that placed without code).
1.3.5 notes
- The drifting-air particles kit now installs whole with this kit. 1.3.3 and 1.3.4 still placed an ambientDrift copy without its code in a new world, because the copy this kit was published with had files that were never committed and two old guides left behind. That copy is now a clean install of ambientDrift 1.0.10, so an install of this kit brings the whole of it, and the spray and mist wisps build over the plunge pool.
1.3.4 notes
- Spray and mist over the plunge pool, for every install. 1.3.3 meant to fix this but shipped an incomplete copy of the drifting-air particles kit (ambientDrift) with no code in it, so in a new world the waterfall's spray and mist wisps still did not appear. The kit now uses the published ambientDrift 1.0.10 as is: an install places one complete copy of it, and the spray and the mist wisps build over the pool.
- A missing ambientDrift is reported. If the particles kit cannot load, the waterfall now logs a warning saying the pool's spray and mist wisps need it, instead of leaving them out without a word.
1.3.3 notes
- Spray and mist over the plunge pool for everyone who installs the kit. The kit recorded the drifting-air particles kit (ambientDrift) at its first release, 1.0.0, so an install brought that old copy in beside the current one, and its waterfall spray and mist wisps failed to build (a warning at every start, and nothing rising off the pool). The kit now uses the current ambientDrift (1.0.8), one copy.
- No Tidewater warnings at start. The waterfall no longer asks Tidewater for spray (Tidewater offers spray only as a one-shot) or mist (its mist effect does not build on the current engine). Neither ever drew anything; the spray and mist you see come from the kit's own ambientDrift fields and the cloudburst fog bank at the foot of the falls, and Tidewater still adds its drips.
- Built on the current engine library.
1.3.2 notes
- Blue hour and the night are no longer black when a mood blends in. A mood blend kept a value that only the mood being left names: golden hour's punchy tone curve stayed in force through blue hour and the moonlit night, crushing the dusk stair, the lanterns and faint lights such as fireflies to black (a mood set at once looked right, which hid it). A value only one side names now switches at the midpoint of the blend, so every mood shows its own curve.
- The lantern lighting is the moment it should be. Lantern paper glows twice as bright (bloom catches each lantern as it lights) and each lit lantern throws nearly twice the light on the stair, moss and landings around it.
1.3.1 notes
- Blue hour you can see into. Blue hour was darker than the moonlit night (exposure 1.4 against 1.7), so a wide dusk shot crushed the moss and forest floor to black. Now exposure 1.6 with more contrast and a little more colour, thinner cool air (0.003) and slightly lighter moss and litter: the stair, trunks and ground read in cool light while the lit lanterns stay warm against them.
- Golden-hour haze thinned (air density 0.0048, sun scattering 1.3): the low sun still cuts shafts between the cedars, but no longer turns a third of a wide shot to flat orange.
1.3.0 notes
-
No error while a mood blends. Blending from golden hour (which names a tone curve) to blue hour (which does not) raised
nil - stringon every frame of the blend; numbers now blend, names switch at the midpoint and a value only one mood names is held. -
Blue hour reads as dusk. It sat at solar 19:00, which is night (sun about 15 degrees down): now solar 18:33, a few degrees below the horizon, so the stair, moss and cedar trunks read in cool light with the lanterns warm against them.
-
A moonlit night you can see. More fill from the night sky (ambient 3.8), stronger moonlight (1.35) and exposure 1.7, with the moon itself a little dimmer so it does not clip: the foreground no longer crushes to black.
-
Golden-hour sky has a bluer zenith over a warm horizon instead of a grey one.
-
Waterfall on Tidewater. The falls are Tidewater's
waterfallkind (feed reach over the lip, ballistic curtains that tear into streaks, churned plunge pool, mist and drips) instead of the Procgen Effects Showcasewf_sheet/wf_poolshaders, which no longer pass the current engine's checks;effectShowcaseis no longer a dependency. The rock face curls back into the spur at its ends and the upright alpineProps cliff faces round the gorge are replaced by turned, tilted outcrops, so the spur reads as broken rock rather than slabs.
1.2.1 notes
- Golden hour is a misty dusk. Solar 17:33; the
tsukimichidusk palette is warmer with a lower, warm-neutral fill (no lavender wash); the volumetric air is denser and held low in the valley (density 0.016, falloff 0.032, anisotropy 0.55) so shafts show down the valley and between the cedar ranks; valley mist 1.15; exposure 1.1 with a warm grade. - Stair artifacts fixed.
Build.prismwound its side faces inward on the stair (and its tops downward on lantern plinths and posts), so back-face culling drew the boxes' insides: the dark wedges on treads, risers and cheek walls. Every face is now wound outward whichever way the corners are given. Treads and landings are darker weathered granite and flagstones (Looks.step,Looks.landing). The waterfall rock face's triangles were also wound against their normals; fixed. - Waterfall. Four staggered
wf_sheetcurtains (back, body, main, front veil; 6.4-10.6 m wide, translucent) instead of three narrow ones; alpineProps cliff faces frame the gorge, break up the spur's flanks and lip the notch (lichen granite with distance levels of detail); ambientDriftwaterSprayat the plunge and up the face andmistWispsover the pool (GPU particles; fewer on lower tiers); stronger pool foam. - Blue hour and night. Night fill is 2.6 (was 3.4) with exposure 1.75 / 1.9 (was 1.9 / 2.5), so the frame keeps contrast instead of a flat lavender wash; cedar needles darken per mood (
needleBase), ferns are a kit-owned runtime material whose translucency follows the mood (fernTrans: warm at golden hour, almost none at night, never neon), moss and litter are dimmer at night, terrace gravel and paving are darker, and the lantern lights are brighter (38, radius 16). - Exposure owner.
Atmoschecks the display exposure once a second while no cutscene plays and puts the mood's value back if something else (a film lens that ended) left its own behind, so the free camera after a film is never left too bright. Measured luma p50 with a plain camera: golden 50-82, blue 42-66, night 52-59 at the trailer stations. - Six lantern types.
tachiandtsurijoinkasuga,yukimi,okiandtoro;mixedcycles all six along the climb (Yukimi on the landings). Pedestals and frames are merged meshes (one draw each), the lantern heads stay instanced, and they light the same way. - Weathered torii.
toriiFinish = "weathered".
1.2.0 notes
- One grade owner. With
postFx = "auto"(default) the shrine removes its own bloom, grade, colour tables and vignette while a cutscene plays (@builtin::modules.cutscene.isPlaying, checked 4x a second) and puts them back when it ends, so a filmRig lens grades the film alone. Exposure (__display__) and the volumetric air stay the shrine's in every case. - No runtime asset writes. The three colour tables (gold, blue, night) are built in memory once per machine as GPU textures (
lut.fromGrade+renderer.texture.create); nothing is written to the world's source at runtime. - Sugi crowns are layered rounded foliage clumps (a burst of spray cards on a short branch per clump) on the upper ~50 % of the trunk; the far levels keep fewer but bigger clumps so a distant cedar still reads as a solid dark-green column.
- Ground: the cedar-litter texture is desaturated and moss biased up, so the forest floor reads green-brown instead of rust.
- Golden hour sits at solar 17:12 (sun clear of the western ridge, so the slope is lit and the volumetric air shows shafts); the
tsukimichisky's dusk and night ambient were raised so blue hour and night stay readable. - Quality tiers: high (air 22 steps, casters to 240 m), medium (air 10 steps / 3 shadow steps, casters to 150 m, 754 cedars), low (no volumetric air, casters to 90 m, 556 cedars).
auto= low on phones, tablets and small browser screens, medium in a desktop browser, high natively. - Night readability. The
tsukimichisky's moon light (moonI3.6, about 2.1 at moonlitNight) and its dusk and night ambient (ambI1.8 / 3.4) are raised. Per mood,Atmosalso sets the cedar needles' translucency and sheen (a cool silver rim at blue hour and night), the forest-floor tints (dimmer, desaturated moss at night so a moonlit far slope never glows green), and air that reaches farther (260 m / 320 m). The top terrace's raked gravel is a darker runtime copy of sengokuMaterials'rakedGravel(Looks.gravel).