Files
Omarchy-Stream/install.sh
Levi Woodard 171ade4ff1 Add headless streaming mode + Mac client + full docs
Headless mode (new) — for KVM-attached hosts streaming to disconnected clients
- --headless / --mirror flags; default headless on hostname JARVIS, mirror elsewhere
- New lib/headless.sh installs prep-cmd hooks to ~/.local/share/omarchy-moonlight/bin
- bin/sunshine-stream-do.sh creates/resizes a Hyprland HEADLESS-1 output to the
  connecting client's resolution and migrates the active workspace onto it
- bin/sunshine-stream-undo.sh tears down the headless output on disconnect and
  returns the workspace to a non-headless monitor when one is available
- lib/config.sh writes capture=wlr, output_name=HEADLESS-1, and the JSON
  global_prep_cmd entry referencing the installed hook paths
- lib/preflight.sh adds a preflight_headless step that checks hyprctl, jq, and
  a running Hyprland session (warn-only, install can proceed)
- lib/verify.sh adds checks for the hook scripts and the wlr/global_prep_cmd
  config lines

Mac client
- client/install-macos.sh: Darwin guard, Homebrew presence check, brew cask
  install of Moonlight, idempotent
- client/README.md: per-platform install (macOS / Android / iOS / Apple TV /
  Linux + Steam Deck) and the five-step first-pair walkthrough

Other
- jq added to the helper install set in lib/packages.sh (hooks parse Hyprland
  JSON output)
- README.md rewritten to cover both modes, the new flags, the tuned defaults
  per mode + per vendor, the headless internals, and the client pointer
2026-05-18 10:31:08 -06:00

194 lines
5.6 KiB
Bash
Executable File

