1.7 KiB
exteraGram Plugin Base
TL;DR: a template repo for writing exteraGram plugins as normal
multi-file Python projects. Write code in src/, run one command, get a single .plugin
file deployed to your phone or published to Releases.
Description
exteraGram loads every plugin from exactly one Python file. This template lets you split a
plugin into ordinary modules and packages anyway: a bundler compiles src/ and plugin.json
into that single file, an offline harness verifies the result without a device, ADB scripts
push it to a connected phone and reload it, and CI publishes every version to the repo's
Releases tab.
Features
None for the end user. The bundled sample plugin (Hello Bundle) only proves that the
toolchain works. This repo is meant to be used as a template for creating other plugins:
click "Use this template" (or clone it), then replace plugin.json and src/ with your own.
Documentation
- Development: getting started, repo layout, building and verifying, icon export
- How exteraGram plugins work: the plugin format and lifecycle
- Device setup and ADB automation: deploy, watch, logs, debugger
- Versioning and releases: git hooks, auto-bump, CI publishing
- SDK notes: condensed exteraGram SDK API surface
Quick start
python3 tools/bundle.py --check # once after cloning: enables the git hooks
bash scripts/deploy.sh --enable # build + push to a connected device + enable