INDEX.md

Documentation Index

Welcome to the Ultimate Media Downloader documentation. This index helps you find the information you need.


I want to...Go to...
Install the applicationInstallation Guide
Learn how to use itUsage Guide
Download 4K wallpapersDownloading Wallpapers
Update to latest versionAuto-Update Guide
Understand how it worksArchitecture
Configure settingsConfiguration Guide
Fix a problemTroubleshooting

Documentation Map

Loading diagram...

Available Documents

For Users

DocumentDescription
Installation GuideHow to install on any operating system
Usage GuideComplete guide to using the application
Configuration GuideAll configuration options explained
Auto-Update GuideAutomatic version checking and updates
TroubleshootingSolutions to common problems
ChangelogVersion history and release notes

For Developers

DocumentDescription
ArchitectureSystem design with diagrams
Handlers DocumentationPlatform handler details
File StructureProject organization
Project OverviewHigh-level project summary

Reading Order for New Users

  1. Installation Guide - Get the application running
  2. Usage Guide - Learn basic commands
  3. Configuration Guide - Customize settings (optional)

Reading Order for Developers

  1. Project Overview - Understand the project
  2. Architecture - Learn the design
  3. File Structure - Navigate the code
  4. Handlers Documentation - Extend functionality

Quick Reference

Basic Commands

# Start interactive mode
umd

# Download video
umd "URL"

# Download audio
umd "URL" --audio-only --format mp3

# Browse 4K wallpapers
umd --wallpaper

# Search wallpapers
umd --wallpaper-search "anime"

# Show help
umd --help

Common Options

OptionDescription
--audio-onlyExtract audio only
--format mp3Set output format
--quality 1080pSet video quality
--output DIRSet download directory
--verboseShow detailed output
--wallpaperBrowse & download 4K wallpapers
--wallpaper-search QUERYSearch 4kwallpapers.com directly

Getting Help

If you cannot find what you need:

  1. Check the Troubleshooting Guide
  2. Search the documentation for keywords
  3. Run umd --help for command reference
  4. Create an issue on Codeberg

Contributing to Documentation

Documentation improvements are welcome. When contributing:

  • Use clear, simple language
  • Include examples where helpful
  • Add Mermaid diagrams for complex concepts
  • Keep formatting consistent