Data Stripper (Linux) Pre Release

Data Stripper v0.0.1-alpha Pre-Release

🚀 What's This?

Data Stripper is a powerful tool that automatically extracts market data from in-game screenshots using advanced OCR technology. It processes tooltip images to identify item names, buy prices, sell prices, and 7-day average prices, then updates your market data files automatically.

📦 What's Included

• Data Stripper (Linux executable)
• All necessary dependencies bundled
• Sample configuration files

🛠️ System Requirements

• OS: Linux (Ubuntu 20.04+, Debian 11+, or similar)
• Architecture: x86_64 (64-bit)
• Dependencies: None required (all bundled)

📥 Installation Instructions

Method 1: Direct Download & Run

# Download and extract
tar -xzf Data-Stripper-v0.0.1-alpha.tar.gz
cd Data-Stripper-v0.0.1-alpha/

# Make executable and run
chmod +x "Data Stripper"
./"Data Stripper"

Method 2: Desktop Integration

# Extract and create desktop launcher
tar -xzf Data-Stripper-v0.0.1-alpha.tar.gz
cd Data-Stripper-v0.0.1-alpha/

# Create desktop entry (optional)
cp data-stripper.desktop ~/.local/share/applications/
update-desktop-database ~/.local/share/applications/

🎯 Quick Start Guide

1. Launch the Application

   • Run ./"Data Stripper" from terminal
   • Or find "Data Stripper" in your applications menu

2. Take Screenshots

   • Use the in-app screenshot button
   • Or use the floating overlay (enable in File menu)
   • Hotkey: Ctrl+Shift+S (configurable) (requires root access)

3. Process Images

   • Click "Process Images" to extract data
   • View results in the expandable results panel

4. Update Market Data

   • Use "Add to mprices.txt" to update your market files
   • Sync with GitHub to publish changes

⚙️ Configuration

First-Time Setup:

1. Go to File → Settings

2. Configure your GitHub repository details:

   • Repository: your-username/your-repo
   • Branch: main (or your preferred branch)
   • File path: market/mprices.txt
   • GitHub Token (for publishing)

3. Adjust detection settings as needed

Key Settings:

• Detection Method: Choose between border color or contour detection
• OCR API Key: Uses free tier by default (upgrade for higher limits)
• In-place Extraction: Process screenshots immediately
• Parallel Workers: Adjust for performance

🔧 Features

✅ Working Features

• Smart Tooltip Detection: Automatically finds and crops tooltips
• Advanced OCR: Uses OCR.space API for text extraction
• Item Name Matching: Intelligent fuzzy matching with item database
• Price Extraction: Handles various price formats and currencies
• Batch Processing: Process multiple images in parallel
• GitHub Integration: Sync and publish market data
• Screenshot Overlay: Floating window for quick captures
• Hotkey Support: Configurable global hotkeys (requires root access)

🎯 Use Cases

• Mass updating market prices from screenshots
• Automated data entry for market tracking
• Bulk processing of in-game tooltips
• Market data synchronization across teams

⚠️ Known Issues & Limitations

Current Limitations:

• Pre-release Software: May contain bugs - please report issues!
• OCR Accuracy: Depends on image quality and font clarity
• Free OCR Limits: 500 requests/month on free tier
• Linux Only: This release is built for Linux systems
• GTK Dependency: Requires GTK3 libraries (included in bundle)

Common Issues:

• Tooltip not detected: Try different detection methods in settings
• OCR failures: Ensure clear, high-contrast screenshots
• Item name mismatches: Check the item list for close matches

🐛 Reporting Issues

Found a bug? Please report it with:

1. Description of what went wrong
2. Steps to reproduce the issue
3. Screenshots of the problem
4. Log file (found in the application directory as market_data_stripper.log)

🔮 Planned Features

• Windows and macOS support
• Local OCR engine (no API limits)
• Enhanced image preprocessing

📄 License & Attribution

• Built for the CraftersMC community
• Uses OCR.space API for text recognition
• Includes open-source libraries: OpenCV, Pillow, NumPy, etc.

❓ Support

• Documentation: Check the README in the repository
• Issues: Use GitHub Issues for bug reports
• Discussions: GitHub Discussions for questions and help

---

Note: This is a pre-release version. Please backup your data before use and report any issues you encounter!

📁 File Structure

Data-Stripper-v1.0.0-linux/
├── Data Stripper          # Main executable
├── _internal/             # Bundled dependencies
│   ├── app.py
│   ├── itemlist.py
│   ├── croplayout.py
│   └── libraries/
├── uploads/               # Created automatically
├── cropped/               # Debug images (if enabled)
├── settings.json          # Configuration file
└── market_data_stripper.log

🔄 Update Process

When new versions are released:

1. Backup your settings.json file
2. Download and extract the new version
3. Replace your old installation
4. Restore your settings.json if needed

---

Thank you for testing this pre-release! Your feedback is invaluable. 🚀

Key Sections Explained:

1. Clear Title: Indicates it's a pre-release
2. What's This?: Quick elevator pitch
3. Installation: Step-by-step instructions
4. Quick Start: Get users running quickly
5. Features: Show what works (and what doesn't)
6. Known Issues: Manage expectations
7. Support Info: How to get help

You might also want to add:

For the GitHub release page, you can also include:

Assets included in this release:

• Data-Stripper-v0.0.1-alpha.tar.gz - Linux executable bundle

If you want to be more technical, add:

Build Information:

• Built with Python 3.10
• PyInstaller bundle
• Includes: OpenCV 4.x, Pillow 10.x, NumPy 1.24+

This release notes template sets clear expectations (it's a pre-release), provides all necessary information, and guides users through installation and troubleshooting. It also encourages feedback which is crucial for pre-release software!