Home
Wiki
Source
Downloads
Discord

Kristal Wiki


General Information


These pages get you ready to use the engine.

  • Main Page
  • Downloading Kristal
  • Installing and Playing Projects
  • Glossary

General Project Creation


These pages teach you about project development.

  • Lua Tutorial
  • Understanding the Basics
  • Creating a Project
  • Writing Text
  • Using Libraries
  • Creating an Item
  • Creating a Shop
  • Creating a Spell
  • Actors
  • Party Members
  • Custom Keybinds
  • Releasing Projects

The Overworld


Everything to do with the overworld.

  • Designing a Map
  • Cutscenes
  • Map Properties and Layers
  • Events
  • Battle Areas
  • The World Tool

Battles


Everything related to creating battles.

  • Battlers
  • Encounters
  • Enemy Attacks (Waves)
  • Wavemaking Tricks and References

Advanced


These pages teach you more complex but powerful parts of the engine.

  • Debugging
  • Hooks
  • The UI System

API Reference


An auto-generated API reference for Kristal.

⮬ Back to Top ⮭

Kristal Wiki


General Information


These pages get you ready to use the engine.

  • Main Page
  • Downloading Kristal
  • Installing and Playing Projects
  • Glossary

General Project Creation


These pages teach you about project development.

  • Lua Tutorial
  • Understanding the Basics
  • Creating a Project
  • Writing Text
  • Using Libraries
  • Creating an Item
  • Creating a Shop
  • Creating a Spell
  • Actors
  • Party Members
  • Custom Keybinds
  • Releasing Projects

The Overworld


Everything to do with the overworld.

  • Designing a Map
  • Cutscenes
  • Map Properties and Layers
  • Events
  • Battle Areas
  • The World Tool

Battles


Everything related to creating battles.

  • Battlers
  • Encounters
  • Enemy Attacks (Waves)
  • Wavemaking Tricks and References

Advanced


These pages teach you more complex but powerful parts of the engine.

  • Debugging
  • Hooks
  • The UI System

API Reference


An auto-generated API reference for Kristal.

⮬ Back to Top ⮭

MainMenuModList

┗> StateClass > Class



Constructor


MainMenuModList(menu: any)

Arguments:

menu: any




Methods


MainMenuModList:buildModList()



MainMenuModList:buildModListFavorited()



MainMenuModList:checkCompatibility()

Returns:

1: boolean
2: unknown


MainMenuModList:draw()



MainMenuModList:getSelectedButton()

Returns:

1: ModButton|ModCreateButton


MainMenuModList:getSelectedMod()

Returns:

1: table


MainMenuModList:onEnter(old_state: any)

Arguments:

old_state: any

Returns:

1: string


MainMenuModList:onKeyPressed(key: any, is_repeat: any)

Arguments:

key: any
is_repeat: any

Returns:

1: boolean


MainMenuModList:onLeave(new_state: any)

Arguments:

new_state: any


MainMenuModList:registerEvents()



MainMenuModList:reloadMods()



MainMenuModList:update()




Fields


MainMenuModList.active: boolean


MainMenuModList.engine_versions:


MainMenuModList.fades:


MainMenuModList.last_loaded: string[]


MainMenuModList.list: ModList


MainMenuModList.loading_mods: boolean


MainMenuModList.menu: MainMenu


MainMenuModList.mods: table[]


MainMenuModList.music:


MainMenuModList.music_options:


MainMenuModList.scripts:



Undocumented



MainMenuModList.backgrounds: table



MainMenuModList.intro_text: table


DELTARUNE by Toby Fox.
Website designed by NyakoFox.
© 2026 Kristal Team. All rights reserved.