Skip to content

Commit

Permalink
Add description of GUI controls to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nuess0r authored Jul 29, 2024
1 parent e889ef3 commit c6602b4
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,28 @@ It will listen to audio input and produce mesmerizing visuals. Some commands are
This project is in a bit of a transition state and is in the process of being modernized. There are many rough edges at
present.

## GUI controls


| Command | Keyboard | Mouse | Game Controller |
| --- | --- | --- | --- |
| Add a new waveform | | `ctrl` + Left | |
| Clear all custom waveforms | | Middle | |
| Toggle full screen | `ctrl` + `f` | Right | A |
| Show/hide GUI | `esc` | | Start |
| Random preset | `r` | | B |
| Next preset | `n` | | D-Pad right |
| Previous preset | `p` | | D-Pad left |
| Increase beat sensitivity | `Up` | Wheel up | D-Pad up |
| Decrease beat sensitivity | `Down` | Wheel down | D-Pad down |
| Toggle shuffle | `y` | | Y |
| Last preset | `Backspace` | | Guide |
| TogglePresetLocked | `Space` | | X |
| NextAudioDevice | `ctrl` + `i` | | Shoulder left |
| NextDisplay | `ctrl` + `m` | | Shoulder right |
| Toggle aspect ratio correction | `a` | | |
| Quit | `q` | | Back |

## Building from source

### Build and install libprojectM
Expand Down

0 comments on commit c6602b4

Please sign in to comment.