Brigadeiro

Brigadeiro Player written with the libcosmic toolkit.

Installation

A justfile is included by default for the casey/just command runner.

• just builds the application with the default just build-release recipe
• just run builds and runs the application
• just install installs the project into the system
• just vendor creates a vendored tarball
• just build-vendored compiles with vendored dependencies from that tarball
• just check runs clippy on the project to check for linter warnings
• just check-json can be used by IDEs that support LSP

Translators

Fluent is used for localization of the software. Fluent's translation files are found in the i18n directory. New translations may copy the English (en) localization of the project, rename en to the desired ISO 639-1 language code, and then translations can be provided for each message identifier. If no translation is necessary, the message may be omitted.

Packaging

If packaging for a Linux distribution, vendor dependencies locally with the vendor rule, and build with the vendored sources using the build-vendored rule. When installing files, use the rootdir and prefix variables to change installation paths.

just vendor
just build-vendored
just rootdir=debian/brigadeiro prefix=/usr install

It is recommended to build a source tarball with the vendored dependencies, which can typically be done by running just vendor on the host system before it enters the build environment.

Stack

Framework & UI

• libcosmic - COSMIC™ framework for Linux desktop
• Features: a11y, about, dbus-config, multi-window, single-instance, tokio, winit, wayland, wgpu, xdg-portal

Audio

• rodio v0.21 - Playback engine with Symphonia
• Supports: MP3, MP4, FLAC, WAV, OGG, Opus ...

Processing

• lofty v0.22.4 - Audio metadata reading
• image v0.25.9 - Image processing for blurring
• auto-palette v0.9.2 - Color extraction

Internationalization

• i18n-embed v0.16 - Framework with Fluent
• i18n-embed-fl v0.10
• Support for Portuguese (pt-BR) and English (en)

Developers

Developers should install rustup and configure their editor to use rust-analyzer. To improve compilation times, disable LTO in the release profile, install the mold linker, and configure sccache for use with Rust. The mold linker will only improve link times if LTO is disabled.