Skip to content

RetroZelda/pqcli-stream

 
 

Repository files navigation

pqcli-stream

A headless setup for streaming Progress Quest to Twitch. Without a monitor.

Usage

  1. Clone this repo
  2. Clone and run pqcli once and create a new character
  3. Copy your save.dat file(usually found in ~/.config/pqcli) to the ./initial-save-data folder, although a default one is provided
  4. Add your Twitch stream key to compose.yaml
  5. Optionally, you may set a server to use
  6. Optionally, change what saved character to run(defaults to 1)
  7. Optionally, change what colors will be displayed
  8. Run docker compose up

Optionally you can use the included systemd service

ALso, you can add music to a ./music folder to have it play Save games can be recoverd from the docker volumes (e.g. located here: /var/lib/docker/volumes/pqcli-stream_pqcli-saves)

How does this work?

It's a bit complicated to explain so I'll break down the main components:

  • a fake monitor is created by xvfb
  • a terminal is emulated with xterm
  • a live stream is handled by ffmpeg
  • finally, pqcli is the star of the show

If you're interested in the original (but outdated) Reddit post, visit the wiki.

Notes

Originally forked from asciiquarium-stream

About

A headless setup for streaming Progress Quest to Twitch.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 65.2%
  • Dockerfile 34.8%