README

CyberPatchMaker Documentation

Table of Contents

Getting Started

• Quick Start Guide — Get up and running in 5 minutes

User Guides

• Generator Tool Guide — Complete guide to patch generation
• Applier Tool Guide — Complete guide to patch application
• Self-Contained Executables — Create standalone patch executables
• Downgrade Guide — Rollback to previous versions
• CLI Reference — Quick command-line reference
• Version Management — Managing multiple versions
• Compression Options — Choosing the right compression
• Simple Mode Guide — Simplified interface for end users

Core Concepts

• How It Works — Understanding the patch system
• System Architecture — System design and code organization
• Data Structures — Key types and data flow
• Backup System — Selective backup, timing, exclusion, and rollback
• .cyberignore File Guide — Exclude files from patches

Advanced Features

• Scan Caching — Instant patch generation with cached scans
• Large File Handling — Memory-efficient processing for files >1GB
• Multi-Part Patches — Automatic splitting of patches >4GB

Technical Reference

• Key File System — Key file detection and version identification
• Hash Verification — SHA-256 verification system

Problem Solving

• Troubleshooting — Common issues and solutions
• Performance — Optimization techniques

Development

• Development Setup — Setting up dev environment and contributing
• Testing Guide — Running and writing tests

Quick Links

• Need Help? Start with the Quick Start Guide
• Generating Patches? See Generator Tool Guide
• Applying Patches? See Applier Tool Guide
• Want Simple Distribution? Check out Self-Contained Executables
• Working with Large Patches? See Multi-Part Patches
• Understanding Backups? Read Backup System
• Something Not Working? Check Troubleshooting
• Want to Contribute? Read Development Setup

Documentation Version

This documentation corresponds to CyberPatchMaker v1.0.16.