Expand description
Plugin system for extending Formatorbit with custom functionality.
Plugins are Python files that extend Formatorbit with:
- Decoders: Parse custom input formats
- Visualizers: Custom rich display rendering
- Currencies: Custom currency exchange rates
- Traits: Value observations (like “is prime”)
- Expression Extensions: Variables and functions for expressions
§Plugin Location
Plugins are loaded from ~/.config/forb/plugins/ by default.
Files ending in .sample are not loaded (rename to enable).
§Plugin Format
Each plugin is a single .py file with required metadata:
__forb_plugin__ = {
"name": "My Plugin",
"version": "1.0.0",
"author": "Your Name", # optional
"description": "What it does" # optional
}Modules§
- bundled
- Bundled plugins that ship with Formatorbit.
- discovery
- Plugin discovery - finding plugin files in the filesystem.
Structs§
- Expr
Func Plugin - An expression function provided by a plugin.
- Expr
VarPlugin - An expression variable provided by a plugin.
- Plugin
Info - Information about a loaded plugin item.
- Plugin
Load Report - Report of plugin loading results.
- Plugin
Meta - Metadata about a loaded plugin.
- Plugin
Registry - Registry of loaded plugins.
Enums§
- Plugin
- A loaded plugin (any type).
- Plugin
Error - Errors that can occur during plugin operations.
Traits§
- Currency
Plugin - Trait for currency plugins that provide exchange rates.
- Decoder
Plugin - Trait for decoder plugins that parse custom input formats.
- Trait
Plugin - Trait for trait plugins that observe properties of values.
- Visualizer
Plugin - Trait for visualizer plugins that provide custom rich display.