Kristal

@return enabled — Whether borders are enabled.

Calls a function from all libraries, and then the current project.

Clears all currently loaded assets. Called internally in the Loading state.

Clears all project-defined hooks from Utils.hook, and restores the original functions.
Called internally when a project is unloaded.

Clears all state expected to be changed by projects.
Called internally when exiting or reloading a project.

Removes all project-defined classes from base classes' __includers table. Called internally when a project is unloaded.

Erases a file from the save folder.

Kristal alternative to the default love.errorhandler.
Called when an error occurs.

Executes a .lua script inside the specified library folder.
If id is not specified, the first script found from any library will be executed.

Executes a .lua script inside the project folder.

@return border — The currently displayed border, or nil if borders are disabled.

Returns the border data table for the given border config id.

@return name — The name of the current border config option.

Returns the dimensions of the screen border, or (0, 0) if borders are disabled.

@return types — The available border types, or nil if borders are disabled.

Called internally. Returns the current running/target project's name if it wants us to, or the default.
Also see Kristal.setDesiredWindowTitleAndIcon().

@return scale — The current game scale, based on the window dimensions.

Gets a library config option, defined in either lib.json or modified by the mod.json.
Default values can be defined inside your library's lib.json:

"config": {
   "option": "value"
}

These can then be overridden inside a mod.json like so:

"config": {
   "your_library_id": {
       "option": "new value"
   }
}

Gets a value from the current project's mod.json.

@return presence — Get the current presence information.

Returns the dimensions of the screen border relative to the game's size.

Returns the data from the specified save file.

Returns the offsets of the game display, for calculating screen position.

Returns the soul color which should be used.

@return state — The current Gamestate.

@return runtime — The current runtime (RUNTIME), affected by timescale / fast-forward.

Returns the current master volume from the config.

Returns whether the specified save folder has any save files.

Returns whether the specified save file exists.

Fades out the screen border.

Hides the mouse cursor.

@return console — Whether Kristal is in console mode.

Whether or not developer mode is enabled.

Returns whether Kristal is currently loading something.

Calls a function from the specified library, if it exists.
If id is not specified, the function will be called in all libraries, and the return value
will be or'd between libraries.

Loads assets of the specified type from the given directory, and calls the given callback when done.

Called internally. Loads the saved user config, with default values.

Loads and returns the data from a file in the save folder.

Loads the game from a save file.

Initializes the specified project and loads its assets.
If an after callback is not provided, enters the project, including dark transition if enabled.

Loads assets from a project and its libraries. Called internally by Kristal.loadMod.

Calls a function from the current Mod, if it exists.

Gets a value from the current Mod.

Pops the current Gamestate off the stack, returning to the previous one.

Called internally. Calls the preInit event on the project and initializes the registry.

@return border — The currently displayed border if dynamic borders are enabled.

Pushes a new Gamestate onto the stack.

state:
    | "Loading" -- The loading state, before entering the main menu.
    | "Menu" -- The main menu state.
    | "Game" -- The game state, entered when loading a project.
    | "Testing" -- The testing state, used in development.
    | "Empty" -- An empty state, which does nothing.

Reloads the current project.

mode:
    | "temp" -- Creates a temp-save and reloads the project from there.
    | "save" -- Reloads the project from the last save.
    | "none" -- Fully reloads the project from the start of the game.

Called internally. Resets the window properties to the user config.

Exits the current project and returns to the Kristal menu.

Saves the current config table to the settings.json.

Saves the given data to a file in the save folder.

Saves the game.

Called internally. Sets the title and icon of the game window to either what project requests to be or the defaults.

Helper function to set the current RPC information, and update the presence if enabled.

Switches the Gamestate to the given one.

state:
    | "Loading" -- The loading state, before entering the main menu.
    | "Menu" -- The main menu state.
    | "Game" -- The game state, entered when loading a project.
    | "Testing" -- The testing state, used in development.
    | "Empty" -- An empty state, which does nothing.

Sets the master volume to the given value and saves it to the config.

Whether or not to show the "dev mode enabled" warning.

Fades in the screen border.

Shows the mouse cursor.

Transitions the screen border, fading it out and then back in to the current border.

Called internally to make sure the correct cursor is displayed.

read args

Chapter defaults

The heart of Kristal - this class stores serves as the global that almost everything during gameplay is stored under in some way or another.
Game itself is mainly responsible for changing between states, handling player control, and accessing overarching features across gameplay such as the inventory or party members.

global stage

load the version

Save the defaults so if we do setWindowTitle for a project we're able to revert it Unfortunate variable names