LuaMade Documentation

LuaMade is a StarMade mod that adds scriptable Lua computers with terminal tools, a virtual file system, and network messaging.

Core

• LuaMade API Overview
  • Quick start
  • Core globals
  • Sandbox module loading
  • Typical workflow
  • Startup behavior
  • Safety and limits
• Console API
  • Typical usage
  • Reference
  • Notes
• Terminal Guide
  • Script execution model
  • Keyboard suggestions
  • Key commands
  • Editors
  • Terminal API (term)
  • Startup script tips
  • Filesystem protection workflow
• Terminal API
  • Reference
  • Wiring Commands To Game Logic
  • Override/Wrap Patterns
• Util API
  • Reference
• JSON Library
  • Reference
  • Notes
  • Example

I/O

• FileSystem API
  • Typical usage
  • Reference
  • Notes
• Network Interface API
  • Typical usage
  • Direct messaging
  • Channels
  • Local channels (same sector)
  • Entity scope (same ship/station)
  • Computer scope (this computer only)
  • Modem (1:1 link)
  • Networked Data Stores
  • Discovery helpers
  • Message object
• FTP API
  • Typical usage
  • Server API
  • Client API
  • Remote file inspection
  • Remote mutations
  • File transfer
  • Notes
• VirtualFile API
  • Reference
  • Notes
• Input API
  • Event types
  • Reference
  • Remote sessions
  • Common key codes
  • Example — draggable panel
  • CLI text input
  • Notes

Math

• BoundingBox API
  • Reference
  • Notes
• Vector API
  • LuaVec3i Reference
  • Reference
  • LuaVec3f Reference
  • Notes

Graphics

• Graphics API
  • Coordinate space
  • Automatic UI scaling
  • Layers
  • Canvas
  • Drawing
  • Limits and config
  • Example: layered terminal HUD
  • Bitmap Helper Library (gfx2dlib)
  • Interactive UI pattern
• GUI Library (gui)
  • Quick Start
  • GUIManager
  • Component (base class)
  • Panel
  • Button
  • Text
  • HorizontalLayout
  • VerticalLayout
  • ModalDialog
  • Responsive layouts
  • Full example

Entities

• Entity API
  • Typical usage
  • Identity and location
  • World access and nearby entities
  • Faction and diplomacy
  • Systems and modules
  • Docking and rails
  • AI / status
  • Inventory / fleet
• EntityAI API
  • Reference
  • Target type names
  • Heading and orientation
  • Roll control
  • Typical alignment workflow
  • Typical roll alignment workflow
• RemoteEntity API
  • Reference
  • Notes
• Faction API
  • Reference
  • Examples
• Fleet API
  • Reference
  • Movement commands
  • Tactical commands
  • Notes
• FleetCommand API
  • Reference
  • Enum names

Systems

• Network Usage Guide
  • Message types
  • Direct messaging
  • Global channels
  • Local sector channels
  • Modem links
  • Hostname and discovery
  • Reference
• Inventory API
  • Typical usage
  • Reference
  • Cargo transfer detection
• ItemStack API
  • Typical usage
  • Reference
• Peripheral API
  • Typical usage
  • Side names
  • Reference
  • Notes
  • Remote access point wrapper
• Block API
  • Typical usage
  • Common patterns
  • Reference
• BlockInfo API
  • Typical usage
  • Reference
• Chamber API
  • Reference
• DataStore API
  • Access levels
  • Typical usage
  • Reference
  • Limits
  • Notes
• Networked Data Store API
  • Key differences from DataStore
  • Setup (on the entity with the block)
  • Remote access (from any computer, anywhere)
  • Access levels
  • Block peripheral reference
  • Remote handle reference (RemoteDataStore)
  • Limits
  • Notes
• Disk Drive Block API
  • Typical usage
  • Reference
  • Notes
• DisplayModule API
  • Reference
  • Notes
• Factory Block
  • Typical usage
  • Factory type names
  • Reference
  • FactoryRecipe
  • Notes
• InventoryBlock API
  • Reference
  • Notes
• PasswordPermissionModule API
  • How it works
  • Typical usage
  • Reference
  • Integration
  • Notes
• Reactor API
  • Reference
• Shield API
  • Reference
• ShieldSystem API
  • Reference
• Shipyard API
  • Reference
  • Command names
• Thrust API
  • Reference
• UsableChamber API
  • Reference