The game now opens on a main menu when it has a window: practice against bots (count and skill), join a server (by address, or from a LAN search list), settings, and quit. In a match, Escape brings up a pause menu (the match goes on) with settings and leave; when a match the player was in ends, a results screen shows their place, eliminations and the last of the feed. - KeyBindings: every action rebindable to a key or mouse button. bind() refuses an input another action uses and names it; Escape is reserved. ClientInput reads keys through the bindings. - GameSettings: bindings, mouse, graphics (quality preset and the print pass), audio (master, music and effects buses), display (window mode, vsync, frame cap), name, last server and practice choices, saved in user://settings.cfg. Missing, unreadable or corrupt files and bad values fall back to defaults, value by value; hand-edited key clashes are repaired on load. - Menus (src/ui): paper-and-ink panels, brass focus edge, keyboard navigable; a drawn sea-and-tide-post backdrop, or an ink wash over a match. AppShell runs menus and the session. - LocalServer takes a bot difficulty. - make menu-captures renders every screen. Closes #50 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
173 lines
8.8 KiB
Markdown
173 lines
8.8 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 |
|
|
| `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 |
|
|
| `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 |
|
|
|
|
The terrain shader's sand, marsh, grass, rock and summit colours and the sea shader's
|
|
shallow, deep and foam colours are shader uniforms. They follow the same rules.
|
|
|
|
## 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.
|
|
|
|
## 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.
|
|
|
|
## 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.
|
|
|
|
## 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.
|