Kartik Scripts

Smart Assistant (Lumen)

Smart Assistant (Lumen)

Lumen is an optional in-home smart assistant. Inside a property that has Lumen installed, players can issue voice or text commands ("turn off the lights") and hear spoken responses.

Configured in shared/assistant.lua (shared) and shared/assistant_server.lua (server-only keys).


Using Lumen

  • Press I (the lumen key mapping) inside a property with Lumen to open the microphone overlay and speak a command.
  • Or type a command directly: /lumen turn off lights.
  • With syncAudio = true, Lumen's spoken reply is broadcast to everyone inside the property.

Installing Lumen

  • Lumen is a per-property upgrade, purchased for Config.SmartAssistant.price ($5,000 by default; set to 0 for free/default-on).

Configuration

Config.SmartAssistant = {
    enabled = true,
    price = 5000,               -- upgrade cost to install Lumen (0 = free)
    syncAudio = true,           -- broadcast replies to all occupants inside
    defaultPersona = 'Lumen',
    defaultLanguage = 'en-US',  -- BCP-47 tag for TTS
    voiceRate = 0.95,           -- TTS speed (0.1–10)
    voicePitch = 1.05,          -- TTS pitch (0–2)
    debug = false,
}

Server-side settings (API keys for speech services, etc.) live in shared/assistant_server.lua and never reach clients.

Lumen uses browser TTS for speech synthesis and a speech-to-text service for the mic overlay. Provide the relevant service key in shared/assistant_server.lua. Set debug = true to print troubleshooting logs to the console.

What Lumen can do

Lumen interprets natural-language commands scoped to the property you're in, for example toggling lights and other in-home controls. Because it's scoped per property, commands only affect the home you're standing in.

On this page