Stu Leak
5d07d5bb61
This commit introduces a new, comprehensive installation guide for Windows users (INSTALL_WINDOWS.md) and refactors the main INSTALLATION.md into a platform-agnostic hub. This addresses the documentation gap for the Windows platform, providing clear and distinct instructions for all supported operating systems. |
||
|---|---|---|
| .. | ||
| convert | ||
| inspect | ||
| rip | ||
| upscale | ||
| AUTHOR_MODULE.md | ||
| BUILD_AND_RUN.md | ||
| BUILD.md | ||
| CHANGELOG.md | ||
| COMPARE_FULLSCREEN.md | ||
| COMPLETION_SUMMARY.md | ||
| DEV14_WINDOWS_IMPLEMENTATION.md | ||
| DVD_IMPLEMENTATION_SUMMARY.md | ||
| DVD_USER_GUIDE.md | ||
| GNOME_COMPATIBILITY.md | ||
| INSTALL_LINUX.md | ||
| INSTALL_WINDOWS.md | ||
| INSTALLATION.md | ||
| INTEGRATION_GUIDE.md | ||
| LATEST_UPDATES.md | ||
| LATEX_PREPARATION.md | ||
| LOSSLESSCUT_INSPIRATION.md | ||
| MODULES.md | ||
| PERSISTENT_VIDEO_CONTEXT.md | ||
| PLAYER_MODULE.md | ||
| QUEUE_SYSTEM_GUIDE.md | ||
| QUICKSTART.md | ||
| README.md | ||
| ROADMAP.md | ||
| TEST_DVD_CONVERSION.md | ||
| TESTING_DEV13.md | ||
| TRIM_MODULE_DESIGN.md | ||
| VIDEO_METADATA_GUIDE.md | ||
| VIDEO_PLAYER_FORK.md | ||
| VIDEO_PLAYER.md | ||
| VT_PLAYER_IMPLEMENTATION.md | ||
| VT_PLAYER_INTEGRATION_NOTES.md | ||
| WINDOWS_COMPATIBILITY.md | ||
| WINDOWS_SETUP.md | ||
VideoTools Documentation
VideoTools is a professional-grade video processing suite with a modern GUI. It specializes in creating DVD-compliant videos for authoring and distribution.
For a high-level overview of what is currently implemented, in progress, or planned, please see the Project Status Page.
Documentation Structure
Core Modules (Implementation Status)
✅ Implemented
- Convert - Video transcoding and format conversion with DVD presets.
- Inspect - Basic metadata viewing.
- Rip - Extraction from
VIDEO_TSfolders and.isoimages. - Queue System - Batch processing with job management.
🟡 Partially Implemented / Buggy
- Player - Core video playback is functional but has critical bugs blocking development.
- Upscale - AI-based upscaling (Real-ESRGAN) is integrated.
🔄 Planned
- Merge - [PLANNED] Join multiple video clips.
- Trim - [PLANNED] Cut and split videos.
- Filters - [PLANNED] Video and audio effects.
- Audio - [PLANNED] Audio track operations.
- Thumb - [PLANNED] Thumbnail generation.
Additional Modules (All Planned)
- Subtitle - [PLANNED] Subtitle management.
- Streams - [PLANNED] Multi-stream handling.
- GIF - [PLANNED] Animated GIF creation.
- Crop - [PLANNED] Video cropping tools.
- Screenshots - [PLANNED] Frame extraction.
Implementation Documents
- DVD Implementation Summary - Technical details of the DVD encoding system.
- Windows Compatibility - Notes on cross-platform support.
- Queue System Guide - Deep dive into the batch processing system.
- Module Overview - The complete feature list for all modules (implemented and planned).
- Persistent Video Context - Design for cross-module video state management.
- Custom Video Player - Documentation for the embedded playback implementation.
Development Documentation
- Integration Guide - System architecture and integration plans.
- Build and Run Guide - Instructions for setting up a development environment.
- FFmpeg Integration - [PLANNED] Documentation on FFmpeg command building.
- Contributing - [PLANNED] Contribution guidelines.
User Guides
- Installation Guide - Comprehensive installation instructions.
- DVD User Guide - A step-by-step guide to the DVD encoding workflow.
- Quick Start - The fastest way to get up and running.
- Workflows - [PLANNED] Guides for common multi-module tasks.
- Keyboard Shortcuts - [PLANNED] A reference for all keyboard shortcuts.
Quick Links
- Module Feature Matrix
- Latest Updates - Recent development changes.
- Windows Implementation Notes
- VT_Player Integration - [PLANNED] Frame-accurate playback system.