Tsukikage Castle Town: A Sengoku Town of Rooftops, Temples and Rice Terraces, with a Town Builder
- ..
- .metadata15 B
- Bake.module
- BakedBuildings.module
- BakedMaterials.module
- BakedSmall.module
- BuildingBake.module
- BuildingCastle.module
- BuildingCatalog.module
- BuildingGen.module
- BuildingTemple.module
- BuildingTown.module
- Geo.module
- PropGallery.component
- PropGallery.scene
- PropMaterials.module
- Props.module
- README.md18.5 KB
- SengokuProp.component
- SmallBake.module
- SmallCatalog.module
- SmallGen.module
- SmallGenBridges.module
- SmallGenFences.module
- SmallGenGates.module
- SmallGenGoods.module
- SmallGenLights.module
- SmallGenNature.module
- SmallGenStreet.module
- SmallKit.module
- SmallShapes.module
- SmallSpecs.module
- galleryGround.material
- inkHull.material
- meshes
- package.yaml1.1 KB
- sengokuBuildings.testSuite
- tests
README.md
sengokuProps
Late-16th-century (Azuchi-Momoyama) Japanese castle-town props for any world: machiya townhouses, storehouses, farmhouses, castle keeps and walls, temples, walk-in tea house and castle hall, and the street props around them. Every kind has variants, three baked levels of detail, four looks and colliders that match what is drawn.
Put a machiya in an empty world
-- a ground to stand on, a sun, and a 3-ken merchant townhouse facing the street (local -Z)
local sun = entity.spawn("sun")
sun.component.add("Light", { kind = "directional", intensity = 3, directionX = -0.4, directionY = -0.7, directionZ = 0.5 })
local ground = entity.spawn("ground", { position = { 0, -0.5, 0 } })
ground.component.add("Model", { model = "@builtin::meshes.cube" })
ground.localScale = { 60, 1, 60 }
ground.component.add("BoxCollider", {})
local shop = entity.spawn("shop", { position = { 0, 0, 0 } })
shop.component.add("sengokuProps.SengokuProp", { kind = "machiyaMerchant3", look = "realistic", variant = 1 })
-- change it live: every peer rebuilds from the synced fields
shop.component.get("sengokuProps.SengokuProp").look = "weathered"
SengokuProp fields: kind, look (realistic | weathered | festival | toon), variant (1..n, wraps),
seed (non-zero picks the variant for scattering), collide (default on), lit (interior lamps of the tea house
and castle hall), detail (auto swaps LODs by screen size; near/mid/far pins one). The parts are local,
temporary children rebuilt from the synced fields, so every peer builds the same prop and nothing is saved twice.
Buildings
Local frame for every building: footprint centre on the ground (y = 0), street front facing −Z, 1 unit = 1 m, bays on the ken grid (1.82 m).
| Kind | What it is | Variants |
|---|---|---|
machiyaMerchant2/3/4 | 1.5-storey (zushi-2) shop, 2/3/4 ken. Ground front all dark timber: posts every ken, full-height koshi lattice (3 cm slats, 3 cm gaps) over shoji and a low dark board skirt, an open earthen doma bay with noren on a hook rail, display floor with a granite step stone inside. Tiled pent roof (hisashi) across the whole frontage, eave 2.5 m, 1.05 m deep, round end tiles, flashing ridge, exposed rafters and brackets. Low plaster upper storey with mushiko slatted windows. Main roof kirizuma or irimoya with tile courses, ridge cap, onigawara, a slight upward sweep at the eave corners. | gable/irimoya, white/earthen plaster, udatsu, noren colour |
machiyaArtisan2/3 | 1-storey workshop, front eave 2.35 to 2.6 m (the climb-up houses): propped shutter (age-shitomi), board door with wicket, lattice. | eave height, shingle/tile roof, irimoya |
machiyaWealthy3/4 | 2-storey house with udatsu firewall wings (tile-capped), namako lower walls, full upper storey with lattice and shoji, pent roof at 2.6 m, a kura at the back (info.offsetZ). | namako, irimoya, open/closed front |
machiyaCorner | Irimoya corner house with a second shop face and pent roof on its left side (info.cornerSide = "left"). | 1.5/2 storey, 3/4 ken |
nagaya | Poor row tenement: 3 to 5 board-walled units under one long roof, stones on shingle roofs. | units, shingle/tile |
kura | Storehouse: thick plaster on a cut-stone base, namako skirt, kannon doors with their own roof, barred windows. | size, namako, stained |
minka | Thatched farmhouse: 0.7 m thick kayabuki irimoya/hip roof, earthen walls, engawa with a step stone. | 5 to 7 ken, irimoya/hip |
granary | Takakura on posts with rat guards, bamboo ladder (climbable) with a flat stone at its foot. | thatch/tile/shingle |
waterWheel | Overshot wheel on trestles with a flume; the part named wheel turns about local X through info.wheelHub. | radius 1.6 to 2.6 m |
teaHouse | Walk-in chaya: open front with noren and reed screens, earthen doma with benches, a granite kutsunugi-ishi under every front bay (earth 0 → stone 0.22 → tatami 0.45), tatami platform with black-lacquer tables, shoji on the back and both side walls (glow at night via SM.setGlow), board ceiling. | 3/4 ken, irimoya/gable, tile/shingle/bark |
castleHall | Walk-in goten: floor 0.75 m on posts, engawa all round, front steps (0.19 m rises), tatami rooms divided by gold fusuma painted with pines, ranma transoms, coffered ceiling, dark posts, tokonoma, door gaps front, sides and between rooms. | 7 to 9 ken, tile/bark |
keepBase | Battered, concave (ogi-no-kobai) dry-stone ishigaki: pillow stones over recessed joints, sangi-zumi long/short corner stones; info.top, info.topRect. | size, rough/dressed |
keepTierBase/Middle/Top | Stackable keep storeys (info.next / info.fits carry the sizes): skirt roofs, chidori and kara-hafu gables, black board bands on lower tiers, balcony and gold shachihoko on the top. | large/medium/small |
keep3/4/5 | Complete keeps on their stone base (info.tiers, info.top). | white/black-boarded |
castleWall, castleWallCorner | Dobei on stone with tile coping and loopholes (info.length). | length, style |
yaguramon, koraimon, sumiYagura, moatRevetment | Gates, corner tower, moat bank (info.length). | size |
templeHall | Hondo on a stone podium: bracket sets, deep upturned eaves, veranda with railing, stone steps then wooden steps (rises ≤ 0.2 m), step canopy. | size, dark/vermilion columns, bark roof |
sanmon, pagoda, bellTower, hokora | Two-storey gate, five-storey pagoda with sorin, shoro (info.bellHook), wayside shrine. | size, colour |
Vermilion lacquer appears only on shrines and temples; town houses use dark timber, charred cedar cladding
(charredBoard) and, in the weathered look, grey sun-bleached boards.
Looks. realistic; weathered (grey boards, stained plaster patches, sagging ridges, missing round tiles);
festival (realistic + a red/white kohaku curtain and chochin along every front eave; hooks are in
info.festival for any look); toon (thicker members, coarser tiles, inverted-hull ink outline).
Info for town builders. Props.info(kind) (and .byVariant[v]): footprint, height, climbHints
(eaves = { {y, z, x0, x1, what} }, ridge, ladder, baseTop), interior (floors with heights and zones,
doors, steps, ceiling), lights, festival, plus the per-kind points above.
API
local Props = require("sengokuProps.Props")
Props.kindsOf("building") -- { "machiyaMerchant2", ... }
Props.info("teaHouse").interior.floors -- { {y=0, surface="earth"}, {y=0.45, surface="tatami"} }
Props.parts("kura", { look = "weathered", variant = 2, lod = 0 }) -- { {mesh, material, name, offset?} }
Props.colliders("machiyaArtisan2", { variant = 1 }) -- local-space Collider list
Colliders
Each building answers a short list: boxes for walls, posts, floors, benches and steps, oriented boxes for ladders
and ridges, and mesh colliders for every sloped roof, generated from the same roof plane as the tiles and lifted
onto the round tiles, so the surface you stand on lies within 5 cm of what is drawn (the test suite raycasts it).
Every collider carries sengokuSurface (wood, tatami, stone, earth, grass); roofs carry noNav and
walkableRoof; stone bases, koshi lattice fronts, posts and ladders carry climbable. Pent roofs are mesh
colliders on the tiles at 2.5 to 2.6 m, so climbKit can mantle onto them from a bale stack or a stall roof. Interiors are
open: doorways have no collider, and every raised floor is reached by rises of 0.25 m or less (step stones, steps).
Budgets
Triangle budgets are limits the test suites enforce, summed over all of a kind's parts at one level of detail and taken from the worst look and variant. They are budgets, not measured counts.
| Category | Kinds | LOD0 | LOD1 | LOD2 | Enforced by |
|---|---|---|---|---|---|
houses: building | 11 townhouse and town building kinds | 16,000 | 8,000 | 600 | sengokuBuildings |
houses: farm | 3 farm kinds | 16,000 | 8,000 | 600 | sengokuBuildings |
big: castle | 14 castle kinds | 70,000 | 9,000 | 1,200 | sengokuBuildings |
big: temple | 5 temple kinds | 70,000 | 9,000 | 1,200 | sengokuBuildings |
| small props (all 58 kinds) | street, light, farm, gate, fence, bridge, nature | 4,000 unless listed below | fewer than its LOD0 | no more than its LOD1 | smallProps |
The house limit leaves room for the wealthy house's back kura; a machiya alone stays near 12k at LOD0.
Per-kind exceptions to the small-prop LOD0 budget of 4,000 (from the smallProps suite):
| Kind | LOD0 budget | Far (LOD2) budget |
|---|---|---|
archBridge | 9,000 (the hero crossing, one or two per town, never instanced in bulk) | |
bambooCluster | 13,000 | |
barrelStack | 12,000 | |
riceBaleStack4 | 10,000 | |
riceBaleStack3 | 7,000 | |
stallLarge | 8,000 | |
stallStraw, oxCart, kabukimon, bambooYoung | 5,000 | |
stoneWallLow | 3,500 | |
barrel | 2,600 | 120 |
toriiRyobu | 2,500 | |
riceBale | 1,000 | 120 |
chochin | 700 | 120 |
riceClump | 250 | 16 |
reeds, gardenRock | 4,000 | 60 (reeds), 120 (gardenRock) |
stallSmall, well and templeBell are listed in the suite at the default 4,000. The far budgets apply to the
bulk kinds placed by the hundred, which must be very cheap at a distance. Measured counts for the main small kinds
are in the small-props section.
Rebuilding
Generators: BuildingGen (roofs, walls, lattice, shoji, ridges, gables), BuildingTown, BuildingCastle,
BuildingTemple. After a change, rebake with require("sengokuProps.BuildingBake").bakeKind("kura") or
.bakeAll() (writes meshes/buildings/<kind>/, the manifest, BakedMaterials and the literal BakedBuildings
index the runtime reads). sengokuBuildings (test suite) checks meshes, materials, budgets, collider tags, roof
collider fit and the component. The PropGallery scene shows every building in every look.
Small props (street, light, farm, gate, fence, bridge, nature)
58 small kinds, each with 2 to 6 variants, three baked LODs and the four looks. Put one down like any kind:
local e = entity.spawn("stall")
e.component.add("sengokuProps.SengokuProp", { kind = "stallStraw", look = "festival", variant = 2 })
| Category | Kinds |
|---|---|
| street | stallSmall, stallLarge, stallStraw (market stalls; roofs 1.85 to 2.25 m, solid walkable slab collider tagged walkableRoof + noNav, climbable posts, counter as a step), norenShort, norenLong (variant = colour 1 indigo, 2 persimmon, 3 white + crest, 4 red, 5 green, 6 brown), kanbanHanging, kanbanStanding, kanbanRoof, nobori, barrel, barrelStack, crate, basket, bucket, trough, well, ladder (climbable), handCart, oxCart |
| farm | riceBale, riceBaleStack2/3/4 (stepped climbable box colliders, 39 cm risers), firewood, riceClump (instancing-cheap: LOD2 = 8 tris) |
| light | stoneLanternKasuga, stoneLanternYukimi, stoneLanternOki, chochin, chochinLong, andon, tsuriDoro, lanternString (6/10/16 m), taimatsu |
| gate / temple | toriiMyojin (vermilion 4.6 m, granite, vermilion 7 m, Inari 2.5 m), toriiShinmei, toriiRyobu, kabukimon, slidingGate, bambooGate, templeBell (bonsho + shumoku striker) |
| fence | fenceYotsume, fenceKenninji, fenceBoard, stoneWallLow, fenceBrush (segments tiling along local X, variants 1/2/3 = 1.8/2.7/3.6 m, info.length), fencePost (info.post names the joint post) |
| bridge | archBridge (12/16/20 m, smooth ramp colliders on the drawn deck), plankBridge, stoneSlabBridge, earthBridge: all span along local Z (info.span), deck meeting y = 0 at the banks |
| nature | bambooCluster, bambooYoung, pineTree, mapleTree, cherryTree, reeds, gardenRock |
Looks. weathered swaps to grey boards and tears cloth (noren, nobori, stall noren); festival adds corner
chochin and red/white bunting to stalls and a shimenawa with shide to torii and the kabukimon; toon uses chunkier
members (x1.3) at LOD 0 plus an inverted-hull ink part (inkHull material). Materials follow the look through PropMaterials.
Anchors. Hanging kinds (norenShort/Long, chochin, chochinLong, tsuriDoro, templeBell) have their origin at
the hanging point (info.anchor = "top"); kanbanHanging at the wall mount ("wallTop"); templeBell goes at a bell
tower's info.bellHook (info.strikerPivot, info.strikeHeight for animating the striker).
Lights. Every light kind gives info.lights = { { pos, color, radius } } (local; info.lightsByVariant[v] per
variant); taimatsu also gives info.fire for a flame effect. Paper and ember parts use the emissive-capable
lanternPaper / lanternPaperRed surfaces.
Sway. Cloth (noren, nobori, stall bunting, shide, sudare blinds) and foliage (bamboo, pine pads, leaves, rice,
reeds) carry the sway weight in vertex alpha (0 at the rod/base, 1 at the hem/tips). Foliage cards sway through
sengokuMaterials' foliage shader; cloth parts are baked with a sway flag (w = 1 in BakedSmall rows) and wear
the swaying copies of the cloth materials that sengokuMaterials ships (SengokuSway: compliance = 1 on sengokuSurface / sengokuToon, every look), so
noren and banners move in the engine wind and stall cloth bolts stay still. This package keeps no copies of its own.
Fitting to points (SmallGen).
local SG = require("sengokuProps.SmallGen")
local r = SG.lanternString({0, 4, 0}, {9, 4.4, 2}, 0.55, "festival") -- { parts = { {mesh, material, pos, rot, scale, name} }, lights }
for _, p in r.parts do
local piece = entity.spawn(p.name, { parent = holder, position = p.pos, rotation = p.rot, temporary = true })
piece.localScale = p.scale
piece.component.add("Model", { model = p.mesh, material = p.material })
end
for _, pl in SG.fenceRun("fenceKenninji", {0, 0, 0}, {12, 0, 3}) do
-- pl = { kind, variant, pos, yaw }: spawn a SengokuProp per placement
end
Budgets (worst variant, LOD0 / LOD1 / LOD2 triangles, realistic). Kinds placed by the hundred are kept tight, and kinds that repeat a piece (bale stacks, carts with bales, lantern strings) draw it one level coarser than the lone kind does:
| Kind | LOD0 / LOD1 / LOD2 | Test budget (LOD0) |
|---|---|---|
riceClump (v2 = a row of six) | 192 / 48 / 8 | 250, LOD2 ≤ 16 |
riceBale | 888 / 310 / 48 | 1000, LOD2 ≤ 120 |
riceBaleStack2/3/4 | 1.9k / 3.7k / 6.2k at LOD0, 288 to 960 at LOD1/2 | 4000 / 7000 / 10000 |
chochin | 576 / 268 / 84 | 700, LOD2 ≤ 120 |
lanternString (16 m, 12 lanterns) | 2.6k / 1.2k / 270 | 4000 |
handCart (loaded) | 2.7k / 1.0k / 520 | 4000 |
stoneWallLow (3.6 m) | 2.6k / 212 / 24 | 3500 |
barrel | 2.4k / 516 / 112 | 2600, LOD2 ≤ 120 |
norenLong | 896 / 356 / 24 | 4000 |
stallLarge | 7.5k / 2.9k / 240 | 8000 |
pineTree | 2.7k / 766 / 274 | 4000 |
bambooCluster | 11.8k / 2.2k / 216 | 13000 |
archBridge (20 m) | 8.2k / 2.6k / 928 | 9000 (the hero crossing, one or two per town) |
The smallProps test suite enforces a LOD0 budget per kind (4000 where none is listed), LOD1 strictly cheaper
than LOD0, LOD2 no dearer than LOD1, and the far budgets of the bulk kinds.
Count. The package holds 91 kinds: 33 buildings (see Buildings) and 58 small props, each with variants, three LODs and the four looks.
Rebuilding. Generators are SmallGen*.module (shapes from SmallShapes, prop pieces from SmallKit, specs
collected by SmallSpecs). After changing one, run require("sengokuProps.SmallBake").run({ kinds = { "well" } }):
it rebakes meshes/small/<kind>/ and regenerates the literal BakedSmall index that SmallCatalog registers from.
The PropGallery component shows them with categories = "street,light,gate,fence,bridge,nature,farm".
Lantern light and shadows
- A lantern's glowing paper (
paper,paperRed,paperWhiteparts) never casts a shadow: it is the light's own surface, so the light leaves through it. - An
info.lightsentry may saycastsShadows = false, and theSengokuPropcomponent (and lanternStair) honour it. - Every stone lantern casts no shadow (
stoneLanternKasuga,stoneLanternYukimiandstoneLanternOki, both variants of each). Their light sits inside a stone fire box that lets it out only through a few small windows, so a shadow-casting light there lights almost nothing around the lantern: the ground and steps near it go dark. Without shadows a stone lantern lights all the way round. - The paper and bronze lanterns (
chochin,chochinLong,andon,tsuriDoro,lanternString) and thetaimatsutorch light all the way round, and their lights may cast shadows.
Changes: 1.0.5 sets castsShadows = false on all three stone lantern styles (the 1.0.4 notes said the Yukimi's was
off, but that line never reached the release, so all six stone lanterns still cast). 1.0.4 stopped the paper casting
shadows. 1.0.3 was published by mistake from an old branch: skip it.
Known limits
- Look switching (realistic, weathered, festival, toon) has been verified rebuild-complete on a built town (one look fully replaces the last before it is dropped), but not yet checked the same way on the
PropGalleryscene itself. - Climb and navigation tags on colliders (
climbable,noNav) are plain attributes rather than climbKit's or navKit's own component types, so a world that does not follow sengokuTownKit's pattern has to know to read them itself.
Depends on
Versions are the ones installed in this world.
-
sengokuMaterials 1.0.1: every building and small prop part wears a sengokuMaterials surface.
PropMaterialsand the generatedBakedMaterialsindex pick the surface for each part and look (realistic,weathered,festival,toon), andSengokuMaterialsis required for them at run time. Cloth parts (noren, nobori, bunting, shide, sudare) wear sengokuMaterials'SengokuSwaymaterials, the wind-swaying versions of its cloth surfaces. -
groundMaterials 1.0.8 (Terra Firma): the generated
BakedMaterialsindex names three of its materials directly (groundMaterials.materials.wetMud,mossandlongGrass) as the realistic look ofmud,mossGroundandgrassMeadow, so it is a dependency of this package in its own right, not only through sengokuMaterials.