Wayscriber

https://wayscriber.com/docs/
Admin
Wayscriber is a Wayland screen annotation tool for drawing on top of your desktop during demos,...
Tokens:14,359
Snippets:261
Trust Score:5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Copy Example Config File

Source: https://wayscriber.com/docs/configuration/config-file.html

To start with default settings, create the configuration directory and copy the example configuration file. If you built from source, use the `config.example.toml` file from the repository.

```shell
__
mkdir -p ~/.config/wayscriber
cp /usr/share/doc/wayscriber/config.example.toml ~/.config/wayscriber/config.toml
```

--------------------------------

### Install Wayscriber via APT Repository

Source: https://wayscriber.com/docs/getting-started/installation.html

Recommended installation for Debian/Ubuntu systems. Adds the Wayscriber repository and installs the package.

```bash
sudo install -d /usr/share/keyrings
curl -fsSL https://wayscriber.com/apt/WAYSCRIBER-GPG-KEY.asc | sudo gpg --dearmor -o /usr/share/keyrings/wayscriber.gpg
echo "deb [signed-by=/usr/share/keyrings/wayscriber.gpg] https://wayscriber.com/apt stable main" | sudo tee /etc/apt/sources.list.d/wayscriber.list
sudo apt update
sudo apt install wayscriber
```

--------------------------------

### Install Screen Capture Dependencies

Source: https://wayscriber.com/docs/troubleshooting/common.html

Ensure that `wl-clipboard`, `grim`, and `slurp` are installed for screen capture functionality. Refer to the 'Installation' section for build-from-source instructions if not using packages.

```bash
wl-clipboard
```

```bash
grim
```

```bash
slurp
```

--------------------------------

### Enable and Start Wayscriber Service

Source: https://wayscriber.com/docs/cli/systemd.html

Use this command to enable the Wayscriber user service to start on boot and start it immediately.

```bash
systemctl --user enable --now wayscriber.service
```

--------------------------------

### Run Install Script for Source Build

Source: https://wayscriber.com/docs/getting-started/installation.html

Builds Wayscriber and then runs an installation script to copy the binary and set up Hyprland keybinds.

```bash
cargo build --release
./tools/install.sh
```

--------------------------------

### Install Wayscriber to Nix Profile

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs Wayscriber into the user's Nix profile for system-wide access.

```bash
nix profile install github:devmobasa/wayscriber
```

--------------------------------

### Install Wayscriber via DNF Repository

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs Wayscriber on Fedora/RHEL systems by adding the Wayscriber DNF repository and installing the package.

```bash
cat <<'EOF' | sudo tee /etc/yum.repos.d/wayscriber.repo
[wayscriber]
name=Wayscriber Repo
baseurl=https://wayscriber.com/rpm
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://wayscriber.com/rpm/RPM-GPG-KEY-wayscriber.asc
EOF
sudo dnf clean all
sudo dnf install wayscriber
```

--------------------------------

### Install Build Dependencies for Debian/Ubuntu

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs necessary development libraries for building Wayscriber on Debian or Ubuntu systems.

```bash
# Debian/Ubuntu
sudo apt-get install libcairo2-dev libwayland-dev libpango1.0-dev
```

--------------------------------

### Install Wayscriber Configurator using Nix

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs the Wayscriber configurator tool into the user's Nix profile.

```bash
nix profile install github:devmobasa/wayscriber#wayscriber-configurator
```

--------------------------------

### Create and Copy Default Config

Source: https://wayscriber.com/docs/print.html

Use these commands to create the configuration directory and copy the example configuration file to your user's config directory.

```bash
mkdir -p ~/.config/wayscriber
cp /usr/share/doc/wayscriber/config.example.toml ~/.config/wayscriber/config.toml
```

--------------------------------

### Install Wayscriber using a .deb Package

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs Wayscriber from a downloaded .deb file. This method does not include automatic updates.

```bash
wget -O wayscriber-amd64.deb https://github.com/devmobasa/wayscriber/releases/latest/download/wayscriber-amd64.deb
sudo apt install ./wayscriber-amd64.deb
```

--------------------------------

### Install Screenshot Tools for Source Build

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs required screenshot utilities (wl-clipboard, grim, slurp) for building Wayscriber from source on Ubuntu/Debian and Fedora.

```bash
# Ubuntu / Debian
sudo apt-get install wl-clipboard grim slurp

# Fedora
sudo dnf install wl-clipboard grim slurp
```

--------------------------------

