Low-level hotkey daemon for Windows
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jake Wakeling b09957774a Fix LICENCE year 5 months ago
build Implement basic global hotkey support with mod keys 5 months ago
doc Add keycode documentation 5 months ago
include Implement TOML config, Implement command line options, Minor refactoring 5 months ago
src Update default config 5 months ago
.gitignore Implement basic global hotkey support with mod keys 5 months ago
CMakeLists.txt Implement TOML config, Implement command line options, Minor refactoring 5 months ago
LICENCE Fix LICENCE year 5 months ago
README.md Update README 5 months ago

README.md

BigCork

Low-level hotkey daemon for Windows

BigCork is a low-level hotkey daemon for Windows written in C++.

Build Instructions

BigCork uses CMake to build.
Binaries will be located in the bin directory.

Windows Build

Run CMAKE_WIN64.bat in the build directory.

Usage

If no command line arguments are given, BigCork will look for a config file %APPDATA%/BigCork/bigcork.toml, the -c <config> argument can be given to specify config location, and the -p argument can be given to run BigCork in portable mode (config file in executable directory).

If no config file exists, a default config file will be created.

Keybinds can be added in the following format:

[[keybind]]
execute = <Command or executable>
key     = <Keybind>
mod     = <Modifier>

For example:

# Run Explorer when SUPER + RETURN is pressed
[[keybind]]
execute = "explorer"
key     = "RETURN"
mod     = "SUPER"

# Run Explorer when SUPER + R is pressed
[[keybind]]
execute = "C:/Windows/explorer.exe"
key     = "R"
mod     = "SUPER"

To install BigCork as a startup application for your user:

  1. Navigate to %APPDATA%/Microsoft/Windows/Start Menu/Programs/Start-up/.
  2. Copy BigCork.exe into this Start-up directory.

To stop BigCork from starting automatically, remove BigCork.exe from the Start-up directory.

Notes:

  • See doc/keycodes.txt for supported key codes.
  • Default Windows keybinds can be overridden.
  • Currently BigCork can only be closed by killing it, once started it will run invisibly in the background.

Meta

Copyright (C) 2020, Jakob Wakeling
All rights reserved.
OMKOV Open Source Licence