An open API service indexing awesome lists of open source software.

https://github.com/vdanielvpl/rmbg

RMBG is a simple tool designed to remove backgrounds from images effortlessly on Windows 10/11. It utilizes Wails and the Python-based rembg CLI library for background removal.
https://github.com/vdanielvpl/rmbg

ai background-remover image-cropper image-processing rembg rembg-frontend windows windows-10 windows-11

Last synced: 2 months ago
JSON representation

RMBG is a simple tool designed to remove backgrounds from images effortlessly on Windows 10/11. It utilizes Wails and the Python-based rembg CLI library for background removal.

Awesome Lists containing this project

README

          


RMBG

**RMBG** is a simple tool designed to remove backgrounds from images effortlessly on Windows 10/11. It utilizes **Wails** (Go backend) and the Python-based rembg CLI library for background removal. You will need **Python**, along with the rembg library. The frontend is built with **React**, using **Bun** for building, ensuring a smooth and responsive user interface.


Main background removal view
Image cropping view



Main background removal view 2
Image cropping view 2

[![Downloads](https://img.shields.io/github/downloads/VdanielVPL/RMBG/total.svg?style=for-the-badge)](https://github.com/VdanielVPL/RMBG/releases) [![GitHub License](https://img.shields.io/github/license/VdanielVPL/RMBG?style=for-the-badge)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![Current version](https://img.shields.io/github/v/release/VdanielVPL/RMBG?label=version&style=for-the-badge)](https://github.com/VdanielVPL/RMBG/releases)

## πŸ“₯ Downloading the Installer


Download Installer

1. **Ensure Prerequisites are Met**:
- Follow the instructions in the [Prerequisites](#-prerequisites) section to set up your environment with either **Python and rembg** or use the **rembg installer** directly.

2. **Run the Installer**:
- Double-click the downloaded `.exe` file to install the application.
- After installation and ensuring that the prerequisites are met, the application is ready to use.

## πŸ“ Prerequisites

Before using RMBG, ensure you have the following installed:

### Option 1: Using Python and Pip

- **Python 3.10 to 3.13**: Download from [here](https://www.python.org/downloads/).
- **[`rembg`](https://github.com/danielgatis/rembg) library**: Install with:

```bash
pip install "rembg[cli]"
```
Check that it’s installed correctly:
```bash
rembg
```
This should show the rembg help information.

### Option 2: Using the rembg installer

- Download and run the **rembg installer** from [here](https://github.com/danielgatis/rembg/releases/latest/download/rembg-cli-installer.exe).

## ✨ Features

- **Remove backgrounds** from images quickly and easily.
- **Crop images** before removing the background.
- Switch between **cropping view** and **background removal view**.
- Supports various image formats (PNG, JPEG, WebP).
- User-friendly interface with drag-and-drop functionality.
- Windows 10/11 theme colors in app (Accent color, Mica backdrop).
- Lightweight and fast.

## πŸš€ Usage

Once the application is installed and started:

1. **Add an Image**:
- Click on the designated area or drag and drop an image into the window.

2. **Crop the Image**:
- Use the cropping feature to select the desired portion of the image before removal.

3. **Switch Views**:
- Easily toggle between cropping view and background removal view.

4. **Remove the Background**:
- Let the application process the image with `rembg` to remove the background.

5. **Save the Processed Image**:
- Save the result with a transparent background to your chosen location.

## πŸ› οΈ How It Works

- **rembg Integration**: The Go backend invokes the Python-based [`rembg`](https://github.com/danielgatis/rembg) CLI for background removal.
- **Go Backend with Wails**: Ensures efficient performance and a native desktop experience.
- **React Frontend**: Provides a responsive and modern interface.
- **Supported Formats**: Handles PNG, JPEG, and WebP.

## πŸ“œ License

This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.

## 🀝 Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your improvements. For information on building the application, see [CONTRIBUTING](CONTRIBUTING.md).

## πŸ™ Acknowledgments

- [Wails](https://wails.io/) for enabling cross-platform desktop applications using Go and web technologies.
- [rembg](https://github.com/danielgatis/rembg) for the Python-based background removal library.