QuickTranslate Module Store Guide

How to Add a Module to the Store

1. Build the .qt-module File

# Use the CLI scaffold
node packages/create-qt-module/index.js

# Or write manually, see EXAMPLE.md

The generated .qt-module file is a standard JS file with a complete manifest and module logic.

2. Copy to store/ Directory

cp your-module.qt-module store/

3. Add Entry to store/modules.json

Open store/modules.json and add to the modules array:

{
  "id": "engine-your-engine",
  "name": "Your Module Name",
  "version": "1.0.0",
  "author": "Your Name",
  "type": "translator",
  "description": "What this module does",
  "download": "store/your-module.qt-module",
  "size": "2.5 KB"
}

Field Reference

FieldDescriptionExample
idUnique ID, matches manifest.idengine-deepl
nameModule nameDeepL Translator
versionVersion number1.0.0
authorAuthor (GitHub username)yourname
typeModule typetranslator / mode / renderer / ...
descriptionShort description (<=80 chars)DeepL API translation engine
download.qt-module file pathstore/deepl.qt-module
sizeFile size2.5 KB

4. Submit

1. Fork the repository

2. Add your .qt-module file and update store/modules.json

3. Submit a Pull Request

4. After review and merge, the website updates automatically