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 ⮭

GonerKeyboard

┗> Object > Class



Constructor


GonerKeyboard(limit: number, mode: number, callback: number, key_callback: number)

Arguments:

limit: number
mode: number
callback: number
key_callback: number




Methods


GonerKeyboard:addCharacter(key: any)

Arguments:

key: any


GonerKeyboard:createKeyboardChoices(mode: any)

Arguments:

mode: any

Returns:

1: table


GonerKeyboard:draw()



GonerKeyboard:finish()



GonerKeyboard:onComplete(text: any)

Arguments:

text: any


GonerKeyboard:onSelect(key: any, x: any, y: any)

Arguments:

key: any
x: any
y: any


GonerKeyboard:setMode(mode: any)

Arguments:

mode: any


GonerKeyboard:undoCharacter()



GonerKeyboard:update()




Undocumented



GonerKeyboard.MODES: table

For japanese support in the future maybe



GonerKeyboard.allow_empty: boolean



GonerKeyboard.alpha: number



GonerKeyboard.callback: number



GonerKeyboard.choicer: GonerChoice



GonerKeyboard.done: boolean



GonerKeyboard.fade_out: boolean



GonerKeyboard.font: love.Font

Defines the shape of characters that can be drawn onto the screen.

Open in Browser



GonerKeyboard.key_callback: number



GonerKeyboard.limit: number



GonerKeyboard.mode: nil



GonerKeyboard.text: string


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