This directory contains detailed documentation for all plugins in the EventGhost-Rust project. Each plugin is documented in RST format, providing comprehensive information about its functionality, implementation details, and migration status from Python to Rust.
The plugins are organized into several categories:
global_monitor.rst- Global system monitoring capabilitiesmouse.rst- Mouse event handling and control
eventghost_core.rst- Core EventGhost functionalitykeyboard.rst- Keyboard event handlingsystem.rst- System-level operationsradiosure.rst- Radio control functionality
file_operations.rst- File system operationsdirectory_watcher.rst- Directory monitoring
window.rst- Window managementtask.rst- Task scheduling and managementnetwork.rst- Network operations
process_watcher.rst- Process monitoringspeech.rst- Text-to-speech capabilitiesscheduleghost.rst- Advanced schedulingtimer.rst- Timer functionalityserial.rst- Serial port communicationping.rst- Network ping utilitiesmqtt.rst- MQTT protocol supportgoogle_chrome.rst- Chrome browser integration
Each plugin documentation file follows a standard RST format including:
- Overview and purpose
- Configuration options
- Events generated/handled
- Actions provided
- Implementation details
- Migration notes from Python to Rust
When adding new plugin documentation:
- Use the
template.rstas a starting point - Follow the established RST formatting
- Include all necessary sections
- Update the
index.rstto include your new plugin - Ensure proper categorization in the documentation structure
The documentation reflects different stages of plugin development:
- ✅ Complete Analysis - Full documentation with Rust implementation
- 🔄 Migration Analysis - Detailed analysis for Python to Rust migration
- 📝 Initial Analysis - Basic documentation and planning
- ⏳ Pending - Documentation to be expanded