-
Notifications
You must be signed in to change notification settings - Fork 55
Home
Kristal is a powerful Deltarune fangame and battle engine. It is strongly recommended to have Lua coding experience before making mods with Kristal. (to-do: make this sound cooler) (to-do: also link the discord)
(to-do: make links for each of these)
- Basic Setup: Describes how Kristal mods are structured.
- Overworld: Process for making overworld rooms and using them.
- Cutscenes: Writing cutscene code, and listing formatting options for text.
- Objects: How to create and use objects.
- Characters: NPC and party member setup.
- Encounters: How to set up and initiate encounters with enemies.
- Enemies: Setting up ACTs, dialog, wave choices, etc. for enemies.
- Waves: Making attacks for enemies to use.
Downloading Kristal
Installing and playing mods
Game options
File structure
mod.json and mod.lua
Libraries
Save data
Game and Kristal variables and functions
Important tips
Using objects
Creating new objects
Extra notes
Collision
DrawFX
Sprites and the Sprite object
Custom fonts
Sounds and music
External libraries
Utility functions
Global variables
Debug shortcuts
Debug menus
Making an actor
ActorSprite
Default animations
Creating a party member
Using and overriding functions
Types of Items
Default items
Inventory
Defining a spell
Making rooms
Using rooms in your mod
The Map class
Game.world functions
Events and Controllers
Existing events
Characters
Types of Characters
Battle areas and World bullets
Making a cutscene
Starting cutscenes
The Text object
In-text modifiers
Creating a shop
Overridable functions
Shop states
Shopkeepers
Making an encounter
Game.battle functions
Battle and PartyBattler states
PartyBattlers and EnemyBattlers
Creating an enemy
Overridable functions
Misc. functions and variables