Getting Started
Welcome to Keyboard Symphony, a rhythm adventure crafted strictly for mechanical and high-refresh keyboard layouts. Unlike standard 4-key rhythm systems, Keyboard Symphony leverages a full 10-lane grid matching your keyboard's home/top row keys.
To begin playing, download the desktop client launcher, register a new player profile (or log in offline), and load up the default levels or import custom community charts.
NOTE: Ensure your mechanical keyboard supports N-Key Rollover (NKRO) to play chords requiring 5+ simultaneous keys accurately.
Keyboard Bindings
The standard layout utilizes the top row of alphabetical keys. These map chronologically to the 10 game lanes moving from left to right:
Additionally, lanes 11 and 12 are reserved for screen camera shakes, lighting drops, and specialty environmental particle effects. These lanes do not require key bindings during active play; they are handled automatically by the rhythm rendering pipeline when the visualizer notes pass the active hitbar.
Creator Level Editor
Unleash your inner beat creator with our Level Editor. Inside the editor dashboard, you can import level assets, set your BPM timings, and configure complex grid configurations.
Key Editor Shortcuts:
- Left Click: Select a note to enter Edit Mode, or click an empty space in edit mode to toggle Spawn Mode.
- Right Click: Remove/delete notes instantly from the active grid.
- Space: Toggle song playback (Play/Stop).
- Mouse Scroll: Vertically zoom or scroll the note timeline.
Place As You Go Mode (PAYGM)
Recording complex streams manually can be tedious. PAYG Mode allows creators to record their chart in real-time:
- Click the ⏺ RECORD (PAYG) button on the editor sidebar.
- A 3-second countdown will trigger, letting you prep your hands.
- The playback playhead starts moving. Tap keys in rhythm to place single beat notes.
- Hold a key down for longer than 0.5 beats to automatically stretch it into a glowing Hold Note until you release the key!
Audio Formats & FFmpeg Integration
To avoid playback stutters, Keyboard Symphony enforces strict OGG audio requirements. If you select a `.mp3` or `.wav` song to map:
- The editor automatically prompts: "The selected audio is not in OGG format. Would you like the game to convert/rename it to .ogg automatically?"
- Clicking Yes: Invokes the local system's FFmpeg engine synchronously to transcode the file:
ffmpeg -y -i input.mp3 -c:a libvorbis -qscale:a 5 output.ogg
- Clicking No: Discards the import entirely to ensure timing integrity.
Cloud Integration & Sync
Keyboard Symphony features a fully automated, offline-first backend powered by Supabase Auth & Database APIs:
- Local Session Encryption: Stores user JWT credentials securely using AES-256 local configuration.
- SyncManager Reconciliation: Whenever you launch the game or complete a level, the game checks your local timestamp against the database and cloud syncs your stars, member stats, XP levels, and custom charts automatically.