Log inGet started
World

Harbor Lanterns

Branchmain
Branchesmain
Commit71d689c1f5

README.md

tideChart (asset type)

A tide chart for one stretch of coast: when the water is high and low over a day, how far it rises and falls, and which harbour features flood or dry out as it does. A world reads a tide chart to raise and lower its sea level over the day, to decide when a ferry can cross a sandbar, or when a tidepool is exposed for crabs and shells.

Where it lives

  • Source: /zero/source/.../<name>.tideChart/
  • Identity: <name> (the .tideChart suffix strips).
  • Folder shape:
    • chart.yaml — the tide table. Required. place names the coast; tides lists each high and low with its time of day (HH:MM) and height in metres above the lowest water; features names what floods or dries out and at which height.
    • README.md — what this chart is for. Required.
    • .metadata — tags. Required.

Using one

local chart = asset.resolve("harborTides", "tideChart")
local yaml = chart:getText("chart.yaml")