Skip to content

Commit 1c60f04

Browse files
committed
Update README
1 parent 3704e6b commit 1c60f04

File tree

1 file changed

+37
-18
lines changed

1 file changed

+37
-18
lines changed

README.md

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
An app for macOS that lets you play MIDI files as a bard on Final Fantasy XIV.
66

7-
<a href="https://github.com/mixxorz/GarageBard/releases/latest/download/GarageBard.dmg">
7+
<a href="https://github.com/mixxorz/GarageBard/releases/latest/download/GarageBard-1.1.0.dmg">
88
<img width="150" src="https://user-images.githubusercontent.com/3102758/158105072-519b1bbe-2d58-4aa0-a534-f1858add2e9b.png" alt="Download button">
99
</a>
1010

@@ -23,11 +23,11 @@ You load up MIDI files and GarageBard "plays" them by sending keystrokes to the
2323

2424
## Screenshots
2525

26-
![Screenshots](https://user-images.githubusercontent.com/3102758/158063994-fe2b0857-8a58-426b-ab85-68f0c9fa44fb.png)
26+
![Screenshots](https://user-images.githubusercontent.com/3102758/159173959-b97f8fb1-eb0d-4f30-aa24-fb4e34f6536e.png)
2727

2828
## Instructions
2929

30-
1. Download the [latest release](https://github.com/mixxorz/GarageBard/releases/latest/download/GarageBard.dmg) from GitHub.
30+
1. Download the [latest release](https://github.com/mixxorz/GarageBard/releases/latest/download/GarageBard-1.1.0.dmg) from GitHub.
3131
1. Copy GarageBard to your Applications folder
3232
1. Launch GarageBard and grant it Accessibility access
3333
1. Load up some songs by dragging in MIDI files into GarageBard
@@ -42,33 +42,47 @@ You load up MIDI files and GarageBard "plays" them by sending keystrokes to the
4242

4343
![Performance mode keybindings](https://user-images.githubusercontent.com/3102758/158063314-6fcbc177-d41f-4fb5-bd04-8c24ea7040ee.png)
4444

45+
_(This is needed because the default keybinds do not have keybinds for all the notes.)_
46+
4547
## Usage
4648

49+
### Overlay mode
50+
51+
When enabled, GarageBard will stay on top of the game so that it's always
52+
visible.
53+
4754
### Perform/Listen modes
4855

4956
You can swap between Perform and Listen modes depending on what you want to do:
5057

5158
- **Perform**: Send keystrokes to play the song
5259
- **Listen**: Listen to the song using GarageBard's synthesizer
5360

54-
### Transpose out of range notes
61+
### Transpose
5562

56-
When this is turned on, notes that fall outside what's playable in the game are
57-
automatically transposed up or down to fit within the range of what's playable.
63+
Shows the range of notes on this track.
5864

59-
You will have to queue the song again once you make this change.
65+
Type a number to transpose by semitones (e.g. +7, -5). Type a note name to set
66+
the lowest note (e.g. C2, G#3). Prefix the note name with a "-" to set the
67+
highest note (e.g. -C5, -F#4).
6068

61-
### Arpeggiate chords
69+
(The game can play notes from C2 to C5.)
6270

63-
When this is turned on, all chords will automatically be arpeggiated, so they
64-
sound better. Generally, you will want this on.
71+
### Octave remap
6572

66-
You will have to queue the song again once you make this change.
73+
Adjusts all notes to fit within the game's playable range (C2-C5).
6774

68-
### Overlay mode
75+
Notes outside the range are transposed N octaves up or down until they're within
76+
the range (e.g. D1->D2, A#7->A#4).
6977

70-
When enabled, GarageBard will stay on top of the game so that it's always
71-
visible.
78+
### Arpeggiate
79+
80+
Ensures that a chord's notes are played in ascending order.
81+
82+
Notes played concurrently are played in ascending order (e.g. If G, C, and E are
83+
played at the same time, C is played first, then E, then G).
84+
85+
This will generally make chords sound better so it's a good option to have on.
7286

7387
## Troubleshooting
7488

@@ -100,11 +114,16 @@ so I can make the process detection better.
100114
**Some notes are out of range**
101115

102116
This message means that there are some notes on the selected track of the
103-
current song that fall beyond the range of what can be played in the game. When
104-
GarageBard encounters these notes, it simply ignores them.
117+
current song that fall beyond the range of what can be played in the game.
118+
119+
GarageBard provides a couple of tools to mitigate this; the transposer and the
120+
octave remapper. You can try to transpose the track so that all the notes fall
121+
within C2-C5. Otherwise, you can turn on the octave remapper (on by default)
122+
which will automatically transpose out of range notes to fit within playable
123+
range.
105124

106-
The only way to fix this issue is to manually tweak the song using a MIDI editor
107-
so that none of the notes fall below C2 and above C5.
125+
The best but hardest way to address this issue is to manually edit the song
126+
using a MIDI editor so that all notes fall above C2 and below C5.
108127

109128
# License
110129

0 commit comments

Comments
 (0)