GM-Companion

A tool for the gamemaster of a tabletop RPG session.

Website | Documentation

Credits

• Dice and effect icons by Skoll, Delapouite, Lorc and Cathelineau under the CC BY 3.0
• Default music, sound and radio icons by Marius Masalar, Davin Martin Jr. and Alex Blăjan from Unsplash
• FontAwesome
• FontAwesome QML Implementation fork of FontAwesome.pri by Ben Lau
• o2 (OAuth2 library) by pipacs
• Spotify playlists by Brian Davis (Bezoing) and gentilpuck

Installation

Linux

AppImage

Download 64-bit
The AppImage is built using Ubuntu 16.04 LTS.

You might have to install gstreamer 1.0 otherwise audio cannot be played. For me this version works on Ubuntu but not on Manjaro.

Arch Linux

Install from AUR:

yay -S gm-companion

Ubuntu

Currently your best option is to build from source:
(I am working on a ppa)

Ubuntu 18.10

git clone --recursive https://github.com/PhilInTheGaps/GM-Companion

sudo apt-get install qtbase5-dev qt5-default qttools5-dev qtmultimedia5-dev libqt5opengl5-dev libqt5x11extras5-dev libqt5xmlpatterns5-dev qtdeclarative5-dev libqt5network5 libqt5webengine5 libqt5webenginecore5 libqt5networkauth5-dev libqt5core5a libqt5multimedia5 libqt5multimedia5-plugins libqt5network5 libqt5networkauth5 libqt5opengl5 libqt5script5 libqt5widgets5 libqt5xml5 libqt5xmlpatterns5 libqt5gui5 libqt5qml5 libqt5quick5 qml-module-qtquick-layouts qml-module-qtquick-window2 libqt5quickcontrols2-5 qml-module-qtquick2 qml-module-qtquick-controls libqt5webengine5 libqt5webenginecore5 libqt5multimediaquick5 libqt5quickwidgets5 libpoppler-qt5-dev

cd GM-Companion
qmake
make

run: ./gm-companion
or install:

make install
gm-companion

Ubuntu 18.04

git clone --recursive https://github.com/PhilInTheGaps/GM-Companion

sudo add-apt-repository ppa:beineri/opt-qt-5.12.1-bionic
sudo apt-get update
sudo apt-get install binutils libpulse-dev qt512base qt512declarative qt512graphicaleffects qt512imageformats qt512multimedia qt512networkauth-no-lgpl qt512quickcontrols qt512quickcontrols2 qt512script qt512tools qt512translations qt512webengine libegl1-mesa-dev libglu1-mesa-dev mesa-utils libpoppler-qt5-dev

source /opt/qt512/bin/qt512-env.sh

cd GM-Companion
qmake
make

run: ./gm-companion
or install:

make install
gm-companion

Ubuntu 16.04

git clone --recursive https://github.com/PhilInTheGaps/GM-Companion

sudo add-apt-repository ppa:beineri/opt-qt-5.12.1-xenial
sudo apt-get update
sudo apt-get install binutils libpulse-dev qt512base qt512declarative qt512graphicaleffects qt512imageformats qt512multimedia qt512networkauth-no-lgpl qt512quickcontrols qt512quickcontrols2 qt512script qt512tools qt512translations qt512webengine libegl1-mesa-dev libglu1-mesa-dev mesa-utils libpoppler-qt5-dev

source /opt/qt512/bin/qt512-env.sh

cd GM-Companion
qmake
make

run: ./gm-companion
or install:

make install
gm-companion

Other Distros

1. git clone --recursive https://github.com/PhilInTheGaps/GM-Companion
2. Install Qt5 >=5.10
3. Install Poppler-Qt5
4. Build the program:

cd GM-Companion
qmake
make

run: ./gm-companion
or install:

make install
gm-companion

Windows

Release 1.1.0 (Win x64)

The program works without an installer. Simply extract all the files from the .zip archive to a folder and run gm-companion.exe.

Usage / Quickstart

For detailed instructions see the Documentation.

Audio Tool

• Go to settings, set path of music and sound files
• Open audio editor, create new project
• Add a category and a scenario
• Create an element, add music/sound files, radio playlist file or URL
• Optionally create a thumbnail image, place it in your resources path, add image to element

Spotify

Using Spotify with GM-Companion requires some additional steps first:

• Go to Spotify developer page
• "Create an App"
• In app settings add http://127.0.0.1:59991/ as a redirect URI
• Go to GM-Companion settings, add "Client ID" and "Client Secret" of your app
• Restart GM-Companion
• You can now add Spotify playlists and albums as elements, the "Audio Addon" has some great RPG related playlists. You can add by adding a Spotify element and pressing "Add from Addons"

Note that playing Spotify playlists requires the Spotify app running in the background.

Map Tool

• Open your maps folder (see "Paths" settings)
• Create a new folder
• Place map images inside

Character Tool

• Open your characters folder (see "Paths" settings)
• Create a new folder and name it after the character
• Place images of the character sheet inside

Have fun!