diff options
| author | Vidhu Kant Sharma <vidhukant@protonmail.ch> | 2021-12-12 02:45:01 +0530 |
|---|---|---|
| committer | Vidhu Kant Sharma <vidhukant@protonmail.ch> | 2021-12-12 02:45:01 +0530 |
| commit | 315779d483f9231b1685fc01a1361f24f9d65a9f (patch) | |
| tree | e9a3112749795e2f944edf69e7c5c1a92d2af3d7 | |
| parent | 1f575867fa279fb0f2947ad5c9a3118062d5e06f (diff) | |
Update README
| -rw-r--r-- | README.md | 49 | ||||
| -rwxr-xr-x | discord_input.sh | 16 |
2 files changed, 65 insertions, 0 deletions
@@ -1,2 +1,51 @@ # discord-custom-input Merge two or more audio streams to share desktop audio on discord/any other program + +## How to install +To download and make script executable: + +``` +curl -s https://raw.githubusercontent.com/MikunoNaka/discord-custom-input/main/discord_input.sh > discord_input.sh +chmod +x discord_input.sh +``` + +I recommend moving the script to your $PATH. + +## How to use +Run the script with `./discord_input.sh` + +NOTE: You can configure the loopbacks created using pavucontrol. + +### Arguments available +- Specify the number of sources/streams to merge together with `-n` +``` +discord_input.sh -n 3 # merges 3 streams together +``` +If not specified, it will ask you + + + +- 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 +``` + +- Change name of new virtual sink created with `-N` +``` +discord_input.sh -N MySinkName +``` +Helps avoid confusion if you are using multiple instances of this. + +- Change description of new virtual sink with `-D` +``` +discord_input.sh -D MySinkDescription +``` + +## Licence +Licenced under GNU General Public Licence + +GNU GPL Licence: https://www.gnu.org/licenses/ + +Copyright (c) 2021 Vidhu Kant Sharma diff --git a/discord_input.sh b/discord_input.sh index e895f6b..16bcc44 100755 --- a/discord_input.sh +++ b/discord_input.sh @@ -1,3 +1,19 @@ +# <one line to give the program's name and a brief idea of what it does.> +# Copyright (C) 2021 Vidhu Kant Sharma +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <https://www.gnu.org/licenses/>. + #!/usr/bin/env bash switch_discord_input=ask # ask|yes|no |