aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVidhu Kant Sharma <vidhukant@protonmail.ch>2021-12-12 22:32:07 +0530
committerVidhu Kant Sharma <vidhukant@protonmail.ch>2021-12-12 22:32:07 +0530
commitda746a9fcbdc47976db2579898aa86ff9851e780 (patch)
tree6f281b205ed9cd363627fc91552bc7d9c98f3ee4
parent82c401f40328010541695000b162e9054f9b9892 (diff)
Update README for instructionsHEADmain
-rw-r--r--README.md21
-rwxr-xr-xdiscord_input.sh1
2 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index 2e6397a..da9c6dc 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,9 @@ chmod +x discord_input.sh
I recommend moving the script to your $PATH.
## How to use
-Run the script with `./discord_input.sh`
+Run the script with `./discord_input.sh` or add the script to $PATH to eliminate the `./`
+
+Show help with `discord_input -h`
NOTE: You can configure the loopbacks created using pavucontrol.
@@ -23,13 +25,22 @@ discord_input.sh -n 3 # merges 3 streams together
```
If not specified, it will ask you
+- Pass the sources to loopback from with `-s`. you don't need to pass `-n` with this.
+Interactive mode will be disabled
+```
+discord_input.sh -s bluez_sink.B8_69_C2_A6_32_96.handsfree_head_unit.monitor -s bluez_source.B8_69_C2_A6_32_96.handsfree_head_unit -S no
+```
+
+you can either use `pacmd-list-sources` or interactive (without `-s` flag) mode to see the source name. This flag is useful for use with keybindings, etc.
+
+if you are using the `-s` flag, you can't use `-S ask`
-- Automatically change discord's input if you are in a VC with `-s yes|no|ask`
+- Automatically change discord's input if you are in a VC with `-S yes|no|ask`
```
-discord_input.sh -s ask # default option, asks if you want to switch discord's input
-discord_input.sh -s no # don't switch discord's input
-discord_input.sh -s yes # switch discord's input
+discord_input.sh -S ask # default option, asks if you want to switch discord's input
+discord_input.sh -S no # don't switch discord's input
+discord_input.sh -S yes # switch discord's input
```
- Change name of new virtual sink created with `-N`
diff --git a/discord_input.sh b/discord_input.sh
index 707176f..e05f025 100755
--- a/discord_input.sh
+++ b/discord_input.sh
@@ -27,6 +27,7 @@ show_help() {
echo -e "-S\tSwitch Discord's Input Or Not (yes/no/ask). if -s is used, 'ask' will be disabled"
echo -e "-N\tSpecify a Name For The Merged Sink"
echo -e "-D\tSpecify a Description For The Merged Sink"
+ echo -e "-h\tDisplay this message and quit"
exit
}