terminal-screensaver
| Crates.io | terminal-screensaver |
| lib.rs | terminal-screensaver |
| version | 0.0.1 |
| created_at | 2025-09-08 08:26:04.089125+00 |
| updated_at | 2025-09-08 08:26:04.089125+00 |
| description | A dynamic terminal screen saver crate with plugin architecture |
| homepage | |
| repository | https://github.com/BA-CalderonMorales/terminal-screensaver |
| max_upload_size | |
| id | 1828990 |
| size | 1,533,093 |
Brandon A Calderon-Morales (BA-CalderonMorales)
documentation
README
Terminal Screensaver
A dynamic terminal screen saver crate with plugin architecture that automatically resizes with any screen size.
Demo
Features
- Dynamic Sizing: Automatically adapts to any terminal size
- Script Integration: Execute any script or command with custom keyboard shortcuts
- Plugin Architecture: Extensible event handling for custom actions
- TOML Configuration: Easy customization without code changes
- Cross-platform: Works on Windows, Linux, and macOS
- Library & Binary: Use as a library or standalone application
- Interactive Help Display: Built-in help panel with keyboard shortcuts
For detailed feature documentation, see Features Guide.
Quick Start
Installation & Usage
# Clone and build
git clone https://github.com/BA-CalderonMorales/terminal-screensaver.git
cd terminal-screensaver
cargo build --release
# Run with demo configuration
./target/release/terminal-screensaver -c demo-config.toml
For comprehensive setup instructions, see Quick Start Guide.
Configuration
Basic configuration example:
text = "My Terminal Screensaver"
style = "default"
[[actions]]
key = "h"
description = "Say Hello"
command = "./scripts/hello.sh"
For complete configuration documentation, see Configuration Guide.
Controls
| Key | Action |
|---|---|
ESC |
Exit screensaver |
ENTER |
Show action menu |
a-z, 0-9, symbols |
Execute configured actions |
For detailed control information, see Controls & Keyboard Shortcuts.
Documentation
| Document | Description |
|---|---|
| Quick Start | Installation, basic usage, and first steps |
| Features | Complete feature overview and capabilities |
| Configuration | Comprehensive configuration guide and examples |
| Controls | Keyboard shortcuts and control reference |
| Architecture | Technical architecture and design principles |
| Roadmap | Future features and development timeline |
| Testing | Testing strategies and guidelines |
| Security | Security considerations and best practices |
| CLI | Command-line interface documentation |
| Backend | Backend development guide |
| Frontend | Frontend and styling guide |
| CI/CD | Continuous integration and deployment |
| Documentation | Documentation standards and guidelines |
Support the Project
If Terminal Screensaver has been helpful for your development workflow or you appreciate the plugin architecture approach, consider supporting the project:
Your support helps maintain and improve Terminal Screensaver for the entire community!
License
Licensed under MIT license.