Getting started

Welcome

What Underlives modding is, what these docs cover, and where to start.

Underlives is a life simulation you can rewrite. The scenes you play, the actions on your phone, the stats on your character sheet, the cities on the map, the clothes in the shops, the furniture in the rooms: all of it is loaded from plain files at startup. The game that ships is itself a set of mods, and yours sit right next to them with the same powers.

These docs cover everything a modder can reach, from writing a first scene in ten lines of Lua to adding a city or a furniture pack.

Where to start

If you want to… Read
Understand how the game is built and why Everything is a mod
Make something work in the next half hour Your first mod
Know what goes where in a mod folder Anatomy of a mod
Change or replace something the base game does Load order and overrides
Write story content Scenes, then Dialogue and choices
Add things to do Actions and Stats
Add clothes, hair, furniture or animations Characters & assets
Look up a function Lua API reference

What you need

  • A text editor. Anything works. One with Lua syntax highlighting (VS Code, Notepad++, Sublime) makes life easier.
  • The game. You test mods in the real game; there is no separate SDK and no compile step.
  • For 3D assets only: Blender or Daz Studio, to export .glb or .fbx files. You never need Unreal Engine to mod Underlives.
note

The game is in active development and the modding surface grows with every release. Each page says plainly when a field is read but not acted on yet, so you never build on something that silently does nothing. If you find a gap these pages do not mention, tell us.

Older guides

Scenes, actions and stats are Lua tables. Do not follow modding guides written for other games; where these docs and an old guide disagree, these docs describe what the game actually does.