apachecounterutility

command module
v0.0.0-...-d65b72a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 6, 2020 License: MIT Imports: 10 Imported by: 0

README

Apache's Counter Utility

This utility provides the ability to configure text files with hotkeys to increment, decrement, and reset the counters. Intended use is for OBS or other streaming utilities that allow reading from a text file.

Disclaimer

This program was written fast, probably could use some code organization, and not really optimized at all.

Installation

  1. Download the utility to a folder that is accessible and easily found from the Releases page. Recommended to place it in its own folder.
  2. Run the utility once in order to generate the default config file and text counter files. Initially, quit is bound to Ctrl+Alt+Q
  3. Edit the counters.cfg file in your favorite text editor.
  4. In OBS, add a Text source, and use the "Read From File" option, and add the corresponding counter's text file.

Example Configuration

This is an example configuration:

{
  "Counters": [
    {
      "Prefix": "Deaths: ",
      "Path": "counters/deaths.txt",
      "Hotkeys": {
        "Increase": "Ctrl+Alt+F1",
        "Decrease": "Ctrl+Alt+F2",
        "Reset": "Ctrl+Alt+F10"
      }
    },
    {
      "Prefix": "Apache's Example Counter: ",
      "Path": "C:/ApacheCounterUtility/example.txt",
      "Hotkeys": {
        "Increase": "Ctrl+Alt+F5",
        "Decrease": "Ctrl+Alt+F6",
        "Reset": "Ctrl+Alt+F11"
      }
    }
  ]
}

This has two counters, one who's path is relative to the executable, and the other has an explicit path on the C Drive as an example.

Available Key Modifiers

The current version does not distinguish between Left or Right modifiers. Write Modifiers as the following:

Ctrl+
Alt+
Shift+
Win+
Using Keys

Currently functions using Uppercase chacters, Numbers, and F1 though F22 keys.

Todo: Fix to enable numpad and sytax keys such as punctuations and brackets

Quirks

Hotkeys set seem to take priority over anything else. For example: Setting a hotkey to Ctrl+C or Ctrl+V will prevent you from copy/pastng while the program is active. Attempt to use unique hotkeys.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL