Files
Discord-Radio-Bot/README.md
Logan Cusano c07220f434 Update readme
2022-03-30 01:37:54 -04:00

26 lines
1.4 KiB
Markdown

# Discord-Radio-Bot
This project is intended to allow users in discord to be able to listen to their favorite radio stations, *music or other ;)*, while talking to their friends.
## Requirements
- Python 3.X
- *See `requirements.txt`*
- GQRX (if you want the bot to be able to control the sdr)
- Any SDR app you want, as long as it plays audio
## Setup
1. Install the pip packages found in the ```Requirements.txt``` file
- *Optional if you are using OP25* Run `echo 0 > /sys/module/usbcore/parameters/usbfs_memory_mb`
3. Run ```main.py``` with Python
4. Follow the prompts in the terminal
5. Ensure your audio is playing on the selected device
5You're all set! Ask the bot to join!
### Understanding Audio Input
This title can be a bit confusing. The bot will display both 'input' and 'output' devices but not always *all* devices connected.
Voicemeeter is **highly** recommended for this bot. See a detailed guide on how to use Voicemeeter Banana's (identical in function to Potato or Voicemeeter) I/O [here](https://gist.github.com/Immotay/fa47b1105aaed89a284106ae2ee9b66f).
### Changing audio sources
To change the audio source, simply delete the ```config.ini``` that was generated and restart the bot.
It will re-do the setup and allow you to select a new device.
### [To-Do](https://git.vpn.cusano.net/Discord_Bot_Gang/Discord-Radio-Bot/src/branch/master/TODO.md)