Skip to content

Commit 7567f83

Browse files
committed
document current and unmapped options; update release notes template
1 parent 6dea276 commit 7567f83

File tree

4 files changed

+14
-5
lines changed

4 files changed

+14
-5
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ deej is written in Go and [distributed](https://github.com/omriharel/deej/releas
4242
- Bind multiple apps per slider (i.e. one slider for all your games)
4343
- Bind the master channel
4444
- Bind "system sounds" (on Windows)
45-
- **_New:_** Bind specific audio devices by name (on Windows, _experimental_)
45+
- Bind specific audio devices by name (on Windows)
46+
- **_New:_** Bind currently active app (on Windows, _experimental_)
47+
- **_New:_** Bind all other unassigned apps (_experimental_)
4648
- Control your microphone's input level
4749
- Lightweight desktop client, consuming around 10MB of memory
4850
- Runs from your system tray
@@ -99,7 +101,9 @@ noise_reduction: default
99101
```
100102
101103
- `master` is a special option to control the master volume of the system _(uses the default playback device)_
102-
- `mic` is a special option to control your microphone's input level _(uses the default recording device)_.
104+
- `mic` is a special option to control your microphone's input level _(uses the default recording device)_
105+
- **_New:_** `deej.unmapped` is a special option to control all apps that aren't bound to any slider ("everything else") (_experimental_)
106+
- **_New:_** On Windows, `deej.current` is a special option to control whichever app is currently in focus (_experimental_)
103107
- On Windows, you can specify a device's full name, i.e. `Speakers (Realtek High Definition Audio)`, to bind that device's level to a slider. This doesn't conflict with the default `master` and `mic` options, and works for both input and output devices.
104108
- Be sure to use the full device name, as seen in the menu that comes up when left-clicking the speaker icon in the tray menu
105109
- `system` is a special option on Windows to control the "System sounds" volume in the Windows mixer

config.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# process names are case-insensitive
22
# you can use 'master' to indicate the master channel, or a list of process names to create a group
33
# you can use 'mic' to control your mic input level (uses the default recording device)
4-
# windows only - you can use a device's full name, i.e. "Speakers (Realtek High Definition Audio)", to bind it. this works for both output and input devices (experimental)
4+
# you can use 'deej.unmapped' to control all apps that aren't bound to any slider (this ignores master, system, mic and device-targeting sessions) (experimental)
5+
# windows only - you can use 'deej.current' to control the currently active app (whether full-screen or not) (experimental)
6+
# windows only - you can use a device's full name, i.e. "Speakers (Realtek High Definition Audio)", to bind it. this works for both output and input devices
57
# windows only - you can use 'system' to control the "system sounds" volume
68
# important: slider indexes start at 0, regardless of which analog pins you're using!
79
slider_mapping:

scripts/misc/default-config.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# process names are case-insensitive
22
# you can use 'master' to indicate the master channel, or a list of process names to create a group
33
# you can use 'mic' to control your mic input level (uses the default recording device)
4-
# windows only - you can use a device's full name, i.e. "Speakers (Realtek High Definition Audio)", to bind it. this works for both output and input devices (experimental)
4+
# you can use 'deej.unmapped' to control all apps that aren't bound to any slider (this ignores master, system, mic and device-targeting sessions) (experimental)
5+
# windows only - you can use 'deej.current' to control the currently active app (whether full-screen or not) (experimental)
6+
# windows only - you can use a device's full name, i.e. "Speakers (Realtek High Definition Audio)", to bind it. this works for both output and input devices
57
# windows only - you can use 'system' to control the "system sounds" volume
68
# important: slider indexes start at 0, regardless of which analog pins you're using!
79
slider_mapping:

scripts/misc/release-notes.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ This release ___________:
33
- One awesome thing that happened
44
- Another awesome thing
55

6-
Launch instructions:
6+
**Launch instructions**
77

8+
- **First-time users:** download the [Arduino sketch](https://github.com/omriharel/deej/blob/master/arduino/deej-5-sliders-vanilla/deej-5-sliders-vanilla.ino) and upload it to your board ([see full instructions here](https://github.com/omriharel/deej#build-procedure))
89
- Download both `config.yaml` and `deej.exe` and place them in the same directory
910
- Verify that your config has the correct COM port for your Arduino board
1011
- Launch `deej.exe`. You can always edit the config while `deej` is running

0 commit comments

Comments
 (0)