Eric chose option B on #72. The drop is now the GDD's launch: - A packet ship sails a seeded straight line past the island, offshore, as close in as it can while keeping 45 m of open water from any land (eight-way probes; up to 32 headings, then the four world sides). - Jump fires the lifeline mortar along the look heading. How high the player aims sets the charge (-10 to 45 degrees: 16 to 110 m/s over the ground; every shot climbs at 75 m/s). The climb can't be steered and the kite can't open until the arc tops out. Riders still aboard at the end are fired towards the middle of the island. - Drop.reach() mirrors the fall for both ways down (kite at the top, or a fall with the kite opening by itself); bots, the soak and autoplay clients and the tutorial pilot aim with Drop.aim_charge(). - Bots fire at their landing spot once abeam of it, when in easy reach at their own staggered moment, or just before the route ends, and open the kite early only when the spot is beyond the rest of a fall. - Art: VesselModels.ship() (two-masted packet, tanned square sails, a salt-white boot-top, a bowsprit and the mortar on its bed, mirrored to face the island), the figure's gull-kite (figure.py), and a lifeline cord from the muzzle to each player still climbing. - Renamed barge to ship and wing-sail to gull-kite throughout code, tests, captures, docs and the tutorial text. make match now defaults to seed 2, where the scripted player still harvests and builds. Closes #72 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
279 lines
15 KiB
Markdown
279 lines
15 KiB
Markdown
# Tidewall style guide
|
|
|
|
Binding on every asset, view and sound Tidewall makes, alongside
|
|
[ORIGINALITY.md](ORIGINALITY.md). Generated assets follow this guide, and new work is
|
|
checked against it.
|
|
|
|
## The idea in one line
|
|
|
|
**A drowned coast, printed by hand.** Tidewall should look like a fisher community's
|
|
own woodcut or painted sign: weathered wood, rope and tar, salt-bleached paint, cut
|
|
with ink lines and hatched shadow. It should never look glossy, toy-bright or
|
|
candy-coloured. The genre's mainstream look is saturated, rounded and clean. Ours is
|
|
muted, angular and worn.
|
|
|
|
## Palette
|
|
|
|
Every colour the client draws with lives in
|
|
[`src/client/style/palette.gd`](../src/client/style/palette.gd), and
|
|
`test/project/test_palette.gd` fails on a colour literal anywhere else in `src/client`
|
|
or `src/app`, and on any palette colour this table doesn't list. Values are sRGB.
|
|
|
|
**Rules**
|
|
|
|
- **Muted, never neon.** No channel combination brighter or more saturated than
|
|
`OILSKIN` yellow. Saturation sits low; the environment grades the frame a further 14%
|
|
greyer (`Look.SATURATION`).
|
|
- **Warm darks.** The darkest colours are tar and ink, which lean brown. Nothing is
|
|
pure black, and `INK` is never `#000`.
|
|
- **One warm accent.** Oilskin yellow marks the local player and the HUD's few
|
|
emphasised items. Rust red means danger or refusal, sea green means allowed. Both
|
|
always come with a shape or a word, never colour alone.
|
|
- **Paint is faded.** Painted things (ochre roofs, verdigris trim, chests) sit between
|
|
a fresh colour and the grey of the wood beneath.
|
|
|
|
| Name | sRGB | What it is |
|
|
|---|---|---|
|
|
| `TAR` | 0.19, 0.16, 0.13 | Fresh pine tar: hulls, piles, sheds |
|
|
| `TAR_WEATHERED` | 0.31, 0.26, 0.22 | Weathered tar: wrecks, old piles |
|
|
| `PLANK` | 0.50, 0.45, 0.37 | Grey planking |
|
|
| `PLANK_BLEACHED` | 0.64, 0.60, 0.52 | Salt-bleached planks: jetties, wreck ribs |
|
|
| `DRIFTWOOD` | 0.62, 0.50, 0.36 | Driftwood, build material 1 |
|
|
| `CRATE_WOOD` | 0.68, 0.55, 0.38 | Unpainted crate wood |
|
|
| `BARK` | 0.40, 0.30, 0.22 | Pine bark |
|
|
| `HOLD_SHADOW` | 0.22, 0.20, 0.18 | Inside an emptied chest or hold |
|
|
| `WINDOW_PANE` | 0.13, 0.16, 0.17 | Window glass from outside |
|
|
| `OPENED_DULL` | 0.45, 0.43, 0.42 | Tint over an opened sea chest |
|
|
| `CANVAS` | 0.84, 0.80, 0.68 | Rope and sailcloth |
|
|
| `TANNED_SAIL` | 0.62, 0.44, 0.28 | Bark-tanned sails |
|
|
| `STONE` | 0.56, 0.54, 0.49 | Field stone in walls and quays |
|
|
| `BOULDER` | 0.56, 0.55, 0.51 | Loose boulders |
|
|
| `DRESSED_STONE` | 0.60, 0.59, 0.55 | Dressed stone, build material 2 |
|
|
| `LICHEN` | 0.62, 0.61, 0.45 | Lichen on high rock |
|
|
| `SALVAGE_IRON` | 0.50, 0.34, 0.26 | Rusted salvage iron, build material 3 |
|
|
| `SALT` | 0.90, 0.90, 0.86 | Salt pans and whitewash |
|
|
| `OCHRE_RED` | 0.56, 0.27, 0.20 | Faded red ochre roofs and doors |
|
|
| `SEA_PAINT` | 0.33, 0.55, 0.56 | Verdigris sea-green trim and sea chests |
|
|
| `OILSKIN` | 0.86, 0.66, 0.16 | Oilskin yellow, the local player, the HUD's accent |
|
|
| `OILSKIN_MOSS` | 0.36, 0.40, 0.30 | Moss oilskin |
|
|
| `OILSKIN_SLATE` | 0.48, 0.46, 0.44 | Slate oilskin |
|
|
| `OILSKIN_NAVY` | 0.30, 0.36, 0.48 | Faded navy oilskin |
|
|
| `GILT` | 0.93, 0.80, 0.42 | Gilt and brass: loot glints, carvings |
|
|
| `LAMP` | 0.98, 0.86, 0.55 | Lit lamp glass |
|
|
| `SKIN` | 0.74, 0.58, 0.46 | Weathered skin |
|
|
| `NEEDLES` | three greens | Pine needles, varied per tree |
|
|
| `SCRUB` | two olive greens | Gorse and scrub |
|
|
| `SKY_TOP` | 0.32, 0.50, 0.68 | Zenith |
|
|
| `SKY_HAZE` | 0.82, 0.78, 0.68 | Salt-hazed horizon |
|
|
| `SKY_BELOW` | 0.18, 0.20, 0.20 | Below the horizon |
|
|
| `SEA_FOG` | 0.78, 0.78, 0.74 | Distance fog |
|
|
| `STORM_SKY` | 0.36, 0.40, 0.44 | The gale's low cloud overhead |
|
|
| `STORM_HAZE` | 0.58, 0.60, 0.60 | The gale's horizon |
|
|
| `DUSK_HAZE` | 0.86, 0.66, 0.50 | The dusk horizon late in a match |
|
|
| `DUSK_SUN` | 1.0, 0.78, 0.56 | The low evening sun's light |
|
|
| `RAIN` | 0.80, 0.84, 0.86, 22% | Rain streaks |
|
|
| `SEA_SHALLOW` | 0.42, 0.55, 0.50 | Water over sand |
|
|
| `SEA_DEEP` | 0.10, 0.22, 0.30 | Open water |
|
|
| `SEA_STORM` | 0.13, 0.20, 0.22 | Open water in the gale |
|
|
| `SEA_FOAM` | 0.86, 0.88, 0.84 | Surf and whitecaps |
|
|
| `SEA_MURK` | 0.12, 0.28, 0.30 | The view under water |
|
|
| `INK` | 0.16, 0.13, 0.11 | Printer's ink: outlines, hatching |
|
|
| `PAPER` | 0.91, 0.87, 0.78 | Unbleached paper: HUD panels and text |
|
|
| `PAPER_DIM` | 0.66, 0.62, 0.54 | Paper in shadow: panel edges, dimmed text |
|
|
| `GILT_DEEP` | 0.62, 0.45, 0.12 | Brass on paper: the menu control with focus |
|
|
| `OUTLINE` | 0.08, 0.08, 0.08 | Text outline on the HUD |
|
|
| `GHOST_OK` | 0.46, 0.80, 0.70, 38% | Build ghost: allowed |
|
|
| `GHOST_REFUSED` | 0.86, 0.32, 0.22, 38% | Build ghost: refused |
|
|
| `WARNING` | 0.86, 0.32, 0.22 | HUD danger: the tide's next line, low health |
|
|
| `SEA_INK` | 0.20, 0.34, 0.42 | The sea on the tide gauge and map |
|
|
|
|
### Colour vision (A13)
|
|
|
|
The signals above are the `Standard` set. Red against green (the build ghost) and rust
|
|
against oilskin yellow (danger beside the player's own marks) are hard to tell apart
|
|
for many players, so the Access settings offer a set for each common kind of colour
|
|
blindness (`VISION_NAMES`: `VISION_STANDARD`, `VISION_RED_GREEN`, `VISION_BLUE_YELLOW`).
|
|
Everything that signals asks `Palette.ghost_ok()`, `ghost_refused()`, `warning()` and
|
|
`own()` for its colour, which read `VISION_SIGNALS` for the set in use.
|
|
|
|
| Set | Allowed | Refused | Danger | Own marks |
|
|
|---|---|---|---|---|
|
|
| Standard | `GHOST_OK` | `GHOST_REFUSED` | `WARNING` | `OILSKIN` |
|
|
| Red-green (protan, deutan) | blue 0.22, 0.52, 0.95 | orange 0.98, 0.56, 0.08 | magenta 0.78, 0.16, 0.62 | `OILSKIN` |
|
|
| Blue-yellow (tritan) | teal 0.16, 0.70, 0.74 | vermilion 0.90, 0.16, 0.20 | red 0.88, 0.14, 0.18 | pale blue 0.62, 0.86, 0.98 |
|
|
|
|
`test_palette` checks each set with a simulation of the colour vision it is for
|
|
(Machado, Oliveira and Fernandes 2009, at full severity): each pair must be at least
|
|
0.25 apart in Oklab, and clearly further apart than the standard colours where those
|
|
are weakest (the standard ghost is only 0.18 apart for deutan eyes). Simulations are a
|
|
guide, not a substitute for asking players with colour blindness.
|
|
|
|
The terrain shader's sand, marsh, grass, rock and summit colours are shader uniforms
|
|
and follow the same rules. The sea shader's colours are set from the `SEA_` entries
|
|
above by `WaterView`. Water goes from `SEA_SHALLOW` to `SEA_DEEP` with its depth and
|
|
is fully `SEA_DEEP` and opaque by `WaterView.OPEN_DEPTH` (9 m), shallower than the open
|
|
sea floor, so from the air the sea round the island and past the world's edge is one
|
|
colour (H16).
|
|
|
|
## Weather and light (A6)
|
|
|
|
A match runs from a clear salt-hazed afternoon to a gale at dusk, so the sky itself
|
|
tells the time. `Weather` works it out from the tide's schedule alone, the same on
|
|
every client:
|
|
|
|
- **The storm** builds from calm at the first tide to a full gale at sudden death:
|
|
cloud lowers (`STORM_SKY`, `STORM_HAZE`), the haze thickens, the sea darkens to
|
|
`SEA_STORM` with whitecaps and heavier chop, and rain starts once it's past half.
|
|
- **The light** moves from mid-afternoon to dusk over the whole match: the sun drops
|
|
toward the sea, warms to `DUSK_SUN` and the horizon to `DUSK_HAZE`, and the storm
|
|
dims it further.
|
|
- **The shoreline** always has a foam line where the water is thin, breathing with
|
|
the swell, so the waterline reads at a glance in every phase.
|
|
- **Under water** the view closes in to `SEA_MURK` within a few metres.
|
|
|
|
## Shading: the woodcut print pass
|
|
|
|
[`src/client/style/folk_print.gdshader`](../src/client/style/folk_print.gdshader), set
|
|
up by `Look.add_print_pass(camera)`, is drawn over every frame:
|
|
|
|
- **Ink lines** where depth jumps (silhouettes) or bends (creases). They are drawn at
|
|
full weight near the camera and fade with distance, so far hills stay quiet. Line
|
|
weight scales with screen height, so 4K looks like 720p.
|
|
- **Hatching cut into shadow:** diagonal lines whose width grows as the shadow
|
|
deepens, the way a woodcut shows tone.
|
|
- **Paper grain**, faint.
|
|
- It only darkens (it is multiplied over the frame), so lit colours stay the palette's.
|
|
- Ground under the sea gets no ink or hatching. The sea and the build ghost are drawn
|
|
after the pass and carry their own looks.
|
|
- `Look.environment()` grades the frame: saturation 0.86, contrast 1.05. The capture
|
|
scenes and the match view share it, so captures show the game's real look.
|
|
|
|
Materials stay matte. Roughness is high (0.7 to 0.95) except lamp glass and wet stone.
|
|
No shiny plastic, no rim lights, no bloom beyond lamps.
|
|
|
|
## Shape language
|
|
|
|
- **Hand-built and slightly off.** Planks are strips with seams, stone is in courses,
|
|
roofs overhang. Edges are chamfered or blocky, not rounded or bubbly.
|
|
- **Vertical and narrow.** Lighthouses, masts, drying racks, pines. The island reads
|
|
as a climb, because height is safety.
|
|
- **Boats and tide marks everywhere.** Hulls, nets, floats, posts with painted tide
|
|
lines. The sea's reach is part of every place.
|
|
- **Silhouettes first.** Every object reads by outline alone; the ink pass depends on
|
|
it.
|
|
|
|
## World art (A5)
|
|
|
|
Everything in the world is built in code from `Palette` colours; there are no texture
|
|
files. The rule is that what is drawn is what blocks: dressing stays inside each
|
|
collision box, give or take a few centimetres of lap or trim.
|
|
|
|
- **Points of interest** (`PoiMesher`): tarred walls are lapped weatherboards, every
|
|
other board standing proud; plank is boards (vertical on walls, across decks); stone
|
|
is courses in a running bond with the odd lichened block; roofs are rows of ochre
|
|
tiles over a dark fascia with a ridge cap; paint carries a salt-white border line;
|
|
salt pans are crusted; huts have a shuttered window in each side wall; the light
|
|
chamber glows in a tarred frame.
|
|
- **Build pieces** (`PieceMesher`) show their state. Building, the strips go up one
|
|
after another in quarter steps with nothing behind them. Worn (a third of health
|
|
gone), a third of the strips are split short and darkened. Battered (two thirds
|
|
gone), a third are knocked out so the dark backing shows, and the rest are split
|
|
and charred. `make build-captures` renders the test card (`captures/build_states.png`).
|
|
- **The packet ship and sea chests** (`VesselModels`): a two-masted packet with a lofted
|
|
tarred hull, an ochre rubbing strake, a salt-white boot-top at the waterline, tanned
|
|
square sails with an ochre band, a bowsprit, and a squat tarred lifeline mortar with
|
|
gilt bands on a timber bed; sea chests painted sea-green with tarred bands, a salt-white border and a gilt hasp.
|
|
- **Terrain** (`terrain.gdshader`): sand with shingle, marsh, grass in tussocks and
|
|
wind-dried patches, rock with lichen blotches, pale summits. Fine detail fades out
|
|
past about 150 m so it doesn't shimmer.
|
|
- **Props** (`PropView`): low-poly pines, scrub, boulders, wrecks and crates, per
|
|
vertex coloured and tinted per instance.
|
|
|
|
## Characters
|
|
|
|
- **Proportions:** about 6.5 heads tall, broad shoulders, heavy boots and coats, hands
|
|
slightly large. Grounded working people, not heroes or mascots.
|
|
- **Clothing:** oilskins, sou'westers, knitted jumpers, rope belts, canvas bags, sea
|
|
boots. Variation comes from coat colour, hat, patches and knitwear patterns.
|
|
- **Faces:** simple carved planes, like a ship's figurehead or a whittled figure. No
|
|
big-eyed cartoon faces.
|
|
- **Movement:** weight and effort. Climbing is a scramble, swimming is a struggle.
|
|
- **Celebrations** (if any): small, local gestures such as raising a lantern or tipping
|
|
a hat. Never dances.
|
|
|
|
## UI motifs
|
|
|
|
- **Paper and ink.** Panels are unbleached paper (`PAPER`) with ink text, or ink
|
|
panels with paper text, edged like a torn chart or a painted board.
|
|
- **Charts and tide tables.** The map is a hand-drawn nautical chart; the tide gauge
|
|
is a painted tide post with notches, the most prominent thing on the HUD.
|
|
- **Hand-lettered signs** in spirit, with Godot's bundled default font in practice (see
|
|
ORIGINALITY.md). Small caps and wide spacing for labels.
|
|
- **Rope and knots** as dividers; brass (`GILT`) for the rare highlight.
|
|
- **Never colour alone.** Health uses a number and a bar; tiers use pips or roman
|
|
numerals; danger uses a shape (a notch, a wave mark) as well as `WARNING`.
|
|
- Layout is Tidewall's own. The tide gauge sits top centre, because the tide is the
|
|
clock.
|
|
|
|
## Effects (A7)
|
|
|
|
Effects are painted, not photographic: round soft spots of flat Palette colour and thin
|
|
gilt streaks, so they sit with the woodcut print pass rather than fight it.
|
|
|
|
- **Muzzle flash:** a small `LAMP` core with `OILSKIN` petals along the aim and a wisp
|
|
of `STONE` smoke that drifts off the line, so the shooter's own view stays clear.
|
|
- **Tracers:** a short `GILT` streak running from the muzzle to where each pellet
|
|
landed; projectiles in flight trail `OILSKIN`.
|
|
- **Hits on a player:** a `LAMP` flash, a ring of `SALT` puffs and `OILSKIN` sparks.
|
|
No blood: folk are knocked about, not wounded on screen. The shooter also gets four
|
|
paper ticks round the reticle (a shape, not only a colour).
|
|
- **Hits on things:** chips and dust in the material's colour (driftwood, dressed stone,
|
|
salvage iron with gilt sparks; bark for trees; the ground's own colour; foam on water).
|
|
- **Building and collapse:** a ring of dust where a piece is set down; a piece that
|
|
breaks comes apart in a cloud of its material's dust and falling chips.
|
|
- **Powder keg:** a `LAMP` flash, an `OCHRE_RED` to `OILSKIN` fireball, `TAR` debris and
|
|
a column of weathered smoke, with a light that lights the ground for a moment.
|
|
- **Water:** `SEA_FOAM` splashes when someone goes in, and spray along the shore round
|
|
the camera when a surge starts.
|
|
- **Being hurt:** the screen's edge flushes `WARNING` and fades; the health number falls too.
|
|
|
|
## Audio palette
|
|
|
|
All synthesized by scripts in the repository.
|
|
|
|
- **Sea and weather:** filtered noise for surf, wind and rain; low swells that rise
|
|
with the tide.
|
|
- **Wood and rope:** knocks, creaks and thumps from short resonant bursts. Building
|
|
sounds like carpentry.
|
|
- **Bells and horns:** a ship's bell for phases, a foghorn for the tide's rise, a
|
|
lighthouse tone for the last circle of land.
|
|
- **Weapons:** black-powder thumps and cracks, dull rather than sharp; no sci-fi zaps.
|
|
- **Music:** folk instruments synthesized simply: drone, fiddle-like bowed tones,
|
|
concertina chords, a bodhrán-like frame drum. Modal and sparse. Quiet in play,
|
|
fuller in menus and results.
|
|
- Mix: the sea is always present underneath. Loudness is calm; the tide is the
|
|
loudest thing when it rises.
|
|
- Levels (loudest 400 ms window, dBFS, `tools/audio/recipes.gd`): tide -12, weapons
|
|
-15, water -18, impacts and building -19, player -22, footsteps -24, menus -26,
|
|
ambience -27 (whole loop). The score's layers sit at -26 to -29 and play 6 dB lower
|
|
again under a match. Peaks never pass -1 dBFS. `make audio-check` enforces all of it.
|
|
|
|
## Never
|
|
|
|
- Bright saturated primaries, candy colours, pastel gradients or glossy materials.
|
|
- Rounded "toy" shapes, bubbly fonts, big-eyed faces, mascot characters.
|
|
- Dances, emotes copied from anywhere, or celebration animations borrowed from any game.
|
|
- Neon, glowing outlines, holograms, sci-fi panels or loot beams.
|
|
- Rarity colour schemes from other games. Tidewall's tiers are told by pips and wear.
|
|
- Any layout, icon, sound or name taken from or imitating a commercial game (see
|
|
ORIGINALITY.md).
|
|
- Third-party art, audio, fonts, sample packs or reference images.
|
|
- Pure black, or ink lines so heavy the scene turns into a comic.
|
|
|
|
## Provenance
|
|
|
|
Every generated asset names its generator script in
|
|
[`assets/PROVENANCE.md`](../assets/PROVENANCE.md) when the first asset lands.
|
|
Colours, shaders and procedural meshes made in code are recorded by being in the
|
|
repository.
|