### Install Wayscriber-bin using AUR (yay/paru)

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs the prebuilt Wayscriber binary from the Arch User Repository using either yay or paru.

```bash
yay -S wayscriber-bin
# or
paru -S wayscriber-bin
```

--------------------------------

### Install Build Dependencies for Fedora

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs necessary development tools and libraries for building Wayscriber on Fedora systems.

```bash
# Fedora
sudo dnf install gcc gcc-c++ make pkgconf-pkg-config cairo-devel wayland-devel pango-devel libxkbcommon-devel cairo-gobject-devel
```

--------------------------------

### Install Wayscriber via AUR

Source: https://wayscriber.com/docs/getting-started/quick-start.html

Use `yay` or `paru` to install Wayscriber if you are on an Arch-based distribution.

```bash
yay -S wayscriber
# or
paru -S wayscriber
```

--------------------------------

### Install Wayscriber using an RPM Package

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs Wayscriber from a downloaded .rpm file. This method does not include automatic updates.

```bash
wget -O wayscriber-x86_64.rpm https://github.com/devmobasa/wayscriber/releases/latest/download/wayscriber-x86_64.rpm
sudo rpm -Uvh wayscriber-x86_64.rpm
```

--------------------------------

### Run Wayscriber Immediately

Source: https://wayscriber.com/docs/concepts/overlay-daemon.html

Use this command for quick annotations. The overlay starts immediately and exits when you close it.

```bash
wayscriber --active
```

--------------------------------

### Install Wayscriber Configurator using a .deb Package

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs the Wayscriber configurator from a downloaded .deb file. This method does not include automatic updates.

```bash
wget -O wayscriber-configurator-amd64.deb https://github.com/devmobasa/wayscriber/releases/latest/download/wayscriber-configurator-amd64.deb
sudo apt install ./wayscriber-configurator-amd64.deb
```

--------------------------------

### Install Build Dependencies for Wayscriber

Source: https://wayscriber.com/docs/print.html

Installs necessary development libraries for building Wayscriber from source on Debian/Ubuntu and Fedora systems.

```shell
# Debian/Ubuntu
sudo apt-get install libcairo2-dev libwayland-dev libpango1.0-dev

# Fedora
sudo dnf install gcc gcc-c++ make pkgconf-pkg-config cairo-devel wayland-devel pango-devel libxkbcommon-devel cairo-gobject-devel
```

--------------------------------

### Run Wayscriber without Installation using Nix

Source: https://wayscriber.com/docs/getting-started/installation.html

Executes Wayscriber directly from its GitHub repository using Nix, without a formal installation.

```bash
nix run github:devmobasa/wayscriber
```

--------------------------------

### Install Wayscriber Configurator via APT

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs the Wayscriber configurator tool on Debian/Ubuntu systems using the APT package manager.

```bash
sudo apt install wayscriber-configurator
```

--------------------------------

### Install Wayscriber Configurator via DNF

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs the Wayscriber configurator tool on Fedora/RHEL systems using the DNF package manager.

```bash
sudo dnf install wayscriber-configurator
```

--------------------------------

### Install Wayscriber Configurator using an RPM Package

Source: https://wayscriber.com/docs/getting-started/installation.html

Installs the Wayscriber configurator from a downloaded .rpm file. This method does not include automatic updates.

```bash
wget -O wayscriber-configurator-x86_64.rpm https://github.com/devmobasa/wayscriber/releases/latest/download/wayscriber-configurator-x86_64.rpm
sudo rpm -Uvh wayscriber-configurator-x86_64.rpm
```

--------------------------------

### Set Wayscriber Configurator Path

Source: https://wayscriber.com/docs/troubleshooting/common.html

Install `wayscriber-configurator` or set the `WAYSCRIBER_CONFIGURATOR` environment variable to its path. This ensures the configurator can be found and used.

```bash
wayscriber-configurator
```

```bash
WAYSCRIBER_CONFIGURATOR
```

--------------------------------

### Force Pixmap for Tray Icons

Source: https://wayscriber.com/docs/troubleshooting/common.html

If the tray icon is blank or shows square placeholders, start the daemon with the `WAYSCRIBER_TRAY_FORCE_PIXMAP` environment variable set to 1. This can fix rendering issues with tray icons.

```bash
WAYSCRIBER_TRAY_FORCE_PIXMAP=1
```

--------------------------------

### Bind Wayscriber Daemon Toggle in Hyprland

Source: https://wayscriber.com/docs/getting-started/quick-start.html

