Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 4.72 KB

README.md

File metadata and controls

105 lines (72 loc) · 4.72 KB

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 GitHub License Current version

📥 Downloading the Installer

Download Installer

  1. Ensure Prerequisites are Met:

    • Follow the instructions in the 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.

  • rembg library: Install with:

    pip install "rembg[cli]"

    Check that it’s installed correctly:

    rembg

    This should show the rembg help information.

Option 2: Using the rembg installer

  • Download and run the rembg installer from here.

✨ 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 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 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.

🙏 Acknowledgments

  • Wails for enabling cross-platform desktop applications using Go and web technologies.
  • rembg for the Python-based background removal library.