π DotScramble
Advanced Image Privacy Studio Pro
A powerful, modular image privacy protection tool with advanced features including face detection, multiple effect types, batch processing, and real-time preview.
Quick Start β’ Features β’ Usage β’ Installation β’ Contributing
π Quick Start
No Python installation required! Download and run the standalone executable.
### πͺ Windows1. Download DotScramble-windows.exe1. Double-click to launch 1. If SmartScreen appears, click "More info" β "Run anyway" | ### π§ Linux1. Install System Dependencies (for text detection features): |
sudo apt install tesseract-ocr tesseract-ocr-eng
`...
π DotScramble
Advanced Image Privacy Studio Pro
A powerful, modular image privacy protection tool with advanced features including face detection, multiple effect types, batch processing, and real-time preview.
Quick Start β’ Features β’ Usage β’ Installation β’ Contributing
π Quick Start
No Python installation required! Download and run the standalone executable.
### πͺ Windows1. Download DotScramble-windows.exe1. Double-click to launch 1. If SmartScreen appears, click "More info" β "Run anyway" | ### π§ Linux1. Install System Dependencies (for text detection features): |
sudo apt install tesseract-ocr tesseract-ocr-eng
```<br>1. Download `DotScramble-linux`<br>1. Make executable:
chmod +x DotScramble-linux
```
1. Run: ./DotScramble-linux
Note: Text detection features require Tesseract OCR. Without it, youβll see a warning but all other features work normally. | ### π macOS1. Download DotScramble-macos
1. Make executable:
chmod +x DotScramble-macos
```<br>1. Right-click β **Open** to bypass Gatekeeper<br> |
---
## β¨ Features
| | |
| - | - |
| ### π― Detection Modes+ π **Face Detection** - Automatically detect and blur faces<br>+ ποΈ **Eye Detection** - Target specific eye regions<br>+ π§ **Full Body Detection** - Detect entire person silhouettes<br>+ π **License Plate Detection** - Auto-identify vehicle plates<br>+ π **Text Detection \(OCR\)** - Find and censor text<br>+ βοΈ **Manual Selection** - Draw custom regions<br>+ π **Full Image** - Apply effects to entire image<br> | ### π¨ Privacy Effects+ π«οΈ **Gaussian Blur** - Smooth, professional blur<br>+ π² **Pixelation** - Classic pixel censoring<br>+ β¬ **Black Bar** - Solid rectangular censor<br>+ π **Gradient Fade** - Artistic gradient transition<br>+ π³ **Mosaic** - Decorative tile pattern<br>+ βοΈ **Frosted Glass** - Translucent glass effect<br>+ π¨ **Oil Paint** - Artistic painting style<br> |
### π Advanced Capabilities
| Feature | Description |
| ------- | ----------- |
| β‘ **Real-time Preview** | See effects instantly as you adjust parameters |
| π¦ **Batch Processing** | Process hundreds of images automatically |
| βΆβ· **Undo/Redo** | Full history management with keyboard shortcuts |
| πΎ **Presets System** | Save and load your favorite effect configurations |
| π **Comparison View** | Side-by-side before/after comparison |
| β¨οΈ **Keyboard Shortcuts** | Lightning-fast workflow with hotkeys |
| ποΈ **Opacity Control** | Blend effects with original image |
| π **Image Information** | Display detailed image metadata |
| π **Smart Auto-Update** | Updates silently in the background without interrupting your work |
---
## π Usage
### Basic Workflow
graph LR A[π Load Image] β> B[π― Select Mode] B β> C[π¨ Choose Effect] C β> D[βοΈ Adjust Settings] D β> E[β¨ Apply Effect] E β> F[πΎ Save Result]
Loading
**π· Manual Selection Mode**
1. Select **\"βοΈ Manual Selection\"** from detection modes
1. Click and drag on the image to draw rectangles
1. Create multiple regions as needed
1. Click **\"β¨ Apply Effect\"** to process all selected areas
1. Use **\"ποΈ Clear Selections\"** to reset and start over
**β‘ Real-time Preview**
1. Enable the **\"π΄ Real-time Preview\"** checkbox
1. Adjust any parameter \(blur strength, opacity, etc\.\)
1. See results instantly without applying
1. Perfect for finding the ideal settings before committing
**π¦ Batch Processing**
1. Click **\"π¦ Batch Process\"** or press `Ctrl+B`
1. Select multiple images from your folders
1. Choose output directory for processed images
1. Configure detection mode and effect settings
1. Click **Start** and let it run automatically
**πΎ Presets Management**
1. Configure your perfect settings \(effect, strength, opacity, etc\.\)
1. Go to **Menu β Presets β Save Current Settings**
1. Name your preset \(e\.g\., \"Face Blur Strong\", \"Plate Pixelate\"\)
1. Load anytime for consistent, repeatable results
---
## β¨οΈ Keyboard Shortcuts
| Shortcut | Action | Shortcut | Action |
| -------- | ------ | -------- | ------ |
| `Ctrl+O` | Open Image | `Ctrl+S` | Save Result |
| `Ctrl+Z` | Undo | `Ctrl+Y` | Redo |
| `Ctrl+P` | Apply Effect | `Ctrl+D` | Clear Selections |
| `Ctrl+B` | Batch Process | `Ctrl+Q` | Quit Application |
---
## ποΈ Effect Parameters
| | | |
| - | - | - |
| ### π«οΈ Blur Strength+ **Range:** 15-199<br>+ **Odd numbers only** for optimal results<br>+ Higher values = stronger blur<br>+ Recommended: 31-51 for faces<br> | ### π² Pixel Block Size+ **Range:** 5-50 pixels<br>+ Higher values = heavier censoring<br>+ Lower values = subtle effect<br>+ Recommended: 15-25 for balance<br> | ### π¨ Opacity+ **Range:** 0-100%<br>+ 100% = full effect applied<br>+ Lower = blends with original<br>+ Recommended: 80-100% for privacy<br> |
---
## π Detection Tips
**π Face Detection**
- β
Works best with front-facing faces
- β
Requires good lighting conditions
- β
Detects multiple faces in one image
- β οΈ May miss faces at extreme angles or with heavy shadows
- π‘ **Tip:** Use Manual Selection as fallback for missed faces
**π License Plate Detection**
- β
Optimized for standard license plate dimensions
- β
Works best with high-resolution images \(1080p\+\)
- β
Filters by aspect ratio \(2:1 to 5:1\)
- β οΈ May struggle with damaged or dirty plates
- π‘ **Tip:** Ensure plates are clearly visible and not at sharp angles
**π Text Detection \(OCR\)**
- β
Detects printed text in images
- β
Works best with high-contrast, clear text
- β
Adjustable confidence threshold
- β οΈ Requires pytesseract installation
- π‘ **Tip:** Use on documents, signs, and screenshots
---
## π» Installation
### Option 1: Standalone Executable \(Recommended\)
**No dependencies required\!** Simply download from the [Releases Page](https://github.com/kareem2099/DotScramble/releases/latest)\.
### Option 2: From Source
**Click to expand installation steps**
#### Prerequisites
- Python 3\.6 or higher
- pip package manager
#### Steps
Clone the repository
git clone https://github.com/kareem2099/DotScramble.git cd DotScramble
Install dependencies
pip install -r requirements.txt
Run the application
python main.py
#### Dependencies
pip install opencv-python numpy Pillow pytesseract
---
## π Project Structure
DotScramble/ β βββ π main.py # Application entry point βββ βοΈ config.py # Configuration & settings βββ π requirements.txt # Python dependencies β βββ π§ core/ β βββ image_processor.py # Image processing & effects engine β βββ batch_processor.py # Batch processing functionality β βββ utils.py # Utility functions & helpers β βββ πΌοΈ gui/ β βββ main_window.py # Main application window β βββ batch_window.py # Batch processing interface β βββ πΎ presets.json # Saved effect presets (auto-generated) βββ ποΈ backups/ # Automatic image backups (auto-created)
---
## π οΈ Customization
### Adding Custom Effects
**Click to see example code**
1. Open `core/image_processor.py`
1. Add your effect method:
@staticmethod def my_custom_effect(image, x, y, w, h): βββ Apply custom effect to image region
Args: image: Source image (numpy array) x, y: Top-left corner coordinates w, h: Width and height of region
Returns: Processed region (numpy array) βββ region = image[y:y+h, x:x+w]
Your effect logic here
Example: Invert colors
processed = 255 - region
return processed
1. Update `config.py` EFFECTS dictionary:
EFFECTS = {
β¦ existing effects β¦
βmy_custom_effectβ: βπ My Custom Effectβ }
1. Add to GUI effect selection dropdown
---
## π€ Contributing
We welcome contributions\! Here are some ideas to get started:
| | |
| - | - |
| ### π― Ideas for Contributors+ π§ Additional AI detection models<br>+ π¨ More creative effect types<br>+ π₯ Video processing support<br>+ β‘ GPU acceleration with CUDA<br>+ π Web-based interface<br>+ π± Mobile app version<br>+ π Batch undo/redo<br>+ π Processing statistics<br> | ### π How to Contribute1. Fork the repository<br>1. Create your feature branch
git checkout -b feature/AmazingFeature
git commit -m βAdd AmazingFeatureβ
git push origin feature/AmazingFeature
---
## π License
This project is licensed under the **MIT License** - see the [LICENSE](https://github.com/kareem2099/DotScramble/blob/master/LICENSE) file for details\.
MIT License - Free for personal and commercial use
---
## π Acknowledgments
- **OpenCV** - Computer vision library
- **Python Community** - Amazing ecosystem
- **Contributors** - Everyone who has helped improve this project
---
## π Support & Contact
**Need Help?**
### Troubleshooting
**Common Issues**
**Q: I see a Tesseract warning on Linux?**
A: Text detection features require Tesseract OCR\. Install it with:
sudo apt install tesseract-ocr tesseract-ocr-eng
After installation, restart the application to enable text detection features\.
**Q: detection not working?**
A: Ensure good lighting and front-facing angles\. Try adjusting detection sensitivity in settings\.
**Q: Application won't start?**
A: Check that all dependencies are installed\. Try running from source with `python main.py`\.
**Q: Batch processing is slow?**
A: PA: Processing time depends on image size and effect complexity\. Consider using pixelation for faster processing\.
**Q: Can't save preset?**
A: Ensure you have write permissions in the application directory\.
### β Star this repository if you find it helpful\!
Made with β€οΈ for privacy protection
**[β¬ Back to Top](#-dotscramble)**