Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kuba2k2/espionage-bot
A Discord bot that plays the Nokia Espionage ringtone for any user entering the AFK channel.
https://github.com/kuba2k2/espionage-bot
bot discord discord-bot docker espionage
Last synced: 17 days ago
JSON representation
A Discord bot that plays the Nokia Espionage ringtone for any user entering the AFK channel.
- Host: GitHub
- URL: https://github.com/kuba2k2/espionage-bot
- Owner: kuba2k2
- Created: 2021-03-06T16:57:27.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-18T18:57:53.000Z (9 months ago)
- Last Synced: 2024-10-11T11:56:48.921Z (about 1 month ago)
- Topics: bot, discord, discord-bot, docker, espionage
- Language: Python
- Homepage: https://hub.docker.com/r/kuba2k2/espionage-bot
- Size: 169 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# espionage-bot
A Discord bot that plays the Nokia Espionage ringtone for any user entering the AFK channel.
The bot can also be summoned manually using commands in `files.json`.
## Usage
### With Docker Compose
```bash
$ mkdir -p ~/docker/espionage-bot
$ cd ~/docker/espionage-bot
$ mkdir ./data/
$ wget https://raw.githubusercontent.com/kuba2k2/espionage-bot/master/docker-compose.yml
$ vim docker-compose.yml
```
Edit the file adding your Discord bot token to `BOT_TOKEN=`.
Choose your desired MIDI implementation in `image:` element:
```bash
kuba2k2/espionage-bot:latest-nomidi # without MIDI support
kuba2k2/espionage-bot:latest-fluidsynth # with MIDI playback with FluidSynth
kuba2k2/espionage-bot:latest-timidity # with MIDI playback with TiMidity++
```
Place the `espionage.mp3` file in `~/docker/espionage-bot/data` (or edit the Compose environment variables accordingly).
Run `espionage-bot`:
```bash
$ docker-compose up --detach
```
### With Docker
```bash
$ git clone https://github.com/kuba2k2/espionage-bot
$ cd espionage-bot
$ mkdir ./data/
$ cp .env.example .env
$ vim .env
```
Edit the file adding your Discord bot token to `BOT_TOKEN=`.
Place the `espionage.mp3` file in the `data/` directory.
Pull and run the image:
```bash
# without MIDI support
$ docker run -d -v $(pwd)/data:/app/data --env-file .env kuba2k2/espionage-bot:latest-nomidi
# with MIDI playback with FluidSynth
$ docker run -d -v $(pwd)/data:/app/data --env-file .env kuba2k2/espionage-bot:latest-fluidsynth
# with MIDI playback with TiMidity++
$ docker run -d -v $(pwd)/data:/app/data --env-file .env kuba2k2/espionage-bot:latest-timidity
```
### With Python (pipenv)
```bash
$ git clone https://github.com/kuba2k2/espionage-bot
$ cd espionage-bot
$ mkdir ./data/
$ cp .env.example .env
$ vim .env
```
Edit the file adding your Discord bot token to `BOT_TOKEN=`.
Place the `espionage.mp3` file in the `data/` directory.
Refer to the discord-py installation guide for other dependencies, e.g. on Linux:
```bash
$ apt install libffi-dev libnacl-dev python3-dev
$ apt install ffmpeg
$ apt install libmagic1
# For MIDI file support - choose one
# When installing MIDI support configure MIDI_IMPL in .env
$ apt install fluidsynth
$ apt install timidity
```
Install and run the project:
```bash
$ pipenv install
$ pipenv run python start.py
```
## Notes
When migrating from previous versions put the old `FILES_JSON` and configured `ESPIONAGE_FILE`
in `DATA_PATH` to have all audio files moved automatically.
The bot should at least have the `Connect`, `Speak`, `Mute Members` and `Move Members` permissions.
To use the MIDI support you should upload at least one SoundFont (.sf2) prior to playing, else weird things may happen.