Mango utils

Utilities that interact with mango IPC (mmsg) to provide a better experience for common tasks like screenshots and screencasts.

Project Status

⚠️ Early stage Currently, the only functionality directly interacting with mango IPC (mmsg) is current window screenshots. Full integration is deferred until mangowc’s new IPC implementation is available. All dependencies are chosen to work well with mangowc (wlroots).

Dependencies

mcast

• Required:
  • One of: wf-recorder(default), wl-screenrec, gpu-screen-recorder
  • slurp
  • notify-send

mshot

• Required: grim, slurp, wl-copy, notify-send
• Optional: satty (for annotations)

Installation

Run the following command to clone the repository, install binaries to ~/.local/bin, and set up default configurations in ~/.config/mango-utils:

curl -fsSL https://raw.githubusercontent.com/atheeq-rhxn/mango-utils/main/install.sh | sh

Note: Ensure ~/.local/bin is in your PATH.

Usage

Commands and Options

Tool	Flag	Argument	Description
mcast	-r, --region	-	Record a selected screen region
	-b, --backend	RECORDER	Backend: wf-recorder wl-screenrec gpu-screen-recorder
	-t, --toggle	-	Toggle recording on/off
	-o, --output	DIRECTORY	Set the output directory
	-f, --filename	NAME	Set the output filename/pattern
mshot	-r, --region	-	Screenshot a selected region
	-w, --window	-	Capture the active window via mmsg
	-p, --pointer	-	Include mouse pointer in capture
	-a, --annotate	-	Open in satty for annotation
	-o, --output	DIRECTORY	Set the output directory
	-f, --filename	NAME	Set the output filename/pattern
	--no-copy	-	Skip copying to clipboard

Mangowc Example Keybindings

# Screenshot: Fullscreen (copied to clipboard and saved)
bind=none,Print,spawn_shell,mshot

# Screenshot: Selected region
bind=SHIFT,Print,spawn_shell,mshot -r

# Screenshot: Active window
bind=ALT,Print,spawn_shell,mshot -w

# Screenshot: Region with immediate annotation
bind=SHIFT+ALT,Print,spawn_shell,mshot -ra

# Screencast: Toggle fullscreen recording
bind=none,F12,spawn_shell,mcast --toggle

# Screencast: Toggle region recording
bind=SHIFT,F12,spawn_shell,mcast --toggle --region

Configuration

Default settings are stored in ~/.config/mango-utils/:

• mcast.conf: Sets output_dir (default: ~/Videos/Screencasts) and filename_pattern.
• mshot.conf: Sets output_dir (default: ~/Pictures/Screenshots), filename_pattern, and pointer_default.

Development

Tools are built using bashly. To regenerate a tool after modifying its source:

# From the tool's directory (mcast/ or mshot/)
bashly generate