nuhxboard 0.3.2

A Linux port of NohBoard
nuhxboard-0.3.2 is not a library.

NuhxBoard

Crates.io Version Crates.io License Crates.io Total Downloads

Contents

  1. Goals
  2. Usage
  3. Installation

Goals

Nohboard is great! But it's only for Windows. The only alternative is Tiyenti's KBDisplay, which is really great, but limited in functionality. My primary goal with this project is to replicate the functionality of NohBoard in a Linux-compatible manner. More specifically, I want to be able to feed in any NohBoard config file and have near-identical output to NohBoard.

I may add functionality where I think it would fit, but I want to prioritize interoperability with NohBoard. Call it just another incentive for gamers to switch to Linux.

Usage

Right now, NuhxBoard has to be launched from the command line. In a future release, I plan on porting the graphical interface present in NohBoard. Launch arguments are used to decide the keyboard and style. This means that the app has to be relaunched to change the keyboard or style.

To specify a keyboard layout, provide the group and the keyboard name in the --keyboard argument, in the format [GROUP]/[KEYBOARD]. To specify a style, just provide the name of the style in the --style argument.

Here's the output of the --help command:

NuhxBoard - The cross-platform alternative to NohBoard

Usage: nuhxboard [OPTIONS] --keyboard <KEYBOARD>

Options:
  -k, --keyboard <KEYBOARD>  The keyboard to use. [GROUP]/[KEYBOARD]
  -s, --style <STYLE>        The style to use. Must be in the same directory as the provided keyboard. If not provided, global default will be used
  -l, --list                 List available keyboard groups or keyboards in a group specified by `--keyboard`
  -h, --help                 Print help
  -V, --version              Print version

Add keyboard groups to ~/.local/share/NuhxBoard/keyboards/

God, I love clap.

Installation

NuhxBoard is currently only on crates.io. It can also be installed with cargo-binstall. If you use Linux and either install without binstall or build from source, you will need the libxi-dev and lib-xtst packages installed. You can also install NuhxBoard using the option matching your platform on the latest release page.