Skip to content

OtaK/b0xx-viewer-rs

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
cfg
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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 --r2 start flag, enabling 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:

Properties Dialog

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

b0xx_viewer 0.6.0
Mathieu Amiot <amiot.mathieu@gmail.com>
GUI Viewer for B0XX controllers; particularly useful for streaming

USAGE:
    b0xx_viewer [FLAGS] [OPTIONS]

FLAGS:
        --chromeless                 Makes the window chromeless
        --colored_rims               Enables an alternative mode of inactive button coloring; Makes inactive button
                                     background neutral in favor of button rims instead.
    -h, --help                       Prints help information
        --init_config                Intializes an empty configuration in the executable's folder
    -l, --labels                     Enable button labels
        --r2                         Enables B0XX r2 mode to account for the 2 extra buttons
        --relax_arduino_detection    Relaxes B0XX detection to allow any 16MHz Arduino-compatible device to connect
    -V, --version                    Prints version information

OPTIONS:
    -b, --background <bg_color>            Sets a custom background color in hex format, eg. "#00FF00"
    -a, --active <btn_active_color>        Sets a custom color for pressed/active buttons in hex format, eg. "#00FF00"
    -i, --inactive <btn_inactive_color>    Sets a custom color for inactive buttons in hex format, eg. "#00FF00"
    -c, --config <config>                  Sets the configuration file path
        --tty <tty>                        Provide a custom COM port (Windows-only) or a /dev/ttyXXX path (Unix).
                                           Bypasses auto-detection, so proceed at your own risk!

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 Serial Mode / Dev mode

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

cargo {run|build} --features fake_serial [--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:

Authors

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