HypnoSpec features¶

Every setting Hypna’s player understands, by feature id. Values marked as strings are stored as strings in the document even when they are numbers. See Editing the HypnoSpec document for the document shape, and https://hypna.space/hypnospec/ for the generated schema pages.

Content features¶

space.hypna.feature.content.lines: lines (string list, default empty): the session’s lines. Used by MST, BST, STT.
space.hypna.feature.content.text: text (string, default empty): the phrase or instruction. Used by WLT, ECT, ACT.
space.hypna.feature.content.time: time (number, default 0): the iteration count. Lines to type (WLT), lines to play (BST), completions (ECT).
space.hypna.feature.content.distractors: lines (string list), duration (ms, default "3501"), base_frequency (ms, default "1501"), base_random_offset (boolean, default true).

Session-type settings¶

space.hypna.feature.settings.mst: line_duration (ms as string, default "3500").
space.hypna.feature.settings.bst: word_duration (ms as string, default "500").
space.hypna.feature.settings.wlt: interrupters (string list), punishment (string list), interrupters_enabled (boolean, true), interrupters_frequency (keystrokes as string, "40"), interrupters_freq_random (boolean, true), overlay_display_time (ms as string, "3000"), add_lines_as_punishment (integer, 0).
space.hypna.feature.settings.ect: wrongWords (string list), punishment (string list).
space.hypna.feature.settings.stt, space.hypna.feature.settings.act: no configuration keys.
space.hypna.feature.settings.yss: enabled (boolean, true). MST and BST only.

Optional settings features¶

space.hypna.feature.settings.audio: url (string): direct link to an audio file. Always loops.
space.hypna.feature.settings.customCSS: data (string): raw CSS injected into the player.
space.hypna.feature.settings.distractors.basic: enabled (boolean, true). Requires content.distractors.
space.hypna.feature.settings.distractors.wall: enabled (boolean, false), rerender_frequency (ms as string, "3500"). Requires content.distractors.

Spiral features (`spiral` slot)¶

space.hypna.feature.spirals.media: media_url (string, /static/utils/large.gif), media_is_image (boolean, true), media_opacity (string, "0.5").
space.hypna.feature.spirals.webgl: opacity ("0.6"), spiral_color (#FFFFFF), bg_color (#000000), spin_speed (1), throb_speed (2), throb_strength (1), zoom (1).
space.hypna.feature.spirals.customgl: all of the WebGL keys plus fragment_source (string): a WebGL 1 fragment shader. See GLSL spirals.

Image features (`images` slot)¶

space.hypna.feature.images.basic: images (string list of URLs), switch_frequency (ms as string, "950"), images_handled_by_outside_source (boolean, true).
space.hypna.feature.images.scatter: images, images_handled_by_outside_source, spawn_frequency ("1500"), lifetime ("4000"), fade_duration ("800"), max_images (6), size (25), zoom_from (0.6), opacity (0.9).

Session types and their required features¶

Type	Required features
`mst`	content.lines, settings.mst, one spiral, one images feature
`bst`	content.lines, content.time, settings.bst, one spiral, one images feature
`wlt`	content.text, content.time, settings.wlt
`stt`	content.lines, settings.stt
`ect`	content.text, content.time, settings.ect
`act`	content.text, settings.act