-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is needed
Milestone
Description
Summary:
Encourage developer involvement and upstream contributions by documenting how users can create and contribute their own custom mux modes. The process is straightforward for those with basic Rust knowledge and a working development environment.
How to Create a Custom Mux Mode:
- Create a new source file in the
src/mux_modes/directory. - Define a new struct implementing the
MuxModetrait, specifically thehandle_eventmethod. - Update
mod.rsto:- Import the new module
- Add the new mode to the
ModeTypeenum - Extend the factory function to dispatch the new mode
- Rebuild and run CtrlAssist, selecting your new mode via the CLI.
Advanced Ideas:
- Explore forwarding additional CLI arguments to custom mux modes (e.g.,
ctrlassist mux --mode toggle -- --button=selectto override the default toggle button). - Consider using
clapsubcommand or argument injection for mode-specific configuration. - Document best practices for structuring, testing, and submitting new mux modes upstream.
Notes:
- Lowering the barrier for scripting and contributing mux modes will foster innovation and community involvement.
- Example templates and documentation should be provided to guide new contributors.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is needed