#!/usr/bin/env bash
# omarchy-moonlight installer
# Sets up Sunshine (host) + Moonlight (client) on Omarchy/Hyprland/Wayland.
# Idempotent: re-run safely. Same script works on NVIDIA and AMD machines.
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=lib/common.sh
source "$SCRIPT_DIR/lib/common.sh"
# shellcheck source=lib/detect.sh
source "$SCRIPT_DIR/lib/detect.sh"
# shellcheck source=lib/preflight.sh
source "$SCRIPT_DIR/lib/preflight.sh"
# shellcheck source=lib/packages.sh
source "$SCRIPT_DIR/lib/packages.sh"
# shellcheck source=lib/permissions.sh
source "$SCRIPT_DIR/lib/permissions.sh"
# shellcheck source=lib/config.sh
source "$SCRIPT_DIR/lib/config.sh"
# shellcheck source=lib/firewall.sh
source "$SCRIPT_DIR/lib/firewall.sh"
# shellcheck source=lib/service.sh
source "$SCRIPT_DIR/lib/service.sh"
# shellcheck source=lib/verify.sh
source "$SCRIPT_DIR/lib/verify.sh"
# shellcheck source=lib/headless.sh
source "$SCRIPT_DIR/lib/headless.sh"
usage() {
cat <<EOF
Usage: $(basename "$0") [options]
Installs Sunshine + Moonlight on an Omarchy machine.
Options:
--no-autostart Don't enable user service or lingering (manual start only)
--no-firewall Skip firewall configuration
--no-moonlight Don't install moonlight-qt (host-only setup)
--no-sunshine Don't install sunshine (client-only setup)
--no-config Don't write a tuned sunshine.conf
--from-source Build Sunshine from source (equivalent to SUNSHINE_PKG=sunshine)
--headless Force headless streaming mode (wlr capture of HEADLESS-1)
--mirror Force mirror mode (KMS capture of the real display)
--doctor Run only the post-install verification checks
-h, --help Show this help
Environment overrides:
SUNSHINE_PKG AUR package to use for Sunshine (default: sunshine-bin)
Set to 'sunshine' to build from source instead.
EOF
}
AUTOSTART=1
FIREWALL=1
INSTALL_SUNSHINE=1
INSTALL_MOONLIGHT=1
WRITE_CONFIG=1
DOCTOR_ONLY=0
MODE_OVERRIDE=""
while [[ $# -gt 0 ]]; do
case "$1" in
--no-autostart) AUTOSTART=0 ;;
--no-firewall) FIREWALL=0 ;;
--no-moonlight) INSTALL_MOONLIGHT=0 ;;
--no-sunshine) INSTALL_SUNSHINE=0 ;;
--no-config) WRITE_CONFIG=0 ;;
--from-source) export SUNSHINE_PKG=sunshine ;;
--headless) MODE_OVERRIDE="headless" ;;
--mirror) MODE_OVERRIDE="mirror" ;;
--doctor) DOCTOR_ONLY=1 ;;
-h|--help) usage; exit 0 ;;
*) err "Unknown option: $1"; usage; exit 2 ;;
esac
shift
done
# Pick streaming mode: explicit flag wins; otherwise default to headless on
# JARVIS (the KVM-attached primary target) and mirror everywhere else.
compute_stream_mode() {
if [[ -n "$MODE_OVERRIDE" ]]; then
STREAM_MODE="$MODE_OVERRIDE"
return 0
fi
local host_lc="${HOSTNAME_SHORT,,}"
if [[ "$host_lc" == "jarvis" ]]; then
STREAM_MODE="headless"
else
STREAM_MODE="mirror"
fi
}
main() {
require_not_root
require_arch
require_yay
step "Detecting system"
detect_all
compute_stream_mode
export STREAM_MODE
info "Host: $HOSTNAME_SHORT GPU: $GPU_VENDOR Session: $SESSION_TYPE"
info "Mode: $STREAM_MODE"
if [[ $DOCTOR_ONLY -eq 1 ]]; then
verify_install
exit $(( VERIFY_FAILURES > 0 ? 1 : 0 ))
fi
step "Preflight checks"
preflight_all
if [[ $INSTALL_SUNSHINE -eq 1 ]]; then
step "Installing Sunshine and GPU encoder support"
install_sunshine
install_gpu_encoder_packages
step "Configuring permissions for KMS capture and virtual input"
ensure_input_group
ensure_uinput_udev_rule
set_sunshine_capabilities
if [[ "$STREAM_MODE" == "headless" ]]; then
step "Installing headless prep-cmd hooks"
install_headless_hooks
fi
if [[ $WRITE_CONFIG -eq 1 ]]; then
step "Writing tuned sunshine.conf"
write_sunshine_config "$STREAM_MODE"
else
info "Skipping sunshine.conf (--no-config)"
fi
if [[ $FIREWALL -eq 1 ]]; then
step "Configuring firewall for Sunshine ports"
open_sunshine_ports
else
info "Skipping firewall (--no-firewall)"
fi
if [[ $AUTOSTART -eq 1 ]]; then
step "Enabling Sunshine user service"
enable_sunshine_service
else
info "Skipping autostart (--no-autostart). Start manually with: systemctl --user start sunshine"
fi
else
info "Skipping Sunshine install (--no-sunshine)"
fi
if [[ $INSTALL_MOONLIGHT -eq 1 ]]; then
step "Installing Moonlight client"
install_moonlight
else
info "Skipping Moonlight install (--no-moonlight)"
fi
if [[ $INSTALL_SUNSHINE -eq 1 ]]; then
verify_install
fi
step "Done"
print_next_steps
}
print_next_steps() {
local ip
ip="$(ip -4 -o addr show scope global | awk '{print $4}' | cut -d/ -f1 | head -n1)"
cat <<EOF
${BOLD}Next steps:${RESET}
1. ${BOLD}Re-login${RESET} (or run ${DIM}newgrp input${RESET}) if you weren't already in the 'input' group.
This is required for Sunshine to access /dev/uinput.
2. Open Sunshine's web UI to set credentials and pair clients:
${BOLD}https://localhost:47990${RESET}
(Self-signed cert — accept the browser warning.)
3. On a Moonlight client (this machine, the Framework, or your Mac):
- Add this host by IP: ${BOLD}${ip:-<your-lan-ip>}${RESET}
- Enter the 4-digit PIN that Sunshine's UI shows during pairing.
4. To check status: ${DIM}systemctl --user status sunshine${RESET}
To view logs: ${DIM}journalctl --user -u sunshine -f${RESET}
To uninstall: ${DIM}$SCRIPT_DIR/uninstall.sh${RESET}
EOF
}
main "$@"