added wayshell framework

2026-06-27 10:50:50 +02:00
parent d4826bd336
commit 79b45ab123
18 changed files with 1125 additions and 0 deletions
@@ -0,0 +1,38 @@
+# Wayshell Module System Design Guidelines
+
+## Overview
+
+The Wayshell Module System is designed to be flexible, efficient, and easy to use. This document outlines the design guidelines for the system.
+
+## Module Types
+
+### Zone Module
+
+- **Definition**: Allows defining zones and triggers for entering and exiting these zones.
+- **Implementation**: Use efficient data structures to manage zones and triggers.
+
+### Layout Module
+
+- **Definition**: Allows triggering actions based on the activation or deactivation of specific layout types.
+- **Implementation**: Use event-driven architecture to handle layout changes.
+
+### Focused Module
+
+- **Definition**: Allows triggering actions based on focusing or unfocusing specific client types.
+- **Implementation**: Use efficient event handling to manage focus changes.
+
+## Configuration Files
+
+- **wayshell.conf**: General configuration file.
+- **wayshell.modules**: Defines the modules.
+
+## Performance Optimization
+
+- **Efficient Parsing**: Optimize the parsing of configuration files to minimize CPU usage.
+- **Event Debouncing**: Implement debouncing for events to avoid unnecessary triggers.
+
+## Testing
+
+- **Unit Tests**: Write unit tests for each module type.
+- **Integration Tests**: Write integration tests to ensure the modules work together correctly.
+- **Performance Tests**: Conduct performance tests to ensure the system meets the CPU usage constraints.