Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dromzeh/vmt
✨ Discord Bot that transcribes (& translates) Discord's voice messages into text.
https://github.com/dromzeh/vmt
deepl discord discord-py discord-voice speech-recognition translator voice-recognition
Last synced: 3 months ago
JSON representation
✨ Discord Bot that transcribes (& translates) Discord's voice messages into text.
- Host: GitHub
- URL: https://github.com/dromzeh/vmt
- Owner: dromzeh
- License: mit
- Created: 2023-04-15T17:18:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-12T14:25:35.000Z (over 1 year ago)
- Last Synced: 2024-11-02T10:22:17.636Z (3 months ago)
- Topics: deepl, discord, discord-py, discord-voice, speech-recognition, translator, voice-recognition
- Language: Python
- Homepage:
- Size: 17.6 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
Awesome Lists containing this project
README
# VMT - Discord Voice Message Transcriber and Translator
[](https://github.com/dromzeh/vmt)
[](https://black.readthedocs.io/en/stable/)
A Discord bot that can transcribe and translate Discord Voice Messages.
- Uses the DeepL API for translation and Google's Speech Recognition API for transcription.
## Requirements
- Python 3.8+
- discord.py
- pydub
- speech recognition
- deepl
Run the following:
```bash
pip install -r requirements.txt
```
## Installation
> **Note**
> Bot requires Intents to be enabled in the developer portal & an API key for the DeepL API.
- Clone the repository: `git clone https://github.com/dromzeh/vmt.git`
- Rename the `config.example.json` file to `config.json` inside `src/config` and fill in the necessary values (See [Configuration](#configuration))
Once the configuration file has been filled, you may run the bot using one of the following methods:
### Native Installation
- Install the requirements `pip install -r requirements.txt`
- Run the bot inside the `/src` folder: `python main.py`
### Docker Installation (Easier)
Assuming `docker` and `docker-compose` are installed
```bash
docker-compose -f compose.yaml up
```
## Usage
- To use the bot, simply reply to a voice message with the `transcribe` command. The bot will transcribe the voice message and post the transcription as a reply, if you don't reply, the bot will find the most recent voice message in the channel and transcribe it instead.
- If you want to automatically translate the text, you can just add the language code as an argument, such as : `vmt transcribe es` for Spanish, full list is available at `vmt languages` or [here](#language-code-list).
- The bot will then automatically translate the text using the DeepL API.
### Configuration
The config.json file contains the following fields:
- `discord_token`: Your Discord bot token.
- `deepl_api_key`: Your DeepL API key.
- `language_codes`: A dictionary of language codes and their corresponding language names.
### Language Code List
Click to expand
```js
"language_codes": {
"BG": "Bulgarian",
"CS": "Czech",
"DA": "Danish",
"DE": "German",
"EL": "Greek",
"EN-GB": "English (British)",
"EN-US": "English (American)",
"ES": "Spanish",
"ET": "Estonian",
"FI": "Finnish",
"FR": "French",
"HU": "Hungarian",
"ID": "Indonesian",
"IT": "Italian",
"JA": "Japanese",
"KO": "Korean",
"LT": "Lithuanian",
"LV": "Latvian",
"NB": "Norwegian (Bokmål)",
"NL": "Dutch",
"PL": "Polish",
"PT-BR": "Portuguese (Brazilian)",
"PT-PT": "Portuguese",
"RO": "Romanian",
"RU": "Russian",
"SK": "Slovak",
"SL": "Slovenian",
"SV": "Swedish",
"TR": "Turkish",
"UK": "Ukrainian",
"ZH": "Chinese (simplified)"
}
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.