Skip to content

Latest commit

 

History

History
56 lines (45 loc) · 2.01 KB

README.md

File metadata and controls

56 lines (45 loc) · 2.01 KB

SimpleDeathCounter

Linux Showcase

A dead simple, streamer-controlled OBS death counter for Windows and Linux

This app simply provides a global keyboard shortcut which is used to increase a number inside a text file which OBS shows with the Text source's "Read from file" option.

Therefore, setup is very easy:

  • Run the app
  • Create a Text source in OBS
  • Check "Read from file"
  • Select "deaths.txt" in %AppData%\simple-death-counter\ on Windows, or ~/.config/simple-death-counter/ on Linux.

NOTE: This location isn't implemented yet, right now it's in the bin/ folder where the app is installed. Because of this, make sure to install the app where it has permission to write - e.g. your Documents folder.

OBS Showcase Windows Showcase

More details

Written in C++ using the Qt 5 Framework, this app provides an exceedingly lightweight and native experience on both Windows and Linux. It uses the amazing QHotkey by Skycoder42.

Linux note: Unfortunately this app doesn't support global hotkeys on Wayland due to the protocol's immaturity in this area. However, work on this seems to be progressing.

This is also, perhaps obviously if you look at the code, a project I used to learn C++ and Qt. Because of this, there may be bugs and inefficiencies - sorry!

Building

I've only tested building on Linux - my CMake config may not work for other platforms.

CMake

$ mkdir build
$ cd build
$ cmake -B . -S ../
$ cmake --build .

Then to package (NSIS using MINGW, tar.xz using Linux) (optional):

$ cpack -C CPackConfig.cmake

Licensing

Project License
SimpleDeathCounter GPL-3.0
Qt 5 LGPL-3.0
QHotkey BSD-3-Clause