HomeWikiSourceDownloadsDiscord

Kristal Wiki


Getting Started


These pages get you ready to use the engine.

  • Downloading Kristal
  • Installing and Playing Mods

General Mod Creation


These pages teach you about mod development.

  • Understanding the Basics
  • Creating a Mod
  • Using Libraries
  • Creating an Item
  • Creating a Spell
  • Actors
  • Party Members
  • Custom Keybinds

The Overworld


Everything to do with the overworld.

  • Designing a Map
  • Cutscenes

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.

  • Hooks
  • The UI System

API Reference


An auto-generated API reference for Kristal.

⮬Back to Top⮭

Kristal.Mods


Methods


Kristal.Mods.clear()



Kristal.Mods.getAndLoadMod(id: string)

Arguments:

id: string

Returns:

1: table


Kristal.Mods.getMod(id: string)

Arguments:

id: string

Returns:

1: table


Kristal.Mods.getMods()

Returns:

1: table[]


Kristal.Mods.getName(id: string)

Arguments:

id: string

Returns:

1: string


Kristal.Mods.loadData(data: table, failed_mods: table[])

Arguments:

data: table
failed_mods: table[]


Kristal.Mods.sortLibraries(mod: any)

Arguments:

mod: any

Returns:

1: table



Fields


Kristal.Mods.data: table<string, table>


Kristal.Mods.failed_mods: table[]


Kristal.Mods.list: table[]


Kristal.Mods.loaded: boolean


Kristal.Mods.named: table<string, string>



Undocumented


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