🔐 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)**