Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/locaal-ai/obs-polyglot
Realtime local AI translation services for OBS based on CTranslate2
https://github.com/locaal-ai/obs-polyglot
ctranslate2 obs obs-plugin obs-studio obs-studio-plugin real-time-translation realtime-translator translation
Last synced: 5 days ago
JSON representation
Realtime local AI translation services for OBS based on CTranslate2
- Host: GitHub
- URL: https://github.com/locaal-ai/obs-polyglot
- Owner: locaal-ai
- License: gpl-2.0
- Created: 2023-10-18T21:26:46.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-26T14:48:38.000Z (8 months ago)
- Last Synced: 2024-11-06T01:37:06.694Z (9 days ago)
- Topics: ctranslate2, obs, obs-plugin, obs-studio, obs-studio-plugin, real-time-translation, realtime-translator, translation
- Language: CMake
- Homepage: https://obsproject.com/forum/resources/polyglot-real-time-local-translation-ai-service-for-obs.1818/
- Size: 118 KB
- Stars: 61
- Watchers: 2
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ployglot - Translation AI assistant OBS Plugin
[](https://github.com/obs-ai/obs-polyglot/blob/main/LICENSE)
[](https://github.com/obs-ai/obs-polyglot/actions/workflows/push.yaml)
[](https://github.com/obs-ai/obs-polyglot/releases)
[](https://github.com/obs-ai/obs-polyglot/releases)
[](https://discord.gg/KbjGU2vvUz)
## Introduction
Polyglot translation AI plugin allows you to translate text in multiple languages in real-time and locally on your machine. ✅ No GPU required, ✅ no cloud costs, ✅ no network and ✅ no downtime! Privacy first - all data stays on your machine.
"polyglot" is derived from the Greek words: "poly-" meaning "many"and "glōtta" (or "glōssa") meaning "tongue" or "language".
It's using the excellent [CTranslate2](https://github.com/OpenNMT/CTranslate2) project from [OpenNMT](https://opennmt.net/).
If this free plugin has been valuable to you consider adding a ⭐ to this GH repo, subscribing to [my YouTube channel](https://www.youtube.com/@royshilk) where I post updates, and supporting my work: https://github.com/sponsors/royshil
### Usage Tutorial
Watch a short tutorial on how to use and setup Polyglot on your OBS scene.
https://youtu.be/ZMNILPWDkDw
Current Features:
- Translate in real time using an internal HTTP server
- Choice of CTranslate2 model file
Roadmap:
- Translation directly on OBS text sources, e.g. with a filter
- Translation of live stream or recording captions
Check out our other plugins:
- [Background Removal](https://github.com/royshil/obs-backgroundremoval) removes background from webcam without a green screen.
- 🚧 Experimental 🚧 [CleanStream](https://github.com/obs-ai/obs-cleanstream) for real-time filler word (uh,um) and profanity removal from live audio stream
- [URL/API Source](https://github.com/obs-ai/obs-urlsource) that allows fetching live data from an API and displaying it in OBS.
- [LocalVocal](https://github.com/royshil/obs-localvocal) speech AI assistant plugin for real-time transcription (captions), translation and more language functions
## Download
Check out the [latest releases](https://github.com/obs-ai/obs-polyglot/releases) for downloads and install instructions.
### Models
_You need to download a CT2 model for the translation service to work._
Here are download links for models that are compatible with the plugin:
- https://forum.opennmt.net/t/nllb-200-with-ctranslate2/5090 NLLB-200 multilingual model (recommended) ([List of NLLB language codes](https://github.com/facebookresearch/LASER/blob/main/nllb/README.md))
- https://huggingface.co/models?sort=trending&search=ctranslate CTranslate2 models on HuggingFace
Download models options: (get e.g. `model.bin` and SPM = SentencePiece Model `.model` file)
- https://forum.opennmt.net/t/nllb-200-with-ctranslate2/5090 (NLLB)
- https://huggingface.co/JustFrederik/m2m_100_418m_ct2_int8/tree/main (M2M100)
- https://huggingface.co/Rohith04/ct2fast_m2m100_418M/tree/main (M2M100)
- https://huggingface.co/jncraton/m2m100_418M-ct2-int8/tree/main (M2M100)
## Building
The plugin was built and tested on Mac OSX (Intel & Apple silicon), Windows and Linux.
Start by cloning this repo to a directory of your choice.
Remember to sync and fetch the submodules before building, e.g.
```sh
$ git submodule sync --recursive
$ git update --init --recursive
```
### Mac OSX
Using the CI pipeline scripts, locally you would just call the zsh script. By default this builds a universal binary for both Intel and Apple Silicon. To build for a specific architecture please see `.github/scripts/.build.zsh` for the `-arch` options.
```sh
$ ./.github/scripts/build-macos -c Release
```
#### Install
The above script should succeed and the plugin files (e.g. `obs-urlsource.plugin`) will reside in the `./release/Release` folder off of the root. Copy the `.plugin` file to the OBS directory e.g. `~/Library/Application Support/obs-studio/plugins`.
To get `.pkg` installer file, run for example
```sh
$ ./.github/scripts/package-macos -c Release
```
(Note that maybe the outputs will be in the `Release` folder and not the `install` folder like `pakage-macos` expects, so you will need to rename the folder from `build_x86_64/Release` to `build_x86_64/install`)
### Linux (Ubuntu)
Use the CI scripts again
```sh
$ ./.github/scripts/build-linux.sh
```
Copy the results to the standard OBS folders on Ubuntu
```sh
$ sudo cp -R release/RelWithDebInfo/lib/* /usr/lib/x86_64-linux-gnu/
$ sudo cp -R release/RelWithDebInfo/share/* /usr/share/
```
Note: The official [OBS plugins guide](https://obsproject.com/kb/plugins-guide) recommends adding plugins to the `~/.config/obs-studio/plugins` folder.
### Windows
Use the CI scripts again, for example:
```powershell
> .github/scripts/Build-Windows.ps1 -Target x64 -CMakeGenerator "Visual Studio 17 2022"
```
The build should exist in the `./release` folder off the root. You can manually install the files in the OBS directory.