1.0.1 • Published 6 months ago

ambient-kiosk-mode v1.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
6 months ago

Ambient Kiosk Mode

A 'kiosk mode' plugin for Ambient. Designed initially for a raspberry pi as the ambient machine, upon building and running the site, it will open chromium fullscreen in kiosk mode with the app

Usage

// ambient.config.js

import * as KioskMode from "ambient-kiosk-mode";

/** @type {import('./server/types/options.js').Config} */
export default {
  ...,
  plugins: [KioskMode],
  pluginOptions: {
    kiosk: {
      ...
    }
  }
};

Config

KeyTypeDescriptionDefault
platform'pi' | 'mac' | 'auto'Explicitly set the platformauto
piobject
pi.commandstringThe spawned command to run the browser/usr/bin/chromium-browser
pi.argsstring[]The arguments to pass to the browser["--start-maximized", "--kiosk", "--noerrdialogs", "--disable-infobars", "--no-first-run"]
mac.commandstringThe spawned command to run the browser/Applications/Google Chrome.app/Contents/MacOS/Google Chrome
mac.argsstring[]The arguments to pass to the browser[]
1.0.1

6 months ago

1.0.0

6 months ago