Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 3.79 KB

Home.md

File metadata and controls

58 lines (40 loc) · 3.79 KB

QTranslate Wiki

Welcome to the QTranslate documentation wiki.


For Users

Platform support: the Windows package (bundled Java runtime) requires Windows 10 or later, x64; Windows 7/8.1 are not supported. macOS and Linux run QTranslate.jar with Java 17 or later.

  • Installing Plugins — how to find, install, and configure plugins
  • Hotkeys — global vs. app-local hotkeys, switching presets, and troubleshooting one that won't fire
  • Screen OCR and the OCR Workspace — fast OCR workflows, capture shortcuts, editable text, provider/language selection, and translation destinations
  • System Services — the bundled offline OCR/TTS/spell-check plugin, and what each platform needs
  • AI Services — point translation, summarizing, rewriting, and Vision OCR at a local Ollama/LM Studio server or a cloud OpenAI-compatible endpoint
  • Adding a Language — translate the QTranslate interface into your language
  • Adding a Theme — install community themes or create your own

Where QTranslate stores things

Settings, plugin data, and logs all live in one app data directory next to nothing else — QTranslate never writes outside it. The exact path is printed in the log at startup (App data directory: ...) and is also where log files themselves are kept. See Adding a Language or Adding a Theme for how to find and use that folder.

For Developers

Plugin Marketplace (coming soon)

The signed in-app catalog and independent plugin updater are planned but are not available yet. Today, users install trusted plugin JARs manually through Settings → Plugins.

Plugin authors can prepare for future catalog support by publishing releases, checksums, compatibility metadata, and the qtranslate-plugin topic.

→ Current plugin publishing guide

Plugin examples (in the repo)

The bundled plugins are the best reference for plugin development:

Source
🔵 plugins/google-services/ — Translator, TTS, OCR, Spell Checker, Dictionary with API key settings
🟠 plugins/bing-services/ — Translator, TTS, Spell Checker with token auth
🤖 plugins/ai-services/ — Translator, Summarizer, Rewriter, Spell Checker, Dictionary, Vision OCR via OpenRouter or a local endpoint
💻 plugins/system-services/ — offline OCR, TTS, and Spell Checker with no settings at all, backed by a different implementation per platform
🌐 plugins/mozhi-services/, plugins/libretranslate-services/ — Translator against a user-supplied self-hosted instance URL
📄 plugins/csv-services/ — Dictionary backed by a local file, no network at all
🔧 plugins/common/ — shared HTTP client, language mapper, JSON parser

Can't find what you're looking for? Open an issue and ask.