Deepwoken Helper

deepwoken helper to help you choose your cards.

🚀 Quick Start

for end users:

1. download installer/DeepwokenHelper_Setup_1.3.1.exe
2. run as administrator
3. follow the installation wizard
4. launch from start menu or desktop

for developers:

# setup development environment
scripts\run_dev.bat

# build application
scripts\build.bat

✨ Features

• 🎯 Card Detection: Advanced OCR-based card recognition
• 📊 Build Analysis: Intelligent build recommendations
• 🖥️ Overlay Display: In-game card information overlay
• 🔧 Debug Mode: Development and testing features
• ⌨️ Hotkey Support: Customizable keyboard shortcuts (default: J)
• 🎮 Game Integration: Works seamlessly with Deepwoken

📋 How It Works

1. Load Build: Import your build from deepwoken.co
2. Scan Cards: Press the hotkey (J) while viewing cards in-game
3. Get Recommendations: See which cards you need for your build
4. Make Decisions: Choose the best cards based on the analysis

🛠️ Installation

System Requirements

• Windows 10/11
• 4GB RAM minimum
• 500MB free disk space
• Administrator privileges

Download & Install

1. Download the latest release from Releases
2. Run DeepwokenHelper_Setup_1.3.1.exe as administrator
3. Follow the installation wizard
4. Launch from Start Menu or Desktop

🔧 Development

Prerequisites

• Python 3.12
• uv package manager
• Tesseract OCR
• PyInstaller

Setup

# Install uv
pip install uv

# Setup Python environment
uv python install 3.12
uv venv --python 3.12
uv sync

# Install Tesseract OCR
# Download from: https://github.com/UB-Mannheim/tesseract/wiki
# Place in project root as 'tesseract/' folder

Development Commands

# Run in development mode
scripts\run_dev.bat

# Quick start (debug mode)
scripts\start_dev.bat

# Build application
scripts\build.bat

📁 Project Structure

DeepwokenHelper/
├── assets/                 # Static assets (images, models, data)
├── deepwokenhelper/       # Main application code
├── installer/             # Installer files
├── scripts/               # Build and development scripts
├── docs/                  # Documentation
├── logs/                  # Log files
└── README.md              # This file

🎮 Usage

Basic Usage

1. Start the Application: Launch from Start Menu or Desktop
2. Load Your Build: Click "Add" to import from deepwoken.co
3. Scan Cards: Press J key while viewing cards in-game
4. View Results: See card recommendations in the overlay

Advanced Features

• Debug Mode: Enable for development and testing
• Custom Hotkeys: Configure keyboard shortcuts
• Build Analysis: Detailed build recommendations
• Card Filtering: Show only needed cards

🐛 Troubleshooting

Common Issues

Application won't start:

• Ensure all dependencies are installed
• Check Windows Defender/Antivirus settings
• Run as administrator

OCR not working:

• Verify Tesseract installation
• Check language packs
• Ensure proper file permissions

Overlay not showing:

• Check if running in debug mode
• Verify hotkey settings
• Ensure proper window focus

🤝 Contributing

We welcome contributions! Please see our Development Guide for details.

How to Contribute

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request

📄 Documentation

• Installation Guide - Detailed installation instructions
• Development Guide - Development setup and guidelines
• API Documentation - Technical documentation

🎯 Roadmap

• macOS support
• Manual card editing
• Advanced build optimization
• Better UI/UX
• More settings and customization
• Performance improvements

🙏 Special Thanks

• cyfiee - Creator of the deepwoken builder! Go support her website!
• crea - For emotional support and feedback
• Community - For bug reports, feature requests, and support

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

💖 Support

If you really like this project, please consider making a small donation, it really helps and means a lot!

🔗 Links

• GitHub Repository
• Releases
• Issues
• Deepwoken Builder

---

Made with ❤️ for the Deepwoken community