{"id":31939314,"url":"https://github.com/zquestz/dream-background-remover","last_synced_at":"2025-10-14T08:25:44.908Z","repository":{"id":315568952,"uuid":"1059962487","full_name":"zquestz/dream-background-remover","owner":"zquestz","description":"A GIMP plugin to remove image backgrounds","archived":false,"fork":false,"pushed_at":"2025-09-24T02:32:40.000Z","size":695,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-06T15:59:22.318Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zquestz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-19T07:34:50.000Z","updated_at":"2025-09-24T02:32:39.000Z","dependencies_parsed_at":"2025-09-19T11:41:57.081Z","dependency_job_id":"6e7eb076-cfa0-4fa0-a4f8-2deaf8918567","html_url":"https://github.com/zquestz/dream-background-remover","commit_stats":null,"previous_names":["zquestz/dream-background-remover"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/zquestz/dream-background-remover","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zquestz%2Fdream-background-remover","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zquestz%2Fdream-background-remover/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zquestz%2Fdream-background-remover/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zquestz%2Fdream-background-remover/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zquestz","download_url":"https://codeload.github.com/zquestz/dream-background-remover/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zquestz%2Fdream-background-remover/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279018312,"owners_count":26086342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-14T08:25:42.755Z","updated_at":"2025-10-14T08:25:44.900Z","avatar_url":"https://github.com/zquestz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dream Background Remover - GIMP Plugin\n\nDream Background Remover brings Replicate's AI capabilities directly into GIMP for intelligent background removal.\n\n![Dream Background Remover](screenshots/dream-background-remover.png)\n\n## Features\n\n- 🎨 **AI Background Removal**: Remove backgrounds from your images\n- 🤖 **AI Model Selection**: Choose between multiple models\n- 🔄 **Smart Layer Management**: Automatically creates properly named layers\n- 🌍 **Multi-Language Support**: Setup to support multiple languages via i18n\n- 🏗️ **Native GIMP Integration**: Works seamlessly within your GIMP workflow\n\n## Installation\n\n### Prerequisites\n\n- **GIMP 3.0.x**\n- **Python 3.8+**\n- **Replicate API key** (paid account required)\n\nInstall the required Python library:\n\n```bash\npip install replicate\n```\n\n### Quick Install\n\n1. **Download the latest release** from [GitHub Releases](https://github.com/zquestz/dream-background-remover/releases)\n\n2. **Extract the release**\n\n   This will create a folder named `dream-background-remover-{version}` (e.g., `dream-background-remover-1.0.4`)\n\n3. **Move to your GIMP plugins folder with the correct name:**\n\n   Rename and move the extracted folder to exactly `dream-background-remover` in your GIMP plugins directory:\n   - **Linux**: `~/.config/GIMP/3.0/plug-ins/dream-background-remover/`\n   - **Windows**: `%APPDATA%\\GIMP\\3.0\\plug-ins\\dream-background-remover\\`\n   - **macOS**: `~/Library/Application Support/GIMP/3.0/plug-ins/dream-background-remover/`\n\n   Example for Linux:\n\n   ```bash\n   # Extract creates dream-background-remover-1.0.4/\n   unzip dream-background-remover-1.0.4.zip\n   # Move to correct location with correct name\n   mv dream-background-remover-1.0.4 ~/.config/GIMP/3.0/plug-ins/dream-background-remover\n   ```\n\n4. **Make executable** (Linux/macOS only):\n\n   ```bash\n   chmod +x ~/.config/GIMP/3.0/plug-ins/dream-background-remover/dream-background-remover.py\n   ```\n\n5. **Restart GIMP**\n\n**Building translations (optional):** If you need languages other than English, run `python3 scripts/build-translations.py` in the plugin directory after installation.\n\n### Arch Linux Installation\n\nTo install Dream Background Remover on Arch Linux, you can install it from the AUR.\n\n```bash\nyay -S dream-background-remover\n```\n\n### Advanced Installation\n\n#### Manual Installation from Source\n\n1. **Find your GIMP plugins directory** (paths listed above)\n\n2. **Create plugin directory:**\n\n   ```bash\n   mkdir -p ~/.config/GIMP/3.0/plug-ins/dream-background-remover/\n   ```\n\n3. **Copy all Python files:**\n\n   ```bash\n   cp *.py ~/.config/GIMP/3.0/plug-ins/dream-background-remover/\n   ```\n\n4. **Build and install translations (Optional):**\n\n   ```bash\n   python3 scripts/build-translations.py\n   cp -r locale ~/.config/GIMP/3.0/plug-ins/dream-background-remover/\n   ```\n\n5. **Make executable:**\n   ```bash\n   chmod +x ~/.config/GIMP/3.0/plug-ins/dream-background-remover/dream-background-remover.py\n   ```\n\n#### Development Setup\n\n```bash\ngit clone https://github.com/zquestz/dream-background-remover.git\ncd dream-v\npip install replicate\npython3 scripts/build-translations.py # optional, defaults to English\nln -s $(pwd) ~/.config/GIMP/3.0/plug-ins/dream-background-remover\n```\n\n### Python Dependencies Note\n\n**Important**: Use the same Python that GIMP uses. If `pip install replicate` doesn't work:\n\n```bash\n# System-wide installation\nsudo pip install replicate\n\n# User installation (recommended)\npip install --user replicate\n\n# Ensure Python 3\npip3 install replicate\n```\n\n#### macOS Instructions\n\nIf you get the **\"replicate not installed\"** error on macOS:\n\n1. **Locate GIMP's Python** by opening the Python Console: `Filters → Development → Python-Fu`\n2. **Run this command** in the console:\n\n   ```python\n   import sys; print(sys.executable)\n   ```\n\n   You should see something like:\n\n   ```\n   /Applications/GIMP.app/Contents/MacOS/python3\n   ```\n\n3. **Install replicate using GIMP's Python** from Terminal:\n\n   ```bash\n   # Change to GIMP's Python directory\n   cd /Applications/GIMP.app/Contents/MacOS\n\n   # Ensure pip is installed\n   ./python3 -m ensurepip\n\n   # Install replicate\n   ./python3 -m pip install replicate\n   ```\n\n## Getting Your API Key\n\n1. **Visit [Replicate](https://replicate.com/)**\n2. **Generate an API key**\n3. **Keep your key secure and monitor usage/costs**\n\n### API Specifications\n\n- **851 Labs Background Remover**: `851-labs/background-remover` (Default - Fast and cost-effective)\n- **Bria Remove Background**: `bria/remove-background` (High quality, more expensive)\n- **Recraft Remove Background**: `recraft-ai/recraft-remove-background` (Tuned for AI, balanced performance)\n\nUsers can select their preferred model in the plugin interface.\n\n### Cost Considerations\n\n- Each image generation/edit counts toward your API usage\n- Monitor your usage at [Replicate](https://replicate.com/) to avoid unexpected charges\n\n## Usage\n\n### Basic Workflow\n\n1. **Open an image in GIMP**\n2. **Launch Dream Background Remover**: `Filters → AI → Dream Background Remover...`\n3. **Enter your API key** (saved automatically for future use)\n4. **Select AI model**:\n   - **851 Labs Background Remover**: Fast and cost-effective (recommended for most users)\n   - **Bria Remove Background**: Higher quality results, higher cost\n   - **Recraft Remove Background**: Tuned for AI, balanced performance and cost\n5. **Select mode**:\n   - **Create Layer**: Creates a layer in your current image with the background removed\n   - **Create File**: Create a new image with your background removed\n6. **Generate**: Click \"Remove Background\" and watch the progress\n7. **Result**: New layer or file appears with the background removed\n\n## Language Support\n\n### Available Languages\n\nDream Background Remover is fully translated and available in:\n\n- **🇺🇸 English** (default)\n- **🇪🇸 Spanish** (complete)\n- **🇫🇷 French** (complete)\n- **🇵🇹 Portuguese** (complete)\n- **🇷🇺 Russian** (complete)\n- **🇯🇵 Japanese** (complete)\n- **🇮🇳 Hindi** (complete)\n- **🇧🇩 Bengali** (complete)\n- **🇨🇳 Chinese (Simplified)** (complete)\n- **🇹🇼 Chinese (Traditional)** (complete)\n- **🇰🇷 Korean** (complete)\n\nThe plugin automatically detects your system language and uses the appropriate translation. If your language isn't available, it defaults to English.\n\n### For Developers\n\n```bash\n# Extract new translatable strings\npython3 scripts/update-pot.py\n\n# Update existing translations\npython3 scripts/update-translations.py\n\n# Build compiled translations\npython3 scripts/build-translations.py\n```\n\n## Architecture\n\nThe plugin is organized into focused modules:\n\n- **`dream-background-remover.py`** - Main GIMP plugin entry point\n- **`dialog_gtk.py`** - GTK user interface components\n- **`dialog_events.py`** - Event handling and user interactions\n- **`dialog_threads.py`** - Background processing and threading\n- **`api.py`** - Replicate API integration\n- **`integrator.py`** - GIMP-specific operations\n- **`settings.py`** - Configuration persistence\n- **`i18n.py`** - Internationalization support\n\n## Troubleshooting\n\n### Common Issues\n\n**\"replicate not installed\" warning**\n\n- Install with: `pip install replicate`\n- Ensure you're using GIMP's Python environment\n\n**Plugin doesn't appear in menu**\n\n- Check file permissions: `chmod +x dream-background-remover.py`\n- Restart GIMP after installation\n- Verify files are in correct plugins directory\n\n**API errors**\n\n- Verify your API key is correct\n- Check your quota at [Replicate](https://replicate.com/)\n- Monitor costs to avoid unexpected charges\n\n**Interface problems**\n\n- Check GIMP's Error Console: `Windows → Dockable Dialogs → Error Console`\n- Ensure translations are built: `python3 scripts/build-translations.py`\n- Report UI issues with screenshots\n\n### Getting Help\n\n1. **Check the Error Console** in GIMP for specific error messages\n2. **Verify all requirements** are installed correctly\n3. **Check file permissions** on the plugin directory\n4. **Review API quotas** if getting timeout errors\n\n## Contributing\n\n### For Translators\n\nWe welcome translations! Here's how to contribute:\n\n1. **Copy the template**: `cp locale/dream-background-remover.pot locale/[YOUR_LANG].po`\n2. **Translate the strings** using Poedit, Lokalize, or any text editor\n3. **Test your translation**: Build with `python3 scripts/build-translations.py`\n4. **Submit a pull request** with your `.po` file\n\n**Translation Guidelines:**\n\n- Keep UI text concise but clear\n- Use GIMP's existing terminology for your language\n- Preserve HTML tags and placeholders like `{count}`, `{url}`\n- Test that text fits in the interface\n\n### For Developers\n\n1. **Fork the repository**\n2. **Create a feature branch**\n3. **Follow the existing code style**\n4. **Update translations** if adding new strings\n5. **Submit a pull request**\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Credits\n\nBuilt with the Replicate API.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzquestz%2Fdream-background-remover","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzquestz%2Fdream-background-remover","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzquestz%2Fdream-background-remover/lists"}