A collection of custom plugins for TRMNL e-ink displays.
This repository contains various TRMNL plugins, each in its own directory. Each plugin directory includes a README.md file with detailed information about the plugin's functionality and configuration settings.
- Docker
- TRMNL API key (obtain from your TRMNL account)
-
Use the
trmnlp.shscript to develop and test plugins:./trmnlp.sh <plugin-directory> [command]
On first run, the script will prompt you to enter your TRMNL API key and automatically create the
trmnl.envfile.
The script runs the TRMNL plugin development environment in Docker, mounting the specified plugin directory and making it available at http://localhost:4567.
Create a new plugin with:
./trmnlp.sh <new-plugin-dir-name> initRun the development server:
./trmnlp.sh <plugin-directory> servePull changes from TRMNL server:
./trmnlp.sh <plugin-directory> pullPush changes to TRMNL server:
./trmnlp.sh <plugin-directory> pushSome comic plugins are generated from shared templates using a Python-based code generator. See _generator/GENERATOR.md for details.