Module settings 

Structs

BreakSound

Per-break-kind audio configuration: mode + which bundled sound to play. sound_id is the numeric id from src/assets/sounds/credits.json, or the literal "custom" to use custom_path (a Supporter-pack feature).

Settings

Single source of truth for one profile’s behaviour.

Enums

BreakSoundMode

What the overlay does with audio for a given break kind.

MonitorPlacement

Which monitor(s) an overlay break should appear on.

Functions

default_break_mode 🔒

default_clock_format 🔒

default_long_hint_mix 🔒

default_long_hints 🔒

default_long_social_hints 🔒

default_micro_hint_mix 🔒

default_micro_physical_hints 🔒

default_micro_psychological_hints 🔒

default_schedule_mode 🔒

default_sleep_hints 🔒

default_tray_countdown_target 🔒

delivery_for

Resolve the delivery mode for the given break kind.

effective_long_hints

Resolve the long-break hint pool, honouring long_hint_mix. "solo" / "social" filter to that pool; anything else (including "both") concatenates them in solo-then-social order.

effective_micro_hints

Resolve the micro-break hint pool, honouring micro_hint_mix. "physical" and "psychological" return only that pool; anything else (including "both") concatenates both in physical-then- psychological order.

is_windowed_mode

True iff the given break kind is currently configured for the Windowed delivery mode. Convenience wrapper around delivery_for.

sanitize_custom_css

Defence-in-depth scrub for user-supplied CSS. Even with a strict CSP in place we belt-and-braces:

strip_css_comments 🔒