Skip to content

Commit 913a398

Browse files
committed
Merge branch 'main' of github.com:plemeri/transparent-background into main
2 parents 7c006f4 + 9949206 commit 913a398

File tree

1 file changed

+37
-13
lines changed

1 file changed

+37
-13
lines changed

README.md

Lines changed: 37 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,12 @@ package | version (>=)
4141
`pyvirtualcam` (optional) | `0.6.0`
4242

4343
Note: If you have any problem with [`pyvirtualcam`](https://pypi.org/project/pyvirtualcam/), please visit their github repository or pypi homepage. Due to the backend workflow for Windows and macOS, we only support Linux for webcam input.
44-
### Dependencies (webcam input)
44+
### Dependencies
4545

46+
#### 1. Webcam input
4647
We basically follow the virtual camera settings from [`pyvirtualcam`](https://pypi.org/project/pyvirtualcam/). If you do not choose to install virtual camera, it will visualize real-time output with `cv2.imshow`.
4748

48-
#### A. Linux (v4l2loopback)
49+
##### A. Linux (v4l2loopback)
4950

5051
```bash
5152
# Install v4l2loopback for webcam relay
@@ -56,32 +57,48 @@ $ sudo depmod -a
5657
# Create virtual webcam
5758
$ sudo modprobe v4l2loopback devices=1
5859
```
60+
* Note: If you have any problem with installing [`v4l2loopback`](https://github.com/umlaeute/v4l2loopback), please visit their github repository.
5961

60-
Note: If you have any problem with installing [`v4l2loopback`](https://github.com/umlaeute/v4l2loopback), please visit their github repository.
61-
62-
#### B. Windows (OBS)
62+
##### B. Windows (OBS)
6363

6464
Install OBS virtual camera from [install OBS](https://obsproject.com/).
6565

66-
#### C. macOS (OBS) [not stable]
66+
##### C. macOS (OBS) [not stable]
6767

6868
Follow the steps below.
6969
* [Install OBS](https://obsproject.com/).
7070
* Start OBS.
7171
* Click "Start Virtual Camera" (bottom right), then "Stop Virtual Camera".
7272
* Close OBS.
7373

74+
#### 2. File explorer for GUI
75+
##### A. Linux
76+
You need to install `zenity` to open files and directories on Linux
77+
```bash
78+
sudo apt install zenity
79+
```
80+
7481
### Install `transperent-background`
82+
* Note: please specify `extra-index-url` as below if you want to use gpu, particularly on Windows.
83+
#### Install from `pypi`
7584
```bash
76-
# via pypi
77-
$ pip install transparent-background
78-
$ pip install transparent-background[webcam] # with webcam dependency
85+
pip install --extra-index-url https://download.pytorch.org/whl/cu118 transparent-background # install with official pytorch
86+
```
87+
##### With webcam support (not stable)
88+
```bash
89+
pip install transparent-background[webcam] # with webcam dependency
90+
```
7991

80-
# via github
81-
$ pip install git+https://github.com/plemeri/transparent-background.git
92+
#### Install from github
93+
```bash
94+
pip install --extra-index-url https://download.pytorch.org/whl/cu118 git+https://github.com/plemeri/transparent-background.git
95+
```
8296

83-
# locally
84-
$ pip install .
97+
#### Install from local
98+
```bash
99+
git clone https://github.com/plemeri/transparent-background.git
100+
cd transparent-backbround
101+
pip --extra-index-url https://download.pytorch.org/whl/cu118 install .
85102
```
86103

87104
### [New] Configuration
@@ -124,6 +141,13 @@ $ transparent-background --source test.png --mode custom
124141

125142
## :pencil2: Usage
126143

144+
### :+1: GUI
145+
You can use gui with following command after installation.
146+
```bash
147+
transparent-background-gui
148+
```
149+
![image](https://github.com/plemeri/transparent-background/assets/40786892/eac55d75-eea7-438b-bb5c-dd05552a736a)
150+
127151
### :computer: Command Line
128152

129153
```bash

0 commit comments

Comments
 (0)