Installing modules

Modules live under the per-user modules directory:

• Windows: %APPDATA%\readout\modules\<id>\
• macOS: ~/Library/Application Support/readout/modules/<id>/

There are two ways to get one in:

1. Drop the folder into that directory. readout detects it, leaves it disabled, and shows a "new module" notification — enable it in Settings → Modules.
2. Install module... in Settings → Modules, choosing a .zip of your bundle. This shows a permission-consent prompt (name, author, version, and exactly what the module can do) before anything is installed or runs.

New modules are always off by default — a dropped-in module never runs until the user enables it.

Distributing your module

Zip the bundle (the folder containing manifest.json at its root, or a single top-level folder wrapping it — both are accepted) and share the .zip. Users install it through the consent prompt.

User modules are third-party code. Even sandboxed, users should only install modules they trust — the consent prompt shows exactly what each one can do before it runs. See the security model.