sanctum/README.md

Avia Client for Desktop "stoat desktop"

Application for Windows, macOS, and Linux. now with avia client injected

Installation

• If you use the Browser you can find FireFox/Chrome/Userscript Builds at BrowserBuilds.
• Though I reccomend you use Userscript if on Chrome Based Browsers. As Plugins do not exist due to browser limits in Extensions. Userscript fine though

Development Guide

Contribution guidelines for Desktop app TBA!

Before getting started, you'll want to install:

• Git
• Node.js
• pnpm (run corepack enable)

Then proceed to setup:

# clone the repository
git clone --recursive https://github.com/AvaLilac/for-desktop aviaclient-for-desktop

# clone the repository (If you are building from developer branch. Which is not always stable)
git clone -b dev --recursive https://github.com/AvaLilac/for-desktop aviaclient-for-desktop

# CD into the directory
cd aviaclient-for-desktop

# install all packages
pnpm i --frozen-lockfile

# update the assets. if you are using stoat's
git -c submodule."assets".update=checkout submodule update --init assets

# build the bundle
pnpm package

Various useful commands for development testing:

# connect to the development server
pnpm start -- --force-server http://localhost:5173

# test the flatpak (after `make`)
pnpm install:flatpak
pnpm run:flatpak
# ... also connect to dev server like so:
pnpm run:flatpak --force-server http://localhost:5173

# Nix-specific instructions for testing
pnpm package
pnpm run:nix
# ... as before:
pnpm run:nix --force-server=http://localhost:5173
# a better solution would be telling
# Electron Forge where system Electron is

VCSounds.js ships as a built-in local plugin now, so it is seeded automatically on launch and cannot be accidentally removed from the release install.