Sound sets

From Zacess Scenes v1.1.0. Edit this page on GitHub

The watch and follow modes play a short tone for each change in a build or a command. Any scene can also play a quiet background sound. Every set plays the same short phrase for each event, so the meaning carries over when the set changes: a rising triad for a pass, a falling fourth for a failure, the triad landing an octave up for a fix, a rising minor third for new warnings, a rising fifth when the last warning clears, two soft low notes for a typo and a slow falling triad when the watch stops. Only the timbre differs.

Set Sounds like
bells (the default) Soft bells with a little shimmer, the original tones
marimba Warm wooden bars, short and round
kalimba Plucked metal tines with a gentle ring
pad A soft synth pad that swells in and fades out
chip Gentle 8-bit square waves, rounded so they never buzz
glass Slow glassy tones like a wet finger on a rim
piano A soft grand piano, felt hammers and a warm low ring
rain Water droplets over a quiet bed of rain
Event Plays when On by default
pass A run passes after waiting or a key asked for the run Yes
fail A run fails after passing, on the first result or when a key asked for the run Yes
tick A rebuild starts. Quieter than the others Yes
recovered A run passes after failing Yes
warnings A passing run has more warnings than the last Yes
still_failing A run fails again. Very quiet No
typo A followed command was not found. Softer than a failure Yes
clean A passing run has no warnings after the last one had some Yes
stopped The watch stopped on its own: bacon quit or the followed command could not start Yes
zacess-scenes sounds play marimba            # the pass tone
zacess-scenes sounds play kalimba recovered  # one event
zacess-scenes sounds play rain               # droplets over rain
zacess-scenes sounds play glass stopped      # the watch stopping

The tones are synthesised by the program, with soft envelopes and short fades so they never click and levelled so no set or event is much louder than another. The piano's overtones sit a little sharp of whole multiples, as a stiff string's do. The rain set's droplets rise in pitch over a soft bed of filtered noise that is seeded, so a tone is always written the same way.

The tones are cached as small WAV files in $XDG_CACHE_HOME/zacess-scenes when that is set, otherwise ~/Library/Caches/zacess-scenes on macOS, ~/.cache/zacess-scenes on Linux and %LOCALAPPDATA%\zacess-scenes on Windows. The system's own player plays them in the background: afplay on macOS, the first of pw-play, paplay or aplay on Linux and PowerShell's System.Media.SoundPlayer on Windows. Without a player there is no sound and the status bar says no sound player.

Setting Flag Environment variable Config
Sound off --no-sound ZACESS_SOUND=0 (also false, no or off) enabled = false under [sound]
The sound set --sounds <set> ZACESS_SOUNDS=<set> set
Volume from 0 to 100, 50 by default --volume <n> ZACESS_VOLUME=<n> volume
Quiet hours quiet_hours = "22:00-07:00"
One event on or off [sound.events]

Every tone has the same state on screen, so sound is never the only signal.

Background sound

A quiet sound that suits the scene, playing under it the whole time it shows. It is off unless turned on and it is quieter than the tones: 20 out of 100 by default against the tones' 50. While a tone plays the background sound stops for a moment and then carries on, so a pass or a failure is always heard clearly. The players are separate programs, so it stops rather than fades.

Sound Plays under
water: slow waves sea, waves, lily-pads, koi-pond, harbour, lanterns, mountain-lake, tide-pools, paper-boats, rocket-launch, flood, listing-ship, broken-bridge, leak, erosion and launch-scrub
rain: a steady hiss with soft drops rain, storm and tea
wind: slow gusts snow, desert-night, balloons, autumn, windmills, wilt, fog, drought, rockslide, dust-storm, thin-ice, drone-landing and landing-abort
fire: a low rumble and soft crackles campfire, winter-cabin and volcano
stream: a babbling stream with rising bubbles forest-stream
birds: a soft breeze with phrases of birdsong countryside, blossom, garden, sunflower-field, picnic and overgrown
hum: a quiet machine room, a low hum and a fan pcb-bring-up, dead-led, short-circuit, corrosion and tangle
city: distant traffic with cars passing far off rooftops, city-night, traffic-jam, pit-stop and pit-stop-stuck
pad: a slow warm chord that swells and fades zacess, aurora, orbit, constellations, tiles and ribbons
night: a quiet bed with the odd cricket Every other scene, your own Lua scenes included

One sound can play under every scene in place of each scene's own: --ambient-sound pad, ZACESS_AMBIENT_SOUND=pad or sound = "pad" under [ambient]. auto goes back to each scene's own. zacess-scenes sounds ambient plays a few seconds of each and zacess-scenes sounds ambient birds plays one.

Each sound is a 20 second loop made by the program from seeded noise, so it is always the same and cached like the tones. The loop is started again as it ends, which leaves a gap of a few milliseconds. It pauses with the scene, follows a change of scene and keeps quiet during quiet hours. Turning sound off with --no-sound, ZACESS_SOUND=0 or the config turns it off too.

Setting Flag Environment variable Config
On --ambient ZACESS_AMBIENT=1 enabled = true under [ambient]
Off for one run --no-ambient ZACESS_AMBIENT=0
Volume from 0 to 100, 20 by default --ambient-volume <n> volume under [ambient]
One sound for every scene, auto by default --ambient-sound <name> ZACESS_AMBIENT_SOUND=<name> sound under [ambient]

a turns it on or off while a scene runs and [ and ] change its volume. A scene run on its own has no tones, so m, + and - work the background sound there too.