Skip to content
Dan DiIorio edited this page Jan 12, 2024 · 20 revisions

Welcome to the LBAL-Modding-Docs wiki!

What is this wiki?

This wiki shows players of Luck be a Landlord how to use the modding API!

This GitHub repo is exclusively for documentation of the API and does not contain any source code.

What can the modding API do?

The modding API currently supports the following:

  1. Custom symbols
  2. Custom items
  3. Custom emails
  4. Custom fine print
  5. Custom apartment floors
  6. Modifications to existing symbols
  7. Modifications to existing items

Where should I start?

Read the tutorials:

Tutorial Series 1: Basic Modding Concepts:

  1. Getting Started
  2. Making a Custom Symbol
  3. Testing in the Sandbox
  4. Effects
  5. Effects (Advanced Usage)
  6. Value Text
  7. Art
  8. Sound Effects
  9. Descriptions

Reference the Documentation as needed.

  • Apartment Floors - For making Apartment Floor mods
  • Art Replacement - For making Texture Pack mods
  • Color Index - For checking the game's default colors and color settings
  • Comparisons - For assembling comparisons (which determine whether effects will trigger or not)
  • Effect Types - For determining what kind of effect to use for a symbol or item mod
  • Effects - For reviewing the many variables that can be in an effect
  • Fine Print - For making Fine Print mods
  • Group Addition - For making Group Addition scripts (which can mass-add symbols to groups in a single file)
  • Inherited Effects - For making Inherited Effects scripts (which can mass-add effects to symbols or items in a single file)
  • Item Type and Group Index - For referencing the type variables of Items and groups they're added to
  • Item Variables - For checking which variables can be modified in an Item effect
  • Modding Variables - For making the structure of a mod file
  • Sound Effect Index - For checking the game's default sound effects
  • Symbol Type and Group Index - For referencing the type variables of Symbols and groups they're added to
  • Symbol Variables - For checking which variables can be modified in a Symbol effect
  • var_math - For understanding how to do mathematical operations on variables within effects