Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

blockodile modules

The module library for blockodile. One folder per module, in the exact format the app installs: unzip into ~/.config/blockodile/modules/ and the block shows up in the "+ block" menu a second later.

Browse and install from the blockodile website, /modules (it reads registry.json from the latest release).

Add your module

  1. Fork, create modules/<your-id>/ with a module.json (and index.html for web modules).
  2. Fill in description, details and author (your GitHub handle): the card and the module page are built from them. glyph is an optional 5x5 pixel icon (# lit, . empty), requires the install command for a CLI.
  3. node scripts/build-registry.mjs locally to validate.
  4. Open a PR. CI validates; on merge the zip and registry.json are republished automatically.
{
  "id": "my-module",
  "name": "My module",
  "kind": "web",
  "entry": "index.html",
  "w": 4, "h": 3,
  "description": "What it does, in one sentence.",
  "details": ["A paragraph for the module page.", "Another one: what it needs, how it behaves."],
  "requires": "brew install something",
  "glyph": ["#...#", ".###.", "..#..", ".###.", "#...#"],
  "author": "your-github-handle",
  "tags": ["git"],
  "version": "0.1.0"
}

Rules: id equals the folder name; kind is command (any CLI/TUI) or web (one self-contained HTML file, no relative assets). Full guide: the Modules section of the blockodile website docs.

About

Module library for blockodile: one folder per block, PR to add yours

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages