Skip to content

About

A simple GUI to control your Luxafor Flag

Topics

Resources

Stars

8 stars

Watchers

1 watching

Forks

Repository files navigation

Luxafor-ui

Luxafor-ui in dark mode


Getting started

Installation

Automatic installer (Debian/Ubuntu)

curl -fsSL https://nibrobb.dev/luxafor-ui.sh | sh

Install with cargo-binstall

Ensure you have cargo-binstall installed, if not, install with

cargo install cargo-binstall

Then, install Luxafor-ui with

cargo binstall luxafor-ui --git https://github.com/nibrobb/luxafor-ui

Manual install

Go to Releases, expand 'Assets', then choose the distribution that is right for your system. The .tgz files are gzipped pre-built binaries for GNU/Linux and Windows, build on GitHub Actions using ubuntu-latest and windows-latest.

Slack integration

Control your busylight directly from Slack!

Open the system tray icon for Luxafor-ui, then select Add to Slack. A browser window should open, and you are redirected to https://nibrobb.dev where an OAuth 2.0 flow happens, upon successful authentication you are sent back to Luxafor-ui and should have the app installed in your Slack workspace. Change your status and see what happens

Note

Luxafor-ui must be running when adding to slack since the local app stores the users access tokens

Post-install

Really only relevant for versions of Luxafor-ui < v0.1.0-alpha.2 and distros not supporting .deb or .rpm packages See POST-INSTALL.md

Build it yourself

Get your Tauri prerequisites in order first

Dependencies (Debian/Ubuntu or others)

Automatically install required packages

sudo apt install $(grep -vE "^\s*#" required-packages.apt | tr "\n" " ")

NixOS

Use included shell.nix (will need tweaking)

Good luck.

Common steps

Install the Tauri command line interface tauri-cli, the wasm-bundler trunk and the wasm32 target

Add the wasm32 build target

rustup target add wasm32-unknown-unknown

If on Apple Silicon (M1 or up), install tauri-cli and trunk from cargo directly.

cargo install --locked --version "^2.0" tauri-cli
cargo install --locked --no-default-features --features update_check,rustls trunk

Pro-tip: Consider using installing tauri-cli and trunk from binstall (not suitable for Apple M1 and up)

cargo install cargo-binstall
cargo binstall tauri-cli@^2 trunk

Build/bundle

Launch the app in development mode

cargo tauri dev

Build an executable without bundling

cargo tauri build --no-bundle

Build a .deb file for local installation

cargo tauri build --bundles deb

Build bundles and binaries for distribution depending no your system

cargo tauri build

Recommended IDE Setup

VS Code + Tauri + rust-analyzer

References

Setting up trunk to not use native Open SSL (which is a pain in the ass to set up)

Inspiration and udev rules borrowed from

Luxafor library in rust

Binstall

Built with Tauri and Leptos, bundled with Trunk

About

A simple GUI to control your Luxafor Flag

Topics

Resources

Stars

8 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages