glyx.config.ts

import { defineConfig } from '@glyx-dev/config'
 
export default defineConfig({
  // ... all fields
})

name?: string

version?: string

engine?: 'v8' | 'quickjs'

export default defineConfig({
  engine: 'quickjs',
})

app?: {
  publisher?:   string   // Company or author name shown in installer and OS app listings
  description?: string   // Short description of the app
  website?:     string   // App website URL, e.g. 'https://myapp.com'
  license?:     string   // Path to a license file, e.g. 'LICENSE.txt' — copied into the install directory
}

icon?: string

locales?: string[]

locales: ['en', 'de', 'ja'],

window?: {
  title?:       string
  width?:       number         // Default: 1280
  height?:      number         // Default: 800
  startupMode?: 'windowed' | 'maximized' | 'fullscreen'
  decorations?: boolean        // OS title bar (default: true). false = frameless window
  resizable?:   boolean        // User can resize the window (default: true). false = fixed size
  background?:  string         // GPU clear color before first JS frame: '#rrggbb' or '#rrggbbaa'
  renderMode?:  'auto' | 'gpu' | 'cpu' | 'skia' | 'direct2d'  // Rendering backend (default: 'auto')
  maxJsHeapMb?: number         // V8 heap cap in MB, 24–512 (default: auto — see below)
  preventDuplicateWindows?: boolean  // glyxWindow.create with an open title focuses it instead (default: false)
}

window: {
  background: '#1e1e2e',   // matches dark root background
}

window: {
  decorations: false,
}

window: {
  width:      320,
  height:     480,
  resizable:  false,
}

window: {
  maxJsHeapMb: 64,  // explicit cap — overrides auto-calculation
}

window: {
  preventDuplicateWindows: true,
}

capabilities?: {
  // File system
  fs?:           { read?: string[]; write?: string[]; delete?: string[] }
 
  // Network
  network?:      { allow?: string[] }      // origin allowlist
 
  // Environment variables
  env?:          { allow?: string[] }      // variable name allowlist
 
  // Deep linking
  deeplink?:     { scheme: string; singleInstance?: boolean }
 
  // Simple toggles
  db?:           boolean    // SQLite
  dialog?:       boolean    // file/folder picker dialogs
  clipboard?:    boolean    // read/write clipboard
  notification?: boolean    // desktop notifications
  tray?: boolean             // system tray icons
  battery?:      boolean    // battery status
  usb?:          boolean    // USB device enumeration
  shell?:        boolean    // open external URLs via openExternal (shell.exec planned)
  mdns?:         boolean    // mDNS service discovery
  system?:       boolean    // OS info, displays, memory
  power?:        boolean    // sleep/wake events
  storage?:      boolean    // app data directory access
  gamepads?:     boolean    // gamepad/controller input
  globalShortcuts?: boolean // OS-level keyboard shortcuts
  credentials?:  boolean    // OS keychain (DPAPI/Keychain/Secret Service)
  audio?:        boolean    // audio playback
  video?:        boolean    // video playback
  camera?:       boolean    // camera capture
  microphone?:   boolean    // microphone recording
  ai?:           boolean    // local AI (embed, generate, transcribe)
  hid?:          boolean    // HID device access
  updater?:      boolean    // auto-updater
  crash?:        boolean    // crash reporting
}

capabilities: {
  fs: {
    read:   ['**'],             // read anywhere
    write:  ['documents/**'],   // write only under documents/
    delete: ['documents/trash/**'], // delete only under trash/
  },
}

capabilities: {
  deeplink: {
    scheme:          'myapp',  // handles myapp:// URLs
    singleInstance:  true,     // focus existing window instead of opening a new one
  },
}

dev?: {
  entry?:  string    // JS entry point (default: 'src/app.jsx')
  output?: string    // Compiled bundle path (default: 'dist/app.js')
  watch?:  string[]  // Directories to watch for HMR (default: ['src'])
}

splash?: {
  image?:      string   // Path to a PNG image, centered on the splash background
  background?: string   // Hex color, e.g. '#1e1e2e'. Defaults to black
  minimumMs?:  number   // Minimum display time before hideSplash() takes effect
  imageScale?: number   // Max fraction of the smaller window dimension `image` may fill (default 0.5)
}

import { glyxWindow } from '@glyx-dev/react'
 
// After your data loads:
glyxWindow.hideSplash()

updater?: {
  owner:   string   // GitHub organization or username
  repo:    string   // Repository name
  binName: string   // Release asset filename prefix — matches `{binName}-{platform}`,
                     // exactly what `glyx package` produces
}

{
  "capabilities": { "updater": true },
  "updater": {
    "owner":   "acme-inc",
    "repo":    "my-app",
    "binName": "my-app"
  }
}

plugins?: Array<{
  entry:          string    // Path to the plugin JS entry point (bundled at startup)
  name?:          string    // Optional namespace prefix for the plugin's commands
  capabilities?:  string[]  // Capabilities the plugin requires
}>

plugins: [
  { entry: 'plugins/storage.js', name: 'storage' },
  { entry: 'plugins/analytics.js', name: 'analytics' },
]

packageManager?: 'npm' | 'pnpm' | 'yarn' | 'bun'

import { defineConfig } from '@glyx-dev/config'
 
export default defineConfig({
  name:    'my-notes',
  version: '1.0.0',
  // engine: 'quickjs',  // uncomment for a smaller, no-JIT build (default: 'v8')
 
  app: {
    publisher:   'Acme Corp',
    description: 'A fast, native notes app.',
    website:     'https://myapp.com',
    license:     'LICENSE.txt',
  },
 
  icon: 'assets/icon.png',
 
  locales: ['en'],
 
  window: {
    title:       'My Notes',
    width:       1200,
    height:      800,
    startupMode: 'windowed',
    background:  '#171923',
    decorations: true,
    resizable:   true,
    renderMode:  'auto',
    // maxJsHeapMb: 64,   // uncomment to override the auto-calculated heap cap
  },
 
  capabilities: {
    fs:           { read: ['**'], write: ['documents/**'], delete: ['documents/trash/**'] },
    network:      { allow: ['https://api.myservice.com'] },
    db:           true,
    dialog:       true,
    clipboard:    true,
    notification: true,
    credentials:  true,
    crash:        true,
    deeplink:     { scheme: 'mynotes', singleInstance: true },
  },
 
  dev: {
    entry:  'src/app.jsx',
    output: 'dist/app.js',
    watch:  ['src'],
  },
 
  splash: {
    background: '#171923',
    minimumMs:  800,
  },
})