2.9 KiB
2.9 KiB
RhemaWave
A Go-based fullscreen SDL2/OpenGL application for Linux kiosk systems. Displays proclamations with audio playback and animated visual patterns.
Development
Development uses Nix for a reproducible build environment.
nix develop # enter dev shell
go build -o bin/rhemawave rhemawave.go # build
./bin/rhemawave # run
./dev_scripts/reset.sh # reset database (if needed)
Prerequisites
- Nix with flakes enabled
- A display server (X11/Wayland) and audio device for running the application
Architecture
- Page-based UI — SDL2/OpenGL 3.3 fullscreen rendering with a page stack for navigation
- Proclamation player — scrolling text display with synchronized audio playback
- Startup validation — WiFi, TOS acceptance, email, license key checks
- Singleton managers — ShaderManager, FontManager, Logger (initialized once via
sync.Once)
Key Directories
bin/ # build output (gitignored)
share/rhemawave/ # assets (fonts, shaders, proclamations, TOS)
internal/ # Go source packages
packaging/ # deployment configs (kiosk, updater, polkit)
dev_scripts/ # developer utilities
Runtime Data
Stored in ~/.local/share/rhemawave/:
data.db— SQLite database (config, proclamations, logs)log.txt— application loglicense_key— license key file
Development Rules
These rules must be followed during the development of RhemaWave to retain a maintainable application.
- The Application package is soley responsible for managing the database handler, and the
configuration cache. Internal packages may update the configuration within the database, and
then signal the application to refresh the cache via a callback function
refreshCache().
Deployment
Deployed to kiosk hardware via NixOS.
Notes
Deployment Pipeline
A manual walkthough of deploying Radiant Wave updates. For reference later when writing automated actions.
- Create a new branch for issue being worked on
- Perform work
- Merge to dev when done
- Build dev with
nix buildto verify no errors - Checkout KioskConfig dev
- Update rhemawave-dev with
nix flake update rhemawave-dev - Build rhemawavekiosk-dev virtual machine
- Test virtual machine for problems
- Build dev-iso
- Install dev-iso to a machine and check for problems
- Checkout
main - Merge
dev nix flake update rhemawave- Build virtual machine
- Build iso image
- Build commercial virtual machine
- Build commercial iso image
- Build Raspberry Pi img
- Approve all virtual machines and iso images
- Approve all machines update on their own
- Rename all iso image to "radiantwavekiosk-iso-{system}-{MM-DD-YYYY}-{radiantwave-git-hash}.iso"
- Upload iso images to file server
- Move old iso images to
archives/on the fileserver