89 lines
2.9 KiB
Markdown
89 lines
2.9 KiB
Markdown
# 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.
|
|
|
|
```bash
|
|
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 log
|
|
- `license_key` — license key file
|
|
|
|
### Development Rules
|
|
|
|
These rules must be followed during the development of RhemaWave to retain a
|
|
maintainable application.
|
|
|
|
1. 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.
|
|
|
|
1. Create a new branch for issue being worked on
|
|
2. Perform work
|
|
3. Merge to dev when done
|
|
4. Build dev with `nix build` to verify no errors
|
|
5. Checkout KioskConfig dev
|
|
6. Update rhemawave-dev with `nix flake update rhemawave-dev`
|
|
7. Build rhemawavekiosk-dev virtual machine
|
|
8. Test virtual machine for problems
|
|
9. Build dev-iso
|
|
10. Install dev-iso to a machine and check for problems
|
|
11. Checkout `main`
|
|
12. Merge `dev`
|
|
13. `nix flake update rhemawave`
|
|
14. Build virtual machine
|
|
15. Build iso image
|
|
16. Build commercial virtual machine
|
|
17. Build commercial iso image
|
|
18. Build Raspberry Pi img
|
|
19. Approve all virtual machines and iso images
|
|
20. Approve all machines update on their own
|
|
21. Rename all iso image to "radiantwavekiosk-iso-{system}-{MM-DD-YYYY}-{radiantwave-git-hash}.iso"
|
|
22. Upload iso images to file server
|
|
23. Move old iso images to `archives/` on the fileserver
|