Skip to content

What is ScriptedScreens? ​

ScriptedScreens is a companion mod for StationeersLua that enables custom touchscreen user interfaces on Stationeers computer consoles, tablets, and programmable visors. Build interactive dashboards, monitoring displays, control panels, HUD overlays, and even games - all rendered directly in-game using Lua scripts.

Features ​

  • Declarative UI System — Define UIs using simple Lua tables with element types, positions, and styles
  • Rich Element Library — Labels, buttons, checkboxes, sliders, progress bars, panels, scroll views, icons, and more
  • Data Visualization — Sparklines, bar charts, line charts, gauges, and sortable tables with live update support
  • Touch & Keyboard Input — Interactive elements with click, change, and toggle events; full keyboard capture in Interface Mode
  • Canvas Drawing — Pixel-level rendering for custom graphics, games, and visualizations
  • 60fps Rendering — Optional on_frame callbacks for smooth animations and games
  • Multiple Surfaces — Maintain multiple named UI views per physical screen and switch between them
  • Layout Helpers — Grid, flex, and nested layout systems for responsive UIs without manual pixel math
  • Image & Media — Display remote images (PNG, JPG, animated GIF), stream video with spatial audio
  • Sound Playback — Play built-in game sounds, announcements, and remote audio with 3D spatial positioning
  • Tablet Support — Cartridges with target detection and wireless data network access
  • Programmable Visor HUDs - Build wearer-tied HUD overlays with ss.hud, including draggable panels and canvas mini-games
  • Multiplayer Compatible — UI state synced across all connected clients
  • Save/Load Persistence — Board UI snapshots persisted across world saves

How It Works ​

ScriptedScreens introduces new circuit boards and cartridges that host Lua chips with direct screen access:

  1. Circuitboard (Lua Chip) / Motherboard (Lua Chip) - Insert into a Computer or Console
  2. Cartridge (Lua Chip) / Cartridge (Lua Chip, Wireless) - Insert into a Tablet
  3. Programmable Visor Glasses - Insert a Lua chip into the visor and use ss.hud for player HUD overlays

Each board/cartridge has a slot for an Integrated Circuit (Lua). Your Lua script runs on the chip and uses the ss API to create UI elements, handle input, and draw on the screen.

If you are specifically building wearable overlays, start with Programmable Visor HUDs.

Community ​

  • Discord — Orbital Foundry Mod Team
  • Ko-fi — Support development

⚠️ This documentation was AI-generated and may contain inaccuracies. Please submit pull requests with corrections as needed.