Release: v2.0.0

Author: InzGIBA

CHANGELOG.md

@@ -0,0 +1,183 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2024-08-28
+
+### 🚀 Major Release - Complete Rewrite for Python 3.12+
+
+This is a complete rewrite of WOG Dump with modern Python features, improved architecture, and enhanced functionality.
+
+### Added
+
+#### 🏗️ Project Structure
+- **Modern Package Layout**: Implemented `src/` layout following Python packaging best practices
+- **Modular Architecture**: Split monolithic script into focused modules:
+  - `wog_dump.core.config` - Configuration management with Pydantic
+  - `wog_dump.core.download` - Asset downloading with parallel processing
+  - `wog_dump.core.decrypt` - Decryption operations with error handling
+  - `wog_dump.core.unpack` - Unity asset unpacking and processing
+  - `wog_dump.utils.logging` - Structured logging with Rich formatting
+  - `wog_dump.utils.normal_map` - Enhanced normal map conversion
+  - `wog_dump.cli.main` - Modern CLI interface with Click
+
+#### 🎨 Modern CLI Interface
+- **Beautiful Console Output**: Rich-formatted output with colors and progress bars
+- **Subcommands**: Organized CLI with specific commands for each operation:
+  - `wog-dump download-weapons` - Download weapon list
+  - `wog-dump download-assets` - Download asset files
+  - `wog-dump decrypt-assets` - Decrypt downloaded assets
+  - `wog-dump unpack-assets` - Unpack Unity assets
+  - `wog-dump convert-normals` - Convert normal maps
+  - `wog-dump full-pipeline` - Complete extraction pipeline
+  - `wog-dump info` - Show configuration and status
+- **Progress Tracking**: Real-time progress bars for all operations
+- **Verbose/Debug Modes**: Detailed logging options for troubleshooting
+
+#### 🔧 Configuration Management
+- **Pydantic Configuration**: Type-safe configuration with validation
+- **Automatic Directory Creation**: Smart directory management
+- **Customizable Settings**: CLI options for all major settings
+- **Configuration Validation**: Comprehensive validation and error messages
+
+#### ⚡ Enhanced Performance
+- **Parallel Processing**: Multi-threaded downloads and processing
+- **Memory Efficiency**: Streaming downloads and processing
+- **Progress Tracking**: Real-time status updates
+- **Error Recovery**: Graceful handling of network and file errors
+
+#### 🧪 Comprehensive Testing
+- **Unit Tests**: Complete test coverage for all modules
+- **Integration Tests**: End-to-end testing of CLI commands
+- **Test Fixtures**: Reusable test components and mock data
+- **Pytest Configuration**: Modern testing setup with coverage reporting
+
+#### 📦 Modern Packaging
+- **pyproject.toml**: Modern Python packaging with PEP 621 compliance
+- **Development Dependencies**: Separate dev/test dependency groups
+- **Type Checking**: Full mypy support with strict typing
+- **Code Formatting**: Black, isort, and flake8 integration
+- **Pre-commit Hooks**: Automated code quality checks
+
+#### 📝 Enhanced Documentation
+- **Comprehensive README**: Updated with modern usage examples
+- **Contributing Guidelines**: Detailed development and contribution guide
+- **API Documentation**: Complete docstrings for all functions
+- **Migration Guide**: Help for users upgrading from v1.x
+
+### Changed
+
+#### 🐍 Python Requirements
+- **Minimum Python Version**: Now requires Python 3.12+ (was 3.10+)
+- **Modern Features**: Utilizes latest Python features:
+  - Type hints with `|` union syntax
+  - `match`/`case` statements where applicable
+  - Enhanced error handling
+  - Improved async/await patterns
+
+#### 🏃‍♂️ Installation and Usage
+- **Installation**: Now pip-installable with `pip install -e .`
+- **CLI Commands**: Replaced single script with subcommand structure
+- **Configuration**: Centralized configuration management
+- **Error Handling**: Improved error messages and recovery
+
+#### 🔄 Normal Map Conversion
+- **Enhanced Functionality**: More conversion options and validation
+- **Batch Processing**: Recursive directory processing with progress tracking
+- **Backup Options**: Optional backup creation during conversion
+- **Format Validation**: Analysis and validation of normal map formats
+
+### Fixed
+
+#### 🐛 Bug Fixes
+- **Network Error Handling**: Robust retry logic and error recovery
+- **File Permission Issues**: Better handling of permission errors
+- **Memory Usage**: Optimized memory usage for large file processing
+- **Type Safety**: Complete type annotation coverage
+
+#### 🔒 Security
+- **Input Validation**: Comprehensive validation of all inputs
+- **Path Handling**: Secure path handling to prevent directory traversal
+- **Error Information**: Sanitized error messages
+
+### Migration Guide
+
+#### From v1.x to v2.0
+
+**Old Usage:**
+```bash
+python wog_dump.py
+python convert_normal_map.py <path>
+```
+
+**New Usage:**
+```bash
+wog-dump full-pipeline
+wog-convert-normals <path>
+```
+
+**Legacy Compatibility:**
+The old scripts (`wog_dump.py` and `convert_normal_map.py`) are still present and will redirect to the new CLI with migration notices.
+
+#### Breaking Changes
+
+1. **Python Version**: Requires Python 3.12+ (upgrade required)
+2. **Installation**: Must be installed with pip instead of running scripts directly
+3. **CLI Interface**: New command structure (old scripts show migration help)
+4. **Dependencies**: Updated dependency requirements
+
+#### Migration Steps
+
+1. **Upgrade Python**: Ensure Python 3.12+ is installed
+2. **Install Package**: Run `pip install -e .` in the project directory
+3. **Update Scripts**: Replace old commands with new CLI commands
+4. **Test Installation**: Run `wog-dump --help` to verify installation
+
+### Dependencies
+
+#### Core Dependencies
+- `requests>=2.31.0` - HTTP client for downloads
+- `UnityPy>=1.10.0` - Unity asset processing
+- `click>=8.1.0` - CLI framework
+- `pydantic>=2.4.0` - Configuration validation
+- `Pillow>=10.0.0` - Image processing
+- `rich>=13.0.0` - Rich console output
+- `pathlib-mate>=1.0.0` - Path utilities
+- `typing-extensions>=4.8.0` - Type hint support
+
+#### Development Dependencies
+- `pytest>=7.4.0` - Testing framework
+- `pytest-cov>=4.1.0` - Coverage reporting
+- `black>=23.0.0` - Code formatting
+- `isort>=5.12.0` - Import sorting
+- `mypy>=1.5.0` - Type checking
+- `flake8>=6.0.0` - Linting
+
+### Technical Improvements
+
+#### Architecture
+- **Clean Architecture**: Separation of concerns with clear module boundaries
+- **Dependency Injection**: Proper dependency management
+- **Error Boundaries**: Comprehensive error handling at all levels
+- **Logging**: Structured logging with multiple output formats
+
+#### Code Quality
+- **Type Safety**: 100% type annotation coverage
+- **Test Coverage**: >90% test coverage across all modules
+- **Documentation**: Complete API documentation
+- **Code Style**: Consistent formatting and style guidelines
+
+#### Performance
+- **Async Operations**: Improved parallel processing
+- **Memory Management**: Optimized memory usage patterns
+- **Caching**: Smart caching of downloaded data
+- **Network Efficiency**: Better retry logic and connection management
+
+---
+
+## [1.x.x] - Previous Versions
+
+See git history for changes in previous versions. The v1.x series used a simple script-based approach with basic functionality.