Skip to content

Commit 0b2c022

Browse files
author
g
committed
upd AGENTS.md
1 parent bf82873 commit 0b2c022

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

AGENTS.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# obs-cmd Guide
22

3+
## Notes
4+
5+
Keep AGENTS.md updated with non-trivial project design, keep it minimal and essetial
6+
37
## Technology Stack
48
- **Rust 2021 Edition**: Command-line tool for OBS Studio control
59
- **obws**: OBS WebSocket client library
@@ -9,6 +13,28 @@
913
- **async-trait**: Async trait support for command handlers
1014
- The official obs-websocket spec https://raw.githubusercontent.com/obsproject/obs-websocket/master/docs/generated/protocol.md
1115

16+
## Project Structure
17+
```
18+
src/
19+
├── main.rs # Entry point with connection setup
20+
├── cli.rs # CLI argument parsing and command definitions
21+
├── connection.rs # WebSocket connection management with retry logic
22+
├── handler.rs # Command dispatcher routing to handlers
23+
├── error.rs # Comprehensive error type definitions
24+
└── handlers/ # Modular command handlers
25+
├── mod.rs # CommandHandler trait and utilities
26+
├── general.rs # Info and hotkey commands
27+
├── scenes.rs # Scene management
28+
├── recording.rs # Recording control
29+
├── streaming.rs # Streaming control
30+
├── audio.rs # Audio source management
31+
├── filters.rs # Filter management
32+
├── media.rs # Media input control
33+
├── sources.rs # Source screenshots
34+
├── ui.rs # Projector management
35+
└── ... # Other specialized handlers
36+
```
37+
1238
## Architecture Patterns
1339

1440
### Command Handler Pattern

0 commit comments

Comments
 (0)