Skip to content

docs: add action summaries to README #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ImDevinC wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add action summaries to README #43

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@

streamcontroller official plugin to do OS Related actions

## Actions

- **CPU**: Displays the current CPU usage percentage on the button.
- **CPU Temperature**: Shows the current CPU temperature in Celsius or Fahrenheit.
- **CPU Graph**: Displays a real-time graph of CPU usage over time.
- **RAM**: Displays the current RAM usage percentage on the button.
- **RAM Graph**: Displays a real-time graph of RAM usage over time.
- **Hotkey**: Execute custom keyboard shortcuts with precise control over key press and release timing.
- **Hotkey from text**: Execute keyboard shortcuts using simple text notation (e.g., "ctrl+c").
- **Write Text**: Types out configured text automatically when the button is pressed.
- **Run Command**: Executes shell commands with options for displaying output and auto-running at intervals.
- **Easy Command**: Simple action to run a shell command when the button is pressed.
- **Launch**: Opens a selected application from your system's installed apps.
- **Open In Browser**: Opens a specified URL in your default web browser.
- **Click**: Simulates mouse clicks (left, middle, or right button).
- **Move XY**: Moves the mouse cursor to specific X and Y coordinates on the screen.
- **Delay**: Adds a configurable time delay between actions in a multi-action sequence.

## Hotkeys & Write text

Hotkeys and write text actions require you are in the input group and you have the following udev rule
Expand Down