Browse docs

Report a Bug

1 min read
0:002:26

A good bug report lets the problem be reproduced and fixed on the first try, without a long back-and-forth. This page shows what to collect and where to send it; most reports take five minutes.

Check first

  • Update to the latest version (see Updating Orfeo). The bug may already be fixed.
  • Look through Troubleshooting for a known fix.
  • If you have a GitHub account, search the open issues. If your bug is there, add a comment with your details instead of opening a new one.

Collect the details

Detail

Where to find it

Orfeo version

Bottom of Setup, for example Orfeo · v1.4.0

Build

Installer or portable. The portable file is named Orfeo-<version>-portable.exe.

Windows version

Press Win+R, type winver and press Enter

Sound engine

Settings → Audio: GM, Studio or Native (beta), with Shared or Exclusive, and which soundfont

MIDI keyboard

Its make and model, if the bug involves one

Write the steps to reproduce

Describe the shortest path from opening Orfeo to seeing the bug, one action per line:

  • Open MySong.mid from the library.
  • Loop bars 12 to 16 and set the tempo to 70%.
  • Press Space.
  • Expected: the loop repeats. Actual: playback stops at bar 16.

Say whether it happens every time or only sometimes, and whether it happens with other songs too.

Attach what helps

  • The MIDI file, if the bug appears with one song. It is the single most useful thing you can send.
  • A screenshot or short screen recording. Press Win+Shift+S for a screenshot, or Win+Alt+R to record with the Xbox Game Bar.
  • Error messages from the developer console, see below.

Copy errors from the developer console

Orfeo logs technical errors to a hidden console. Copying them into your report often points straight at the cause.

  • Reproduce the bug.
  • Press Ctrl+Shift+I. The developer tools open beside the app.
  • Click the Console tab.
  • Look for lines in red. Right-click in the console, choose Save as… and attach the file, or select the red lines and copy them into your report.
  • Press Ctrl+Shift+I again to close the tools.

IMAGE · support-devtools-console.png · 1400 × 800 px · Orfeo with the developer tools open on the right, the Console tab selected and one red error line highlighted.

 Tip

The console is read-only for this purpose. Don’t type or paste anything into it; just copy what is already there.

Send the report

If you

Send it to

Have a GitHub account

GitHub Issues: click New issue and paste your report

Don’t have one

The contact form, or email [email protected] with your files attached