Files
web-framework-resources/README.md
T

2.0 KiB

Web Framework Resources

Reusable plugins and theme templates for Web Framework.

The default catalog is https://gitea.coreplay.eu/Dymas/web-framework-resources/raw/branch/main/catalog.json. Open Config → Add resources, search, and install a plugin or theme. Restart the application, then enable it under Plugins or select it under Themes. Existing bundled plugins and default themes remain available without downloading anything.

Each plugins/<id>/plugin.json or themes/<id>/theme.json declares an ID, name, description, and version. Plugins include plugin.py; the starter templates reuse the framework's factories. Themes declare mode (dark, light, system), accent (violet, blue, green), and density (comfortable, compact). Theme templates reuse the framework's design tokens and layouts.

Publish resources

Store newly developed plugins and themes here. Keep source directories and versioned ZIP archives in the repository. ZIP files contain resource files at their root, with no enclosing directory. Add entries to catalog.json with type, all metadata fields, a relative archive URL and the archive's SHA-256 digest. Increment a resource's version whenever its files change. Framework installs do not overwrite existing resources; operators back up and remove an old installed directory before installing a replacement. Installed data stays in the application's control store.

Catalog schema version 1 uses a top-level resources array. Custom catalogs follow this same format. Only configure trusted repositories: installing plugins allows their Python code to execute at the next application startup. Downloads require no repository credentials, so publish catalogs and archives for read access by the application.

The initial six resources can be regenerated using PYTHONPATH=. python tools/prepare_resources.py /path/to/web-framework-resources in the framework repository. Add custom entries separately before publishing; the exporter regenerates the bundled catalog.