Skip to content

App Manifest

Every SkyScript app requires a manifest.yaml file in its root folder. This file defines metadata and behavior for the app.

Example

yaml
name: My App
hide_addressbar: true
framerate: 20

Fields

FieldTypeDefaultDescription
namestringfolder nameDisplay name shown in the Plugins menu.
urlstringURL to load. If omitted, SkyScript loads the local index.html. Alias: homepage.
hide_addressbarbooleanfalseHide the built-in address bar. Recommended for apps that provide their own navigation.
audio_mutedbooleanfalseMute all audio from this app's browser.
framerateinteger25CEF rendering frame rate (FPS). Lower values reduce CPU usage.
minimum_widthinteger0Minimum window width in pixels. 0 means no minimum.
scroll_speedinteger5Scroll sensitivity multiplier.
user_agentstring(default Chrome UA)Custom User-Agent header sent with every request.
forced_languagestring(auto-detected)Override the browser language. Format: en-US,en or fr-FR,fr.
widthinteger1024Initial window width in pixels.
heightinteger768Initial window height in pixels.
console_loggingbooleantrueForward console.log/warn/error to X-Plane's Log.txt. Set to false for noisy apps.
defaultbooleanfalseDefault apps appear after a separator in the menu. Used for built-in apps like "About SkyScript".

Minimal Manifests

Local app (with index.html)

yaml
name: My App

URL-only app (no build step)

yaml
name: Navigraph Charts
url: https://charts.navigraph.com
hide_addressbar: true

A URL-only app needs only manifest.yaml — no package.json, no build step, no index.html.

How Apps Are Discovered

On aircraft load (or when Reload configuration is triggered), SkyScript scans the apps/ directory inside the plugin folder. Each subfolder containing a manifest.yaml is registered as an app.

The app's ID is derived from the folder name, prefixed with app-. For example:

FolderApp ID
apps/hello-world/app-hello-world
apps/navigraph/app-navigraph

This ID is used in dataref and command paths (e.g. skyscript/app-hello-world/toggle).

Released under the GPL-3.0 License.