Example configuration for Hyprland to bind a key combination to toggle the Wayscriber daemon. Define the toggle binding only once in your compositor settings.

```bash
bind = SUPER, D, exec, wayscriber --daemon-toggle
```

--------------------------------

### Simulate Profiles with Symlinks

Source: https://wayscriber.com/docs/print.html

This bash script demonstrates how to manage multiple configuration profiles by creating separate TOML files and using symlinks to switch between them. Restart Wayscriber after switching profiles.

```bash
mkdir -p ~/configs
cp config.example.toml ~/configs/wayscriber-presentation.toml
cp config.example.toml ~/configs/wayscriber-recording.toml

ln -sf ~/configs/wayscriber-presentation.toml ~/.config/wayscriber/config.toml
```

--------------------------------

### Manage Configuration Profiles with Symlinks

Source: https://wayscriber.com/docs/configuration/profiles.html

Simulate different profiles by maintaining separate configuration files and using symbolic links to point to the desired active configuration. Restart Wayscriber after switching profiles.

```bash
mkdir -p ~/configs
cp config.example.toml ~/configs/wayscriber-presentation.toml
cp config.example.toml ~/configs/wayscriber-recording.toml

ln -sf ~/configs/wayscriber-presentation.toml ~/.config/wayscriber/config.toml

```

--------------------------------

### Build Wayscriber from Source

Source: https://wayscriber.com/docs/getting-started/installation.html

Clones the Wayscriber repository and builds the release version using Cargo.

```bash
git clone https://github.com/devmobasa/wayscriber.git
cd wayscriber
cargo build --release
```

--------------------------------

### Build Wayscriber Configurator from Source

Source: https://wayscriber.com/docs/getting-started/installation.html

Builds the Wayscriber configurator tool from its source code using Cargo.

```bash
cargo build --release --manifest-path configurator/Cargo.toml
```

--------------------------------

### Configure Presets in TOML

Source: https://wayscriber.com/docs/configuration/profiles.html

Define tool, color, and size combinations for quick switching. Presets can be saved and applied using keyboard shortcuts.

```toml
[presets]
slot_count = 5

[presets.slot_1]
name = "Red pen"
tool = "pen"
color = "red"
size = 3.0

```

--------------------------------

### Configure Daemon Mode and Keybinds

Source: https://wayscriber.com/docs/workflows/compositors.html

Set up Wayscriber to run in daemon mode with a toggle keybind. Ensure Hyprland can resolve 'wayscriber' from PATH or use the absolute path. Define the toggle binding only once.

```ini
exec-once = wayscriber --daemon
bind = SUPER, D, exec, wayscriber --daemon-toggle
```

--------------------------------

### Wayscriber Command Line Options

Source: https://wayscriber.com/docs/workflows/compositors.html

Use these commands in your system's custom shortcut settings. 'wayscriber --active' is for one-shot use, while 'wayscriber --daemon-toggle' requires the daemon to be running.

```bash
wayscriber --active
```

```bash
wayscriber --daemon-toggle
```

--------------------------------

### TOML Configuration for Presets

Source: https://wayscriber.com/docs/print.html

This TOML snippet shows how to configure presets in `config.toml`, including the number of slots and the details for a specific preset like 'Red pen'.

```toml
[presets]
slot_count = 5

[presets.slot_1]
name = "Red pen"
tool = "pen"
color = "red"
size = 3.0
```

--------------------------------

### GNOME Fullscreen and Output Targeting

Source: https://wayscriber.com/docs/print.html

Environment variables to control fullscreen behavior and target specific monitors in GNOME. Use FORCE to override opaque fullscreen.

```bash
WAYSCRIBER_XDG_FULLSCREEN=1
```

```bash
WAYSCRIBER_XDG_FULLSCREEN_FORCE=1
```

```bash
WAYSCRIBER_XDG_OUTPUT=<output-name>
```

--------------------------------

### Multi-Monitor Configuration Options

Source: https://wayscriber.com/docs/print.html

Configuration settings for enabling and managing multi-monitor support in Wayscriber. These options control UI alignment and session state per output.

```ini
ui.multi_monitor_enabled = true
```

```ini
ui.active_output_badge = true
```

```ini
session.per_output = true
```

```ini
ui.preferred_output = "eDP-1"
```

--------------------------------

### Run Wayscriber without Tray

Source: https://wayscriber.com/docs/troubleshooting/common.html

If you do not require the system tray, run Wayscriber with the `--no-tray` flag. This can resolve issues related to tray icon visibility or functionality.

```bash
wayscriber --no-tray
```

--------------------------------

### GNOME Fullscreen Environment Variables

Source: https://wayscriber.com/docs/workflows/compositors.html

Control fullscreen behavior in GNOME using environment variables. Set WAYSCRIBER_XDG_FULLSCREEN to enable, or WAYSCRIBER_XDG_FULLSCREEN_FORCE to override opaque rendering. Target specific monitors with WAYSCRIBER_XDG_OUTPUT.

```bash
WAYSCRIBER_XDG_FULLSCREEN=1
```

```bash
WAYSCRIBER_XDG_FULLSCREEN_FORCE=1
```

```bash
WAYSCRIBER_XDG_OUTPUT
```

--------------------------------

### Run Wayscriber with Info Logs

Source: https://wayscriber.com/docs/troubleshooting/logs.html

Enable verbose logging by setting the RUST_LOG environment variable to 'info' before running Wayscriber. This is useful for detailed debugging.

```bash
RUST_LOG=info wayscriber --active
```

--------------------------------

### Add Wayscriber to NixOS Configuration (Flake-based)

Source: https://wayscriber.com/docs/getting-started/installation.html

Integrates Wayscriber into a NixOS system using flakes by adding it to the system packages.

```nix
# flake.nix inputs
inputs.wayscriber.url = "github:devmobasa/wayscriber";

# In configuration
environment.systemPackages = [
  inputs.wayscriber.packages.${pkgs.system}.default
];
```

--------------------------------

### Toggle Wayscriber Daemon

Source: https://wayscriber.com/docs/troubleshooting/common.html

Verify the daemon is running and toggle it using this command. Ensure no duplicate definitions exist for the toggle.

```bash
wayscriber --daemon-toggle
```

--------------------------------

### Run Wayscriber as a Daemon

Source: https://wayscriber.com/docs/concepts/overlay-daemon.html

Run Wayscriber in the background for faster access during presentations. It keeps your drawings between toggles and works well with a keybind.

```bash
wayscriber --daemon
```

--------------------------------

### View Systemd Service Logs

Source: https://wayscriber.com/docs/troubleshooting/logs.html

If Wayscriber is run as a systemd service, use journalctl to follow its logs in real-time. This command is useful for monitoring the service's activity.

```bash
journalctl --user -u wayscriber.service -f
```

--------------------------------

### Locate Wayscriber Config File

Source: https://wayscriber.com/docs/configuration/config-file.html

The configuration file for Wayscriber is located at `~/.config/wayscriber/config.toml`.

```shell
__
~/.config/wayscriber/config.toml
```

--------------------------------

### Check Wayscriber Service Status and Logs

Source: https://wayscriber.com/docs/cli/systemd.html

View the current status of the Wayscriber user service and follow its logs in real-time.

```bash
systemctl --user status wayscriber.service
```

```bash
journalctl --user -u wayscriber.service -f
```

--------------------------------

### Use Absolute Path for Wayscriber

Source: https://wayscriber.com/docs/troubleshooting/common.html

If the shortcut environment cannot find 'wayscriber', use the absolute path obtained from 'command -v'. This ensures the system can locate the executable.

```bash
command -v wayscriber
```

--------------------------------

### Customize Wayscriber Log File Behavior

Source: https://wayscriber.com/docs/troubleshooting/logs.html

Override the default log file path or set a maximum size for log files using environment variables. This allows for more control over log management.

```bash
WAYSCRIBER_LOG_FILE=/path/or/dir
```

```bash
WAYSCRIBER_LOG_MAX_SIZE_MB=10
```

--------------------------------

### Environment Override for Output Name

Source: https://wayscriber.com/docs/print.html

Use an environment variable to override the default output name selection, useful when Wayland compositors assign unexpected names.

```bash
WAYSCRIBER_XDG_OUTPUT=<output-name>
```

--------------------------------

### Restart Wayscriber Service

Source: https://wayscriber.com/docs/cli/systemd.html

Restart the Wayscriber user service if it needs to be reloaded or if it encounters issues.

```bash
systemctl --user restart wayscriber.service
```

--------------------------------

### Wayscriber Log File Location

Source: https://wayscriber.com/docs/troubleshooting/logs.html

When running in daemon or active mode, Wayscriber writes logs to a specific directory. This location follows the XDG_DATA_HOME standard.

```bash
~/.local/share/wayscriber/logs/
```
Tokens:
Raw