plugin

Jan 2, 2026

Changes in this version

type InputPlugin

+ WallpaperRawPath func() string

type InputPluginRPCClient

+ func (c *InputPluginRPCClient) WallpaperRawPath() string

type InputPluginRPCServer

+ func (s *InputPluginRPCServer) WallpaperRawPath(_ any, resp *string) error

Nov 16, 2025

Changes in this version

+ type AlternateThemeData struct

+ AllColours []CategorisedColour

+ Colours map[string]CategorisedColour

+ ThemeType string

type PaletteData

+ AlternateTheme *AlternateThemeData

Nov 16, 2025

Changes in this version

type PaletteData

+ Verbose bool

Nov 12, 2025

Changes in this version

+ const MinCompatibleVersion

+ const ProtocolVersion

+ var Handshake = plugin.HandshakeConfig

+ type CategorisedColour struct

+ Hex string

+ Hue float64

+ Index int

+ IsLight bool

+ Luminance float64

+ RGB RGBColour

+ Role string

+ Saturation float64

+ type FlagHelp struct

+ Default string

+ Description string

+ Name string

+ Required bool

+ Shorthand string

+ Type string

+ type InputOptions struct

+ ColourOverrides []string

+ DryRun bool

+ PluginArgs map[string]any

+ Verbose bool

+ type InputPlugin interface

+ Generate func(ctx context.Context, opts InputOptions) ([]color.Color, error)

+ GetFlagHelp func() []FlagHelp

+ GetMetadata func() PluginInfo

+ WallpaperPath func() string

+ type InputPluginRPC struct

+ Impl InputPlugin

+ func (p *InputPluginRPC) Client(_ *plugin.MuxBroker, c *rpc.Client) (any, error)

+ func (p *InputPluginRPC) Server(*plugin.MuxBroker) (any, error)

+ type InputPluginRPCClient struct

+ func (c *InputPluginRPCClient) Generate(_ context.Context, opts InputOptions) ([]color.Color, error)

+ func (c *InputPluginRPCClient) GetFlagHelp() []FlagHelp

+ func (c *InputPluginRPCClient) GetMetadata() (PluginInfo, error)

+ func (c *InputPluginRPCClient) WallpaperPath() string

+ type InputPluginRPCServer struct

+ Impl InputPlugin

+ func (s *InputPluginRPCServer) Generate(opts InputOptions, resp *[]byte) error

+ func (s *InputPluginRPCServer) GetFlagHelp(_ any, resp *[]FlagHelp) error

+ func (s *InputPluginRPCServer) GetMetadata(_ any, resp *PluginInfo) error

+ func (s *InputPluginRPCServer) WallpaperPath(_ any, resp *string) error

+ type OutputPlugin interface

+ Generate func(ctx context.Context, palette PaletteData) (map[string][]byte, error)

+ GetFlagHelp func() []FlagHelp

+ GetMetadata func() PluginInfo

+ PostExecute func(ctx context.Context, writtenFiles []string) error

+ PreExecute func(ctx context.Context) (skip bool, reason string, err error)

+ type OutputPluginRPC struct

+ Impl OutputPlugin

+ func (p *OutputPluginRPC) Client(_ *plugin.MuxBroker, c *rpc.Client) (any, error)

+ func (p *OutputPluginRPC) Server(*plugin.MuxBroker) (any, error)

+ type OutputPluginRPCClient struct

+ func (c *OutputPluginRPCClient) Generate(_ context.Context, palette PaletteData) (map[string][]byte, error)

+ func (c *OutputPluginRPCClient) GetFlagHelp() []FlagHelp

+ func (c *OutputPluginRPCClient) GetMetadata() (PluginInfo, error)

+ func (c *OutputPluginRPCClient) PostExecute(_ context.Context, files []string) error

+ func (c *OutputPluginRPCClient) PreExecute(_ context.Context) (bool, string, error)

+ type OutputPluginRPCServer struct

+ Impl OutputPlugin

+ func (s *OutputPluginRPCServer) Generate(palette PaletteData, resp *map[string][]byte) error

+ func (s *OutputPluginRPCServer) GetFlagHelp(_ any, resp *[]FlagHelp) error

+ func (s *OutputPluginRPCServer) GetMetadata(_ any, resp *PluginInfo) error

+ func (s *OutputPluginRPCServer) PostExecute(files []string, resp *string) error

+ func (s *OutputPluginRPCServer) PreExecute(_ any, resp ...) error

+ type PaletteData struct

+ AllColours []CategorisedColour

+ Colours map[string]CategorisedColour

+ DryRun bool

+ PluginArgs map[string]any

+ ThemeType string

+ type PluginInfo struct

+ Description string

+ Name string

+ PluginProtocol string

+ ProtocolVersion string

+ Type string

+ Version string

+ type PluginType string

+ const PluginTypeGoPlugin

+ const PluginTypeJSON

+ type RGBColour struct

+ B uint8

+ G uint8

+ R uint8

+ type RPCError struct

+ Message string

+ func (e *RPCError) Error() string