b0xx-viewer

A multi-platform B0XX input viewer for your streaming needs

Installation

Grab the latest release on the Releases page for your platform, and run the program from there.

Usage

Windows

Double click on the .exe file.

Passing arguments to a .exe file

If you wish to setup your input viewer (for example) to use the --r1 start flag, disabling B0XX r2 buttons:

Right click on the .exe file, click on "Create shortcut"
On the newly created shortcut, right click, go to "Properties"
Add the desired flags after the full executable path in the "Target" field, like so (due to changes, swap --r2 to --r1):

Linux and macOS

Your user needs to be a member of the dialout group to access the serial ports exposed over USB.

To do so, run one of the following:

sudo usermod -aG dialout `whoami`
sudo gpasswd -a `whoami` dialout

Then download the executable, and launch it through a terminal.

Options

Try launching the executable with --help to get all the current options Note: This will not work on Windows because of platform restrictions

GUI Viewer for B0XX controllers; particularly useful for streaming

Usage: b0xx_viewer.exe [OPTIONS]

Options:
      --init-config
          Intializes an empty configuration in the executable's folder
  -d, --labels
          Enable button labels
      --chromeless
          Makes the window chromeless (i.e. removes window decorations such as titlebar, minimize/close buttons etc)
      --r1
          Enables B0XX r1 mode to remove the 2 extra buttons
      --colored-rims
          Enables an alternative mode of inactive button coloring; Makes inactive button background neutral in favor of button rims instead
      --relax-arduino-detection
          Relaxes B0XX detection to allow any 16MHz Arduino-compatible device to connect
  -c, --config <CONFIG_PATH>
          Sets the configuration file path
  -b, --background <BACKGROUND_COLOR>
          Sets a custom background color in hex format, eg. "#00FF00" [default: #131313]
  -a, --active <BUTTON_ACTIVE_COLORS>
          Sets a custom color for pressed/active buttons in hex format, eg. "#00FF00" [default: #00EBFF]
  -i, --inactive <BUTTON_INACTIVE_COLORS>
          Sets a custom color for inactive buttons in hex format, eg. "#00FF00" [default: #555753]
      --tty <CUSTOM_TTY>
          Provide a custom COM port (Windows-only) or a /dev/ttyXXX path (Unix). Bypasses auto-detection, so proceed at your own risk!
  -h, --help
          Print help
  -V, --version
          Print version

Configuration file

A good example is in cfg/gcc.toml

You can create your own configuration file by launching the program with the --init-config option, then modify it with your favorite text editor!

Building

Prequisites:

Rust
Linux-only: libudev-dev, libxcb-shape0-dev, libxcb-xfixes0-dev

Just cargo build --release and you should be good to go

Fake Inputs Mode / Dev mode

There's a special feature that you can activate when building/running like so:

cargo {run|build} --features fake_inputs [--release]

It'll simulate state reports with completely random ones spaced by 170ms.

Benchmark mode

cargo run --features benchmark [--release]

Starts the project with the fake_serial and fps features to assess current rendering performance.

Enable Windows console for debugging/development

Because Windows is weird, you have a choice between displaying a window without a console, or both everytime (including just double-clicking a .exe file), I had to add a conditional feature to allow you to debug on Windows.

cargo run --features win_console

Enable fps counter

Well, it's a, uh, FPS counter.

cargo run --features fps

License

Licensed under either of these:

Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0
MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

Authors

Mathieu "OtaK_" Amiot
20XX Inc. - Makers of the B0XX

OtaK / b0xx-viewer-rs