Introduction

The main software component here is the refbox crate. The other crates are support crates that are also used by other binaries, not included here.

Running the Binary

On Windows and Mac the app can be run by downloading the latest relase from GitHub and following the bundled instructions.

Logging

The app will log all events to a folder called uwh-refbox-logs, which will be placed in the appropriate system folder, selected by the directories crate's definition of data_local_dir. The locations will be:

Platform	Value	Example
Linux	$XDG_DATA_HOME or $HOME/.local/share/uwh-refbox-logs	/home/alice/.local/share/uwh-refbox-logs
macOS	$HOME/Library/Application Support/uwh-refbox-logs	/Users/Alice/Library/Application Support/uwh-refbox-logs
Windows	{FOLDERID_LocalAppData}\uwh-refbox-logs	C:\Users\Alice\AppData\Local\uwh-refbox-logs

Running From Source

1. If you are building on Windows, ensure that you have the Visual Studio Build Tools installed, with the "Desktop development with C++" workload selected.
2. Install Rust
3. Ensure that you have the following libraries installed:
   • OpenSSL (libssl-dev package in apt)
   • pkg-config (pkg-config package in apt)
   • Alsa (libasound2-dev package in apt)
4. Go to the refbox folder and cargo run
5. Call the binary with the -h or --help flags to get the usage

Cross Compiling

Builds for cargo targets other than the host target can be compiled using the cross tool:

1. Install Docker and ensure it is running
2. Install cross using cargo install cross
3. Compile the binary using cross build --all --release --target <target>, where <target> is the target you want to compile for:
   • aarch64-unknown-linux-gnu for the Raspberry Pi 4 or 5
   • x86_64-pc-windows-gnu for Windows
   • aarch64-apple-darwin for newer Arm based Macs (M series chips)
   • x86_64-apple-darwin for Intel based Macs
4. The resulting binaries will be in the target/<target>/release folder.

Contributing

Contributions are welcome, just open a PR with your changes. All PRs must pass all tests, must have no clippy warnings, and must pass cargo audit before being merged.