Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #483

Merged
merged 1 commit into from
Nov 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

<div align="center">

[![GitHub](https://img.shields.io/github/license/royshil/obs-backgroundremoval)](https://github.com/royshil/obs-backgroundremoval/blob/main/LICENSE)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/royshil/obs-backgroundremoval/push.yaml)](https://github.com/royshil/obs-backgroundremoval/actions/workflows/push.yaml)
[![Total downloads](https://img.shields.io/github/downloads/royshil/obs-backgroundremoval/total)](https://github.com/royshil/obs-backgroundremoval/releases)
[![GitHub](https://img.shields.io/github/license/occ-ai/obs-backgroundremoval)](https://github.com/occ-ai/obs-backgroundremoval/blob/main/LICENSE)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/occ-ai/obs-backgroundremoval/push.yaml)](https://github.com/occ-ai/obs-backgroundremoval/actions/workflows/push.yaml)
[![Total downloads](https://img.shields.io/github/downloads/occ-ai/obs-backgroundremoval/total)](https://github.com/occ-ai/obs-backgroundremoval/releases)
![Flathub](https://img.shields.io/flathub/downloads/com.obsproject.Studio.Plugin.BackgroundRemoval?label=Flathub%20Installs)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/royshil/obs-backgroundremoval)](https://github.com/royshil/obs-backgroundremoval/releases)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/occ-ai/obs-backgroundremoval)](https://github.com/occ-ai/obs-backgroundremoval/releases)

</div>

Expand All @@ -19,18 +19,18 @@ A plugin for [OBS Studio](https://obsproject.com/) that allows you to replace th
- [Windows](#windows)

Other plugins from us:
- 🚧 Experimental 🚧: [CleanStream](https://github.com/royshil/obs-cleanstream) OBS plugin for real-time filler word (uh,um) and profanity removal from live audio stream
- [URL/API Source](https://github.com/royshil/obs-urlsource) a plugin for live fetching of API data and displaying on screen as a video source
- [LocalVocal](https://github.com/royshil/obs-localvocal) speech AI assistant plugin for real-time local transcription (captions), translation and other language functions
- ✨ NEW: [Polyglot](https://github.com/obs-ai/obs-polyglot) translation AI plugin for real-time, local translation to hunderds of languages
- 🚧 Experimental 🚧: [CleanStream](https://github.com/occ-ai/obs-cleanstream) OBS plugin for real-time filler word (uh,um) and profanity removal from live audio stream
- [URL/API Source](https://github.com/occ-ai/obs-urlsource) a plugin for live fetching of API data and displaying on screen as a video source
- [LocalVocal](https://github.com/occ-ai/obs-localvocal) speech AI assistant plugin for real-time local transcription (captions), translation and other language functions
- ✨ NEW: [Polyglot](https://github.com/occ-ai/obs-polyglot) translation AI plugin for real-time, local translation to hunderds of languages


## Download
Check out the [official site](https://obs-ai.github.io/obs-backgroundremoval) for downloads and install instructions.
Check out the [official site](https://occ-ai.github.io/obs-backgroundremoval) for downloads and install instructions.

### Linux Installation
On Ubuntu, there are two ways to install OBS and you have to use the corresponding method to install this plugin.
- If you installed OBS via the official PPA, download the deb package from the [releases](https://github.com/royshil/obs-backgroundremoval/releases) page and install it directly.
- If you installed OBS via the official PPA, download the deb package from the [releases](https://github.com/occ-ai/obs-backgroundremoval/releases) page and install it directly.
- If you installed OBS via FlatHub, run the following command: `flatpak install com.obsproject.Studio.Plugin.BackgroundRemoval`

The pre-built binary of this plugin can run Ubuntu 22.04 or later.
Expand Down Expand Up @@ -69,7 +69,7 @@ OBS Plugins forum: https://obsproject.com/forum/resources/background-removal-por

Tutorial video on YouTube: https://youtu.be/veqNEsMqEE0

https://github.com/royshil/obs-backgroundremoval/assets/1067855/5ba5aae2-7ea2-4c90-ad45-fba5ccde1a4e
https://github.com/occ-ai/obs-backgroundremoval/assets/1067855/5ba5aae2-7ea2-4c90-ad45-fba5ccde1a4e

GPU support:
* Currently on Windows we support DirectML, which should reduce CPU usage by 95% and effectively use the systems accelerators (GPUs if available).
Expand Down Expand Up @@ -152,7 +152,7 @@ Use the CI scripts again, for example:
The build should exist in the `./release` folder off the root. You can manually install the files in the OBS directory.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=royshil/obs-backgroundremoval&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=royshil/obs-backgroundremoval&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=royshil/obs-backgroundremoval&type=Date" />
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=occ-ai/obs-backgroundremoval&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=occ-ai/obs-backgroundremoval&type=Date" />
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=occ-ai/obs-backgroundremoval&type=Date" />
</picture>