QuestScreen

README

QuestScreen

QuestScreen is a utility for displaying information during pen & paper roleplaying sessions. It renders information via SDL, you control it via web interface. It is designed to be run on boards like the Raspberry Pi.

Compilation

Dependencies that need to be installed manually (go.mod takes care of required Go modules):

• Go 1.12 or later

• SDL2, SDL2_image, SDL2_ttf

  If you want to run QuestScreen without a window manager, make sure that you enable SDL's kmsdrm support (--enable-video-kmsdrm). If you want to use input with kmsdrm, make sure to link against libudev.

• go-bindata

  Install with go get github.com/go-bindata/go-bindata/.... This is used for including web-related files (html, css, js) in the binary. Since this is a compile-time only dependency, it is not listed in go.mod.

• git

  Used to autogenerate the current version string when building. This requires any build to happen from within a git repository.

Compile with make, install with make install.

Detailed instructions are available for:

• Raspberry Pi
• macOS

Documentation

For user documentation, please see the project's website.

License

This app is licensed under the terms of the GNU GPL v3.

Note that the plugin API is a separate module licensed under the MIT license so that plugins need not conform to the GNU GPL.