Skip to content

Plugin Distribution

Jump to bottom
60plus edited this page Apr 13, 2026 · 1 revision

Plugin Distribution

Manual Install (ZIP)

  1. Package your plugin:
cd my-plugin
zip -r ../my-plugin-v1.0.0.zip .
  1. In GamesDownloader, go to Settings > Plugins
  2. Drag and drop the ZIP file
  3. Plugin is extracted, dependencies installed, and loaded

Theme plugins need a container restart after install (Settings > Plugin Store > Restart Now).

Plugin Store

The Plugin Store lets users discover and install plugins from the GD UI.

Adding Your Plugin

  1. Open an issue on gd3-plugin-store
  2. Select "Add Plugin to Store"
  3. Fill in: name, type, description, repo URL, ZIP download URL, version
  4. Your plugin will be reviewed and added to store.json

Hosting Your Own Store

Anyone can run a plugin store - just host a store.json:

{
  "version": 1,
  "name": "My Plugin Store",
  "description": "Custom plugins",
  "plugins": [
    {
      "id": "my-plugin",
      "name": "My Plugin",
      "description": "Does cool things",
      "version": "1.0.0",
      "author": "me",
      "type": "lifecycle",
      "category": "Tools",
      "icon": "https://example.com/logo.png",
      "screenshots": [],
      "downloadUrl": "https://example.com/my-plugin-v1.0.0.zip",
      "downloadSize": 10240,
      "gdVersionMin": "3.0.0",
      "repository": "https://github.com/me/my-plugin",
      "changelog": "v1.0.0: Initial release",
      "updated": "2026-04-12"
    }
  ]
}

Users add your store URL in Settings > Plugin Store > Sources.

Update Detection

The Plugin Store compares version in store.json with the installed plugin's version. When a newer version is available:

  • Badge appears on user avatar (configurable interval: 1h/6h/24h/off)
  • "Update" button with changelog preview in Plugin Store
  • Container restart button for theme plugins

Store Fields

Field Required Description
id yes Must match plugin.json id
name yes Display name
version yes Semantic version
author yes Author name
type yes theme/metadata/lifecycle/widget/download/library
downloadUrl yes Direct URL to ZIP file
description no Short description
category no UI category (Theme/Metadata/Tools)
icon no Logo URL
screenshots no Array of image URLs
downloadSize no ZIP size in bytes
gdVersionMin no Minimum GD version
repository no Source code URL
changelog no Version history (newline-separated)
updated no Last update date (YYYY-MM-DD)

Clone this wiki locally