@tileflow/maps 0.1.0-alpha.2 → 0.1.0-alpha.20

package/README.md

@@ -1,205 +1,338 @@
-# `@tileflow/maps`
+# @tileflow/maps
 
-Official Tileflow maps and the assets they own.
+Official Tileflow maps with their icon, pattern, and font assets. Extend a map with
+`@tileflow/core`; render its prepared output with a framework adapter or MapLibre.
+
+> Related packages and guides: [documentation index](https://raw.githubusercontent.com/tileflow/tileflow-sdk/main/llms.txt).
+
+## Install
+
+```sh
+npm install @tileflow/maps@alpha @tileflow/core@alpha
+```
+
+Core is a peer dependency: it owns the map language and compiler. This package owns map definitions
+and assets. It does not include a tile archive, a browser renderer, or a hosted service subscription.
+
+## Use an official map
+
+Create `tileflow.config.ts`:
+
+<!-- docs:check -->
 
 ```ts
 import {defineMap} from '@tileflow/core';
 import {streets} from '@tileflow/maps';
 
 export default defineMap({
-  id: 'main',
+  id: 'madrid',
+  name: 'Madrid',
   version: 1,
   extends: streets,
   defaultTheme: 'dark',
+  view: {center: [-3.7038, 40.4168], zoom: 12},
+});
+```
+
+This inherits Streets' themes and changes only the default selection and initial view.
+Coordinates are `[longitude, latitude]`. To preview it:
+
+```sh
+npm install --save-dev --save-exact tileflow@alpha
+npx tileflow validate
+npx tileflow preview
+```
+
+Rendering can request remote tiles, glyphs, or terrain. Installing the package does not make those
+resources available offline.
+
+### Develop Streets in an SDK checkout
+
+After installing and building this workspace, run from its root:
+
+```sh
+node packages/cli/dist/index.js preview --config packages/maps/tileflow.config.ts
+```
+
+Open `http://127.0.0.1:3333`. Source edits reload in Inspector without publishing.
+Add `--scene nyc` for New York or `--against-theme dark --map streets-workbench` to compare themes.
+The CLI owns the interface; compiler and runtime changes require rebuilding those packages.
+
+## Choose a map
+
+- `streets`: contemporary street cartography with Mapbox-inspired time-of-day and color themes,
+  ranked POIs, Madrid transit network symbols, generic road-reference shields, and regional hillshade.
+- `baedeker`: warm travel-atlas styling, serif labels, original engraved patterns, and contours.
+- `civica`: illustrated civic-print styling with warm paper, olive parks, blue annotations, and
+  vermilion landmarks.
+- `map1777` (1777): 1777 ink and watercolor on current data, with 3D and four times of day.
+- `siegfried`: a terrain atlas with coordinated light/dark ink palettes, contours, and engraved patterns.
+- `soundings`: bathymetric reference cartography with depth bands, continuous relief, and port context.
+- `blueprint`: a dark architectural drawing style, with a default camera centered on San Francisco.
+
+Every official map is a complete, independent root using the same Core compiler. Official map
+objects are deeply frozen shared instances. Do not mutate them; use `defineMap({extends: ...})`
+to create an application-owned map.
+
+### Streets appearance
+
+Streets has twelve theme/time combinations. Inspector offers **Default**, **Faded**, and
+**Monochrome** independently of the Time of day control's `day`, `dawn`, `dusk`, and `night`
+presets. Default retains the configuration key `light`: `theme="light" timeOfDay="night"`
+selects `dark`, while `theme="light" timeOfDay="day"` selects `light`. The other concrete themes
+are `dawn`, `dusk`, `faded`, `monochrome`, `dawn-faded`, `dawn-monochrome`, `dusk-faded`,
+`dusk-monochrome`, `dark-faded`, and `dark-monochrome`. All twelve appearances share roads, label placement, fonts and icon artwork.
+Colors and lighting vary; flat-map colors are authored independently.
+
+Scene lighting is calibrated against Mapbox Standard while retaining Streets' slate-blue roads,
+neutral urban surfaces, pale warm rural ground, green parks and cream buildings. All appearances
+share category-colored POI discs and Maki pictograms. Lighting preserves sunlit roof paint and
+tints walls. Daylight uses neutral direct light (0.2) and ambient fill (0.8); buildings and
+map-shaded models keep ambient fill at night, with local occlusion at contacts and recesses.
+
+Below zoom 11, daylight draws a climate image separating humid and dry regions; it is
+loaded only there and is broad context, not surveyed vegetation. Other appearances keep it clear.
+Urban and education areas use neutral surfaces; farmland stays pale, mapped orchards and nurseries
+green. Activity areas tint the ground by activity until buildings take over. Footprints drawn
+by building parts (`extrude: false`) are omitted from the flat building layers. Streets
+suspends duplicate flat building footprints in 3D so roads remain visible under open landmarks;
+2D mode restores ordinary footprints. Normal 3D buildings keep a small neutral/active tone difference. Authored models use
+the neutral building color and independently configurable window shading.
+
+Streets packages DINish Medium for roads, house numbers and POIs, and Bold for shields, approximating
+the reference's DIN Pro lettering. Other roles retain Noto Sans Regular, Bold and Italic. All
+five faces ship with their licenses; DIN Pro is not bundled.
+POI discs use vivid category colors, 20px containers, and fixed native icon scale at every zoom.
+Maki's 15px artwork is composed into a centered 12px box, leaving room inside the 17px colored
+interior. Their 1x and 2x atlases rasterize these SVG compositions separately; the map displays
+each complete icon at native scale instead of rescaling the bitmap as the zoom changes.
+
+The day road network keeps major routes distinct at regional and city scales. Motorways and
+trunks gain a darker outline from z6 through z14, blending into the detailed treatment at z15.
+Regional connector widths remain readable between towns; their city casing palette holds through z14.
+Primary, secondary, tertiary and local roads widen slightly at intermediate zooms and converge
+with their detailed profiles at z15. Local streets become readable when their geometry arrives
+at z12. Casing passes sit below all receiving road fills, preventing exposed round segment caps
+at junctions. Links remain narrower and draw before receiving roads. Tunnel casings are dashed;
+surface and bridge casings are continuous. Construction fills and marks draw below roads in
+service. Crosswalks and compact blue-gray arrows fade in from z16.5.
+
+Surface footpaths and cycleways share geometry across appearances, at 92% of their authored
+width and without casings. Day uses white over mapped green ground and gray-earth elsewhere.
+The shared `roads.pathGround` compiler and browser protocol clip the green portions from the
+same vector tiles; a complete ground-colored path remains visible if context cannot load.
+Road carriageway outlines draw above these paths. This treatment belongs to the Streets
+definition and survives normal artifact regeneration in every palette and time preset.
+Road palettes, width profiles, building outlines and the overview backgrounds are authored here
+in Maps; consumers inherit them without installing a separately edited style snapshot.
+
+From z13, pedestrian plazas use an opaque pale surface above commercial zoning and below
+explicit grass, gardens and parks. The `roads.pedestrian.surface` token follows the ground's
+theme and time of day. From z17, mapped sidewalks add a translucent tint and dot pattern through
+`roads.sidewalk.surface`, preserving the underlying ground color.
+Mapped parking polygons use an opaque neutral fill above overlapping vegetation and below
+roads. This requires a `landuse` polygon classified as `parking`; parking POIs and aisle lines
+alone do not provide the boundary needed to fill the surface.
+Hedges (from z15, shaded from z17), fences and walls (from z16) come from `traffic_control`.
+
+Ferry routes fade in from z8, use fine blue dashes from z13, and show uppercase route names
+along the line from z15 when the data includes them. Their labels use a water-colored halo.
+
+Regional hillshade uses [Mapzen Terrain Tiles on AWS](https://registry.opendata.aws/terrain-tiles/)
+from z5 through z13, with source attribution. The 256-pixel Terrarium source is capped at native z12;
+closer views reuse that resolution, avoiding requests for coverage-dependent high-resolution DEM tiles. This is an additional remote data request. To omit
+it, set `terrain: 'none'` in a map extending `streets`. Hillshade does not change road geometry or
+raise the terrain. Buildings appear automatically from zoom 15 with an opacity fade through 15.25;
+the preview's **3D** control can hide them, and its **Trees** control enables vegetation.
+Streets rounds exterior building corners with a 1.5-metre radius and softens the roof-to-wall
+lighting transition (`threeDimensional.edgeRadius: 1.5`). Courtyards and tile cuts retain their shape.
+Shields use 9 px DINish Bold and closer spacing at z11–13. Street names yield to destinations
+and draw above flat footprints but below 3D buildings, with viewport-aligned letters.
+3D lights use a southern sun by day, southeast at dawn, southwest at dusk and western moonlight
+at night. At each moment, palettes share light direction, strength and shadow geometry;
+only light colors change. `controller.setSun({date, location})` uses the real sun instead.
+Streets enables `camera.adaptivePerspective`. See camera, landmark and lighting settings in
+[3D buildings](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/README.md).
+The buildings' `threeDimensional.lighting` and `shadows` options control the effect, and each
+theme's `lighting.sun.shadowIntensity` and `lighting.ambient` control its strength.
+Street lights are opt-in: set `roads.streetLights.enabled: true`.
+Streets uses `groundOcclusion: 0.07` and `groundOcclusionRadius: 1.5` for subtle ground contact.
+`buildings.threeDimensional.occlusion: false` disables contact and model occlusion.
+`buildings.contactShadow` styles the flat fallback.
+Streets selects Core's `labels.roadPlacement: 'ground'`: street names follow the road plane below
+buildings; POIs, transit names and shields remain above.
+Road names retain class zoom/size curves, favor major roads and add padding through z13.
+Pedestrian paths group separately. Compact types preserve language;
+`labels.roadNameFormat: 'full'` keeps source names.
+Disabling roads omits their names.
+Road rings, ramp and surface ordering use [Core's replaceable defaults](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/README.md).
+All non-day themes grade day's ground, water, roads, trees and 2D/3D materials across zooms:
+yellow warmth at dawn, dimmer stone at dusk, cool night. Day palettes stay unchanged.
+Each theme paints a [street sky](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/README.md) with night stars; `atmosphere: true`
+on a globe map adds space around it. Mercator and native targets remain supported.
+
+Streets enables model trees by default (`mode: '3d'`, `fallback: 'none'`). They stay three-dimensional
+in overhead and tilted interactive browser views. Disabling vegetation removes all trees. Renderers
+without model support omit them. Extensions can opt into the included flat crown artwork with
+`vegetation: refine({mode: 'flat'})`, or switch it with explicit view mode using `mode: 'auto'`.
+Seven forms cover rounded, spreading and upright broadleaf trees, conifers, columns, feather and fan
+palms. Light/dark crown images share their geometry. Rounded crowns have three large ovoid masses;
+upright trees have an oval crown and two lower lobes. Open trees have curved, tapered leaves drooping
+from branches; conifers are tiered. Broadleaf variants mix open and compact forms, smooth shading and
+varied colors. An eight-metre visual minimum scales smaller trees and crowns proportionally without
+changing source heights. All presets style bark and crowns independently.
+
+The models have 222–386 triangles nearby and 44–78 at distance, using Core's instanced tree
+renderer; flat crowns use the existing sprite atlas. Tree locations and attributes still come
+from the source tiles. The artwork does not add trees to parks whose data has none. See
+[3D trees](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/README.md) for
+browser rendering and platform support. To remove both representations, extend the map:
+
+<!-- docs:check -->
+
+```ts
+import {defineMap, disable} from '@tileflow/core';
+import {streets} from '@tileflow/maps';
+
+export default defineMap({
+  id: 'streets-without-trees',
+  version: 1,
+  extends: streets,
+  modules: {vegetation: disable()},
 });
 ```
 
-This still inherits both Streets themes; it changes only which concrete theme is selected by
-default.
+POIs follow World ranks and category density, with extra detail for parks and transport.
+Generic airport POIs are limited to rank 0 to reduce misplaced business listings; the dedicated
+airport label layer continues to label mapped airports. This display policy does not repair source data.
+Road-reference repetition is reduced at z11–13 and retains its detail interval from z14.
+Gardens stay at ranks 0–1 at every zoom, keeping principal destinations while omitting botanical
+collections and some small independent gardens. Other park and landmark types retain their usual
+eligibility.
+
+Cities and districts hand over at z15, smaller settlements at z13. Co-located cities share one
+anchor. Districts use rank gates below z12, then source availability and collisions. Street names use 0.15 em letter spacing and
+a 1 px halo; administrative regions use bold lettering and water names use italic lettering.
+Road spacing grows from 250 px at z13 to 300 at z15, 400 at z17 and 450 at z19 to curb repetition.
+House numbers start at z17 with wide padding. Labels default to the local language.
+
+The map uses Tileflow data and assets, including packaged DINish and Noto Sans fonts. The
+reference uses DIN Pro Medium, so font shapes and stroke weight
+remain an approximation. Available POIs, abbreviated names,
+proprietary landmark models, transit branding, and building detail can differ from the reference.
+
+### Blueprint naming
+
+Use `blueprint` and `blueprintIcons` for the architectural drawing map. Its map ID and
+asset directory are `blueprint`, its theme key is `blueprint`, its theme ID is `blueprint-dark`,
+and its grid artwork ID is `blueprint-grid`.
+
+<!-- docs:check -->
+
+```ts
+import {defineMap} from '@tileflow/core';
+import {blueprint} from '@tileflow/maps';
+
+export default defineMap({
+  id: 'city-plan',
+  version: 1,
+  extends: blueprint,
+  view: {center: [-3.7038, 40.4168], zoom: 14},
+});
+```
+
+### Community maps
+
+Cyberpunk, Terminal, and Super Tile World are maintained in
+[Tileflow Community Maps](https://github.com/tileflow/community-maps), with editable source,
+assets, previews, and contribution instructions. They are not part of this package.
+The GitHub-distributed `@tileflow/community-maps` package exports `cyberpunk`, `terminal`, and
+`superTileWorld`, plus each map's font and icon descriptors. Install an exact Git commit using
+the instructions and compatible Core version in that repository.
 
-Every export is an ordinary, complete first-party Tileflow map. No official map imports or extends
-another official map; each declares its data, modules, render stacks, themes, and asset
-providers directly. Applications can still use the public `extends` contract to derive their own
-maps from any official root. Streets and Siegfried each contain structurally identical `light` and
-`dark` appearances.
+Soundings is not a navigation product; its depth-band edges are approximate. It draws Nautical
+marks with its chart symbols and a "Not for navigation" notice; other maps opt in with
+`marine: 'nautical'` (see Core's Nautical marks guide).
 
-The official map objects are deeply frozen package singletons so one consumer cannot mutate
-the definition seen by another. This does not change Core authoring: `defineMap(...)` still returns
-the application-owned object without freezing it, and an application extends an official map by
-declaring its own modules or other atomic overrides.
+## Themes and assets
+
+`streetsThemes` and `siegfriedThemes` expose complete `light` and `dark` themes. Import those
+collections when using `defineTheme()` to derive a new appearance. A declared `themes` collection
+replaces the inherited collection, so also declare the intended `defaultTheme` and `systemThemes`
+and optional `timeOfDay` mappings. `system` belongs to browser selection; captures and builds use concrete theme names.
+
+Every map exports an icon-directory descriptor: `streetsIcons`, `baedekerIcons`, `civicaIcons`,
+`map1777Icons`, `siegfriedIcons`, `soundingsIcons`, and `blueprintIcons`. The descriptors point into this installed package; they are not sprite URLs.
+The CLI and build integrations compile the selected directories into runtime assets.
+
+Baedeker, 1777 and Siegfried export `baedekerFonts`, `map1777Fonts` and `siegfriedFonts` for
+their packaged Cormorant Garamond faces.
+Cívica exports `civicaFonts` for DM Serif Text, Barlow Semi Condensed, and Noto Sans fallback.
+Streets exports `streetsFonts` for its packaged navigation lettering and Noto Sans fallback.
+Soundings and Blueprint declare Noto Sans URL glyph providers
+from one immutable Hosted base-asset set, versioned independently of World data.
+
+Omitting `icons` inherits the parent's directory list. Declaring a list replaces it; `[]` removes
+all icon directories. Compose explicitly when adding application icons:
+
+<!-- docs:check -->
 
 ```ts
-import {
-  baedeker,
-  baedekerFonts,
-  baedekerIcons,
-  cyberpunk,
-  cyberpunkFonts,
-  cyberpunkIcons,
-  ferraris,
-  ferrarisIcons,
-  harad,
-  haradIcons,
-  matrix,
-  matrixFonts,
-  matrixIcons,
-  sanFrancisto,
-  sanFrancistoIcons,
-  siegfried,
-  siegfriedFonts,
-  siegfriedIcons,
-  siegfriedThemes,
-  soundings,
-  soundingsIcons,
-  streets,
-  streetsIcons,
-  streetsThemes,
-  verdant,
-  verdantIcons,
-} from '@tileflow/maps';
+import {defineMap} from '@tileflow/core';
+import {streets, streetsIcons} from '@tileflow/maps';
+
+export default defineMap({
+  id: 'store-locator',
+  version: 1,
+  extends: streets,
+  icons: [streetsIcons, './icons'],
+});
 ```
 
-`baedeker` is a self-contained travel-atlas and town-plan design with open warm paper, fine coral
-building and residential hatching, paper-negative streets, dominant black railways, horizontally
-engraved cyan water, ring-stippled gardens, and browser-derived Mapterhorn contours. Travel POIs
-are rendered as compact serif labels without modern pictograms. It declares
-`[baedekerIcons]`, whose eight original Tileflow SVG patterns describe hachures, orchards, paper
-grain, public gardens, residential blocks, sand, water lines, and wetlands, plus
-`[baedekerFonts]`, its own package copy of Cormorant Garamond Regular, SemiBold, and Italic. Its
-visual grammar was informed by the
-[Baedeker / Karl Wagner & Debes collection](https://www.antiquemapsandprints.com/collections/baedeker-karl-wagner-debes?srsltid=AfmBOoqG_2Q_Zje0wPPVYjShDjDZe5aIgH_h08XcPkpu7zFaPvF6n5hq)
-and Wikimedia Commons'
-[maps by Karl Baedeker of Italy](https://commons.wikimedia.org/wiki/Category:Maps_by_Karl_Baedeker_of_Italy).
-The package includes no historical scan, raster pixel, historical typeface, legend artwork,
-geospatial data, or source map; the style and patterns are original Tileflow work. The packaged
-Cormorant faces are unmodified upstream font software under the SIL Open Font License 1.1. No
-Mapterhorn terrain tile is packaged or redistributed. Baedeker is an official Tileflow map and is
-not affiliated with or endorsed by Baedeker or Wagner & Debes.
-
-`ferraris` is a self-contained printed-atlas design. It uses Core's semantic compiler, but
-it does not import or extend the `streets` map and it does not inherit Streets assets. It declares
-only `[ferrarisIcons]`, which contains nine original seamless SVG patterns for paper, cultivated
-land, vegetation, settlements, sand, wetlands, and water. Applications can import it directly or
-extend it like any other root.
-
-`harad` is a self-contained historical green-map design named “Härad”. It uses Core's semantic
-compiler ABI without importing or extending the `streets` map or reusing any Streets asset.
-It declares only `[haradIcons]`, whose nine original Tileflow SVG patterns describe arable land,
-coniferous and deciduous woodland, orchards, paper grain, sand, settlements, water lines, and
-wetlands. The visual grammar is inspired by Lantmäteriet's CC0 Häradsekonomiska kartan series
-(1859–1934) and official legend. The package redistributes no Lantmäteriet scan, source pixel, legend
-artwork, font, or map data; the shipped style and SVG patterns are original Tileflow work.
-
-`soundings` is a self-contained bathymetric-chart design with ivory land, thirteen-stop
-depth-graded water, labelled band edges, continuous colour relief, multidirectional seabed shading,
-port context, named ferry routes, and restrained technical magenta. Its initial camera faces the
-Strait of Gibraltar, allowing an Iberian GEBCO pilot to exercise both Atlantic and Mediterranean
-relief. It selects the public semantic compiler contract without importing or extending `streets`
-and explicitly composes World with `bathymetry({display: 'hybrid'})` while setting Nautical to
-`false`.
-
-Vector bands come from `tileflow-bathymetry`; continuous colour relief and hillshade come from
-`tileflow-bathymetry-dem`. The stronger DEM treatment is balanced against the vector wash and depth
-labels rather than against experimental navigation symbols. Dashed outlines remain an honest
-fallback traced from broad GEBCO band polygons until native contour geometry is released. Labels
-show the absolute `min_depth` value, not an inferred range or vessel-specific safety contour.
-Harbours and ferries are ordinary World context. Experimental `nautical-v1` tiles, aids, lights,
-soundings, hazards, reefs, and wrecks are deliberately absent from the official map and remain
-available only to explicitly configured laboratory maps. Soundings is reference cartography and is
-not a navigation product.
-
-`siegfried` is a self-contained terrain atlas based on the visual grammar documented for
-swisstopo's nineteenth-century Siegfried Map. It does not import or extend `streets`. The default
-`light` theme preserves black, brown, blue, and an ivory paper substrate; browser-derived contours
-replace modern hillshade and retain the 30-metre Alpine cadence at detailed zooms. Rock and scree
-are re-engraved in key ink after the contour deck, while dedicated SVG motifs distinguish forest,
-glacier, wetland, gravel, orchard, and water. Its coordinated `dark` theme is explicitly a nocturnal
-engraver's proof, not a historical facsimile: it keeps identical geometry and semantic ink roles on
-charcoal paper. `[siegfriedIcons]` owns nine light and nine dark pattern variants,
-`[siegfriedFonts]` owns the locally packaged Cormorant Garamond Regular, SemiBold, and Italic faces,
-and `[siegfriedThemes]` exposes the two complete visual vocabularies for safe derivation.
-
-`verdant` is a self-contained contemporary field-atlas design. It combines a park-map information
-hierarchy with a cool mineral substrate, clean blue hydrography, graphite buildings, and a
-trail-forward accent; its original botanical textures appear only where detailed zooms make them
-useful. It uses the same semantic compiler contract without importing or extending `streets`,
-declares its own Noto Sans glyph provider, and owns its complete icon and pattern set through
-`[verdantIcons]`.
-
-`sanFrancisto` is a self-contained dark architectural-blueprint design centered on San Francisco.
-Fine technical road strokes, survey-like uppercase labels, precise building footprints, contour
-dimensions, and dedicated landscape and water hatches replace naturalistic map color. It declares
-the canonical Noto Sans glyph provider and only `[sanFrancistoIcons]`, whose four original patterns
-and schematic POI node form its complete sprite vocabulary.
-
-`cyberpunk` is a self-contained dark HUD root. Its road hierarchy, building signals, destination
-beacons, semantic render passes, theme, World data selection, `[cyberpunkIcons]`, and
-`[cyberpunkFonts]` are all declared directly; it does not import or extend `streets`.
-
-`matrix` is a self-contained monochrome green-screen root. It explicitly owns its sparse HUD
-geometry, reviewed phosphor-green ramp, modules, semantic render passes, and theme. It
-omits a bright road centerline and building circuit texture, and uses compact square destination
-nodes through `[matrixIcons]`. A translucent scanline and dot pattern masks the cartographic
-linework so bright strokes break into the phosphor rows of an old CRT without baking that texture
-into the map data; text layers render afterwards and stay crisp. `[matrixFonts]` owns Matrix's
-packaged Oxanium faces for uppercase labels, independently of Cyberpunk's font provider.
-
-`streetsThemes.light` and `streetsThemes.dark` are complete appearance documents consumed by the
-same semantic module structure. Selecting `dark` changes colors, typography roles, image roles, and
-lighting without changing a source, filter, layer order, zoom gate, collision rule, or module. Both
-sidewalk patterns live in the shared `[streetsIcons]` atlas and the selected theme resolves the
-semantic `roads.sidewalkPattern` image token to the correct asset.
-
-Streets uses one ranked destination hierarchy in both themes. Major transit and cultural anchors
-appear first; lodging, health, education, services, shopping, food, coffee, and parking enter
-progressively as the camera approaches street level. Each visible destination is one collision
-unit made from a colored circular pictogram and an optional neutral name, so the marker remains
-useful when the label cannot fit. The pictogram scale grows gently from 1× at z12 to 1.06× at z17,
-giving detailed street views a little more visual presence without increasing POI density.
-Portal-number labels are intentionally disabled. The ten POI
-pictograms are adapted from the pinned CC0 Maki subset documented in
-`THIRD_PARTY_NOTICES.md`; their containers, colors, sizing, and composition are Tileflow-authored.
-
-Road references use a compact Tileflow-owned family of generic rectangular and circular shields.
-The data's normalized `shield_kind` selects neutral, blue, green, red, orange, yellow, or circular
-artwork; `shield_text_color` independently selects the light or dark theme token. Unknown and
-unsupported networks fall back to the neutral rectangle with dark text instead of guessing a
-country from the spelling of `ref`. Both themes retain the same signaling colors.
-
-Streets has separate shield phases for scale, not separate hand-authored network layers. Overview
-uses pre-deduplicated point candidates; detail switches to repeated line placement. Both the fitted
-plate and its complete route reference are viewport-aligned, so shields remain horizontal as the
-map rotates or pitches. The rectangular base plate is 20 by 14 pixels with a one-pixel outline;
-the circular neutral base is 14 by 14. Both use 9-pixel bold text and a small width-only fit
-allowance. Streets limits shields to the motorway-through-tertiary hierarchy; collision padding
-and the overview candidate schedule keep regional views legible while preserving useful repetition
-at street scale.
-
-The two palettes are Tileflow-owned, deterministic snapshots calibrated from rendered Mapbox
-Standard `default/day` and `default/night` references on 2026-08-27. They do not import Mapbox style
-JSON, rules, assets, or runtime dependencies. Public roles such as `surface.background`,
-`landuse.industrial`, `landuse.medical`, `labels.settlement`, `labels.neighborhood`, and
-`labels.road` remain independently wired; `hydro.ocean` also separates Standard Night's deep sea
-from urban and inland water. An agent can alter one cartographic intent without
-knowing or perturbing the physical layer topology. Because Standard is evergreen, later parity work
-must be an explicit dated recalibration rather than an implicit network-dependent change.
-
-At detailed zooms, the road-bearing official maps round-cap ordinary surface-road and bridge
-feature endpoints so adjacent vector segments overlap their antialiasing fringe instead of exposing
-hairline cuts. Tunnel portals retain butt caps; Streets, Cyberpunk, and Matrix also keep butt caps on
-steps and approaches carrying circular-road clearance so those structural ends do not protrude into
-the connected geometry. Streets pairs its blue/slate road decks with a darker casing that grows from
-1 px at z15 to 2 px at z22; tunnel casings use the compact dashed rhythm of the calibrated reference.
-
-A theme is not a loose override cascade. Module styles explicitly reference roles such as
-`roads.motorway`, `labels.road`, and `hydro.water`; the selected complete theme resolves those
-references before MapLibre output is generated. Use `defaultTheme` for a deterministic default and
-`systemThemes` plus the runtime `theme="system"` selection when the browser should follow the OS.
-
-The directory descriptors point into this installed package. A map inherits its parent's icon or
-font list when the property is omitted. Declaring a list replaces the inherited list, a later
-directory wins for an exact duplicate ID, and `[]` selects no directories.
-
-`@tileflow/maps` has a peer dependency on `@tileflow/core`. Core owns the map language and compiler;
-this package owns the official map definitions, icon and pattern sources, Cyberpunk, Matrix, and
-Siegfried fonts, and their notices. Core never depends on this package.
+Create `icons/` beside the config and add supported image files before building. Later directories
+replace earlier files with the same exact icon ID. Fonts follow the same ordered-directory model;
+`fonts` and `glyphs` are mutually exclusive providers.
+
+## Delivery and attribution
+
+Use the CLI or a build integration to prepare a map's complete asset set. Copying Style JSON alone
+can leave missing sprites, font files, or browser protocols. Keep the generated manifest and its
+referenced files together.
+
+Hosted deployment currently requires Tileflow World and rejects local/package font bundles before
+uploading a style. Maps with packaged fonts therefore need self-hosted delivery or an explicitly
+replaced, compatible public glyph provider. Check with `tileflow validate --target hosted` before
+planning a hosted deployment.
+
+Tileflow-owned designs and artwork use Apache-2.0. Historical inspiration does not mean the package
+redistributes historical scans, source cartography, or data. Third-party fonts and the pinned Maki
+icon subset retain their own terms. Preserve
+[THIRD_PARTY_NOTICES.md](https://github.com/tileflow/tileflow-sdk/blob/main/packages/maps/THIRD_PARTY_NOTICES.md)
+and the notices next to packaged assets. Map data and terrain services have separate attribution
+and usage requirements.
+
+See the [Core guide](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/README.md)
+for inheritance and styling, or the
+[public exports](https://github.com/tileflow/tileflow-sdk/blob/main/packages/maps/src/index.ts)
+for exact names. The installed package's definitions and README take precedence over a newer `main`.
+
+## Streets themes
+
+Streets offers three time-of-day families: `light` (displayed as Default), `faded`, and `monochrome`, each with
+`day`, `dawn`, `dusk`, and `night`. For example, `theme="faded" timeOfDay="night"` resolves to
+`dark-faded`. Inspector shows these as separate Theme and Time of day controls. All twelve
+concrete theme names remain available for existing applications and captures. This catalog
+is inherited when extending Streets without overriding it.
+See the [time-of-day contract](https://github.com/tileflow/tileflow-sdk/blob/main/packages/core/REFERENCE.md#style-with-themes-and-semantic-modules).
+
+Streets packages contrasted routes and compact trees. Climate artwork and its attribution are
+retained for future URL delivery, but the underlay is not included in compiled styles.
+When the 3D view is active, available buildings and models appear at full height from zoom 14.25
+without zoom entrance animations.
+Pitch is capped at 38° through zoom 15; closer views use the application's maximum.
+Daylight combines warm limestone buildings, ivory model surfaces, smoked-blue glazing and warm
+roof tones under neutral sunlight and skylight. Models share ordinary-building shading, with
+soft contact shadows and ambient occlusion in recesses. Monochrome materials stay neutral.
+Glass parts can be recoloured independently through `modelColors.glass`; window roles retain
+that glass tint even on a shared stone part, with `modelLighting.window.colorScale: 0.96`.
+Other maps can override their colour and material without regenerating the model.