Online documentation

Getting started

Fully extract the release ZIP into a writable folder. Do not run inside the archive or place it under Program Files.

Run GenshinPiano.exe. The first launch follows your Windows language and theme.

• Use the + beside Current Score to create a project
• Use File → Open for .gpiano, MIDI, or MusicXML
• You can also drag supported files into the main window

Files and score library

The app is portable. Settings, logs, update caches, and add-ons remain in the application folder.

• Ctrl + N creates; Ctrl + O opens; Ctrl + Shift + S saves as
• A chosen score folder lists .gpiano and .mid files in its current level
• Rename with the context menu or F2; file and score titles update together
• Unsaved work is checked before switching files or closing
• Register .gpiano under Settings → File association

Piano-roll editing

The snap grid controls movement and creation steps. New-note length follows the most recently used duration.

• Click empty grid space to create; drag notes to move
• Ctrl + click or marquee adds to selection; Ctrl + A selects all
• Arrow keys move by the grid; add Shift to move one beat
• Ctrl + drag copies; Delete removes; Ctrl + Z / Y undo or redo
• Drag the right edge for beat length; right-click for key-hold ratio

Timeline and local preview

Displayed time follows BPM. Local preview never sends keys to the game.

• Click or drag the ruler to place the playhead
• Space plays or pauses; selected notes can loop
• Ctrl + wheel zooms horizontally; Shift + wheel scrolls
• Ctrl + Shift + wheel zooms vertically
• Adjust BPM, sustain, volume, and instrument at the bottom

In-game performance

If the game is elevated, manually run GenshinPiano as administrator too. The app never requests elevation by itself.

• Press F5, then focus YuanShen.exe or GenshinImpact.exe
• Playback begins after the game stays focused for three seconds
• Losing focus pauses; returning resumes
• Press Escape in the game to pause and release keys
• Shift + F5 stops; shutdown and failure paths force key release

MIDI, MusicXML, and legacy scores

Keep imported short notes as-is or regenerate key-hold lengths with the Edit menu tools.

• Open MIDI for interactive import
• Keep the original 0–127 pitch or map into the 21-key range
• MusicXML supports measures, voices, chords, ties, and piano parts
• Batch conversion handles the selected folder level without recursion
• Convert legacy .GenshinPiano files into .gpiano

Numbered-notation OCR

OCR is experimental. Complex layouts, low resolution, watermarks, and ties may need manual correction after import.

• Open Import → OCR score recognition
• Download the separately signed add-on on first use
• Choose image, notation type, watermark suppression, and accompaniment
• Review note count and confidence before import
• OCR completion notifications are configurable

Updates, rollback, and network

Network access, automatic updates, and preview releases are controlled under Settings → Updates.

• Check GitHub and GitCode update mirrors
• Resume downloads and verify SHA-256 plus RSA signatures
• Restart to install; failures attempt to restore the old build
• Manual rollback restores the most recent pre-update backup
• Main-app updates do not remove the OCR add-on

Logs and support

Logs are stored in the logs folder beside the app. Keep relevant logs for crashes, update failures, and OCR issues.

• Include Windows and application versions
• Describe steps that reproduce the issue
• Review local paths and score names before sharing logs