trussc-addons

TrussC addon registry. Lists community and official addons installable via trusscli addon clone.

Adding your addon

No pull request needed — addons are discovered automatically by GitHub topic. Just:

1. Add the trussc-addon topic to your repository (GitHub repo → About → topics).
2. Make the repo public (and not archived).
3. Add an addon.json at the repo root. {} is enough to be picked up, but metadata makes it discoverable:

   {
     "description": "Short description of what your addon does",
     "version": "1.0.0",
     "author": "Your Name",
     "license": "MIT",
     "trussc_version": ">=0.4.0",
     "screenshot": "screenshot.png",
     "keywords": ["physics", "2d"]
   }

   • No name field — the addon name is the repository name (e.g. tcxMyAddon).
   • version: self-reported. Git tags (e.g. v1.0.0) are stored separately as latest_tag.
   • screenshot: relative path in your repo, or an absolute URL.
   • keywords: help trusscli addon search find your addon.

A daily GitHub Actions crawl finds every public repo with the trussc-addon topic and a readable addon.json, then regenerates the registry. Your addon appears within a day. Topics are not inherited by forks, so a fork only shows up if its owner adds the topic too.

How it works

• main branch — addons_list.json, auto-generated by the crawl from topic search. Do not hand-edit.
• gh-pages branch — registry.json, auto-generated with versions and metadata from each addon's addon.json, published via GitHub Pages.

trusscli fetches registry.json from GitHub Pages to discover addons (a precomputed file avoids per-user GitHub API rate limits).

Using addons

trusscli addon search physics     # Search available addons
trusscli addon list --remote      # List all addons (local + remote)
trusscli addon clone tcxMyAddon   # Clone an addon into your TrussC installation
trusscli addon add tcxMyAddon     # Add it to your project
trusscli addon pull tcxMyAddon    # Update an addon to the latest version
trusscli addon pull --all         # Update all cloned addons