Skip to content

Commit

Permalink
document current and unmapped options; update release notes template
Browse files Browse the repository at this point in the history
  • Loading branch information
omriharel committed Aug 31, 2020
1 parent 6dea276 commit 7567f83
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 5 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ deej is written in Go and [distributed](https://github.com/omriharel/deej/releas
- Bind multiple apps per slider (i.e. one slider for all your games)
- Bind the master channel
- Bind "system sounds" (on Windows)
- **_New:_** Bind specific audio devices by name (on Windows, _experimental_)
- Bind specific audio devices by name (on Windows)
- **_New:_** Bind currently active app (on Windows, _experimental_)
- **_New:_** Bind all other unassigned apps (_experimental_)
- Control your microphone's input level
- Lightweight desktop client, consuming around 10MB of memory
- Runs from your system tray
Expand Down Expand Up @@ -99,7 +101,9 @@ noise_reduction: default
```
- `master` is a special option to control the master volume of the system _(uses the default playback device)_
- `mic` is a special option to control your microphone's input level _(uses the default recording device)_.
- `mic` is a special option to control your microphone's input level _(uses the default recording device)_
- **_New:_** `deej.unmapped` is a special option to control all apps that aren't bound to any slider ("everything else") (_experimental_)
- **_New:_** On Windows, `deej.current` is a special option to control whichever app is currently in focus (_experimental_)
- 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.
- 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
- `system` is a special option on Windows to control the "System sounds" volume in the Windows mixer
Expand Down
4 changes: 3 additions & 1 deletion config.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# process names are case-insensitive
# you can use 'master' to indicate the master channel, or a list of process names to create a group
# you can use 'mic' to control your mic input level (uses the default recording device)
# 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)
# 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)
# windows only - you can use 'deej.current' to control the currently active app (whether full-screen or not) (experimental)
# 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
# windows only - you can use 'system' to control the "system sounds" volume
# important: slider indexes start at 0, regardless of which analog pins you're using!
slider_mapping:
Expand Down
4 changes: 3 additions & 1 deletion scripts/misc/default-config.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# process names are case-insensitive
# you can use 'master' to indicate the master channel, or a list of process names to create a group
# you can use 'mic' to control your mic input level (uses the default recording device)
# 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)
# 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)
# windows only - you can use 'deej.current' to control the currently active app (whether full-screen or not) (experimental)
# 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
# windows only - you can use 'system' to control the "system sounds" volume
# important: slider indexes start at 0, regardless of which analog pins you're using!
slider_mapping:
Expand Down
3 changes: 2 additions & 1 deletion scripts/misc/release-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ This release ___________:
- One awesome thing that happened
- Another awesome thing

Launch instructions:
**Launch instructions**

- **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))
- Download both `config.yaml` and `deej.exe` and place them in the same directory
- Verify that your config has the correct COM port for your Arduino board
- Launch `deej.exe`. You can always edit the config while `deej` is running
Expand Down

0 comments on commit 7567f83

Please sign in to comment.