Kristal

@return enabled — Whether borders are enabled.

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

@param f — The function name to call.

@param ... — The arguments to pass to the function.

@return result — The result of the function calls or'd together.

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

@param include_mods — Whether to clear loaded mods.

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

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

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

Erases a file from the save folder.

@param file — The file name to erase.

@param path — The save folder to erase from. (Defaults to the current mod's save folder)

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

@param msg — The error message.

@return handler — The error handler, called every frame instead of the main loop.

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

@param lib — The library ID to execute the script from, or nil to execute from any library.

@param path — The script name to execute.

@param ... — The arguments to pass to the script.

@return success — Whether the script was executed successfully.

@return ... — The returned values from the script.

Executes a .lua script inside the mod folder.

@param path — The script name to execute.

@param ... — The arguments to pass to the script.

@return success — Whether the script was executed successfully.

@return ... — The returned values from the script.

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

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

@param id — The id of the border to get.

@return data — The border data.

@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 width — The width of the border.

@return height — The height of the border.

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

Called internally. Returns the current running/target mod'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"
   }
}

@param lib_id — The library ID to get the config option from.

@param key — The key of the config option to get.

@param merge — If the option is a table, whether to merge it with the default value. (Defaults to false)

@param deep_merge — If merge is enabled, whether to merge the tables deeply. (Defaults to false)

@return value — The value of the config option, or nil if it doesn't exist.

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

@param key — The key of the value to get.

@return value — The value at the key, or nil if it doesn't exist.

@return presence — Get the current presence information.

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

@return width — The width of the border.

@return height — The height of the border.

Returns the data from the specified save file.

@param id — The save file index to load. (Defaults to the currently loaded save index)

@param path — The save folder to load from. (Defaults to the current mod's save folder)

@return data — The data loaded from the save file, or nil if the file doesn't exist.

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

@return x — The x offset.

@return y — The y offset.

Returns the soul color which should be used.

@return r — The red value of the color.

@return g — The green value of the color.

@return b — The blue value of the color.

@return a — The alpha value of the color.

@return state — The current Gamestate.

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

Returns the current master volume from the config.

@return volume — The current master volume.

Returns whether the specified save folder has any save files.

@param path — The save folder to check. (Defaults to the current mod's save folder)

@return exists — Whether the save folder has any save files.

Returns whether the specified save file exists.

@param id — The save file index to check. (Defaults to the currently loaded save index)

@param path — The save folder to check. (Defaults to the current mod's save folder)

@return exists — Whether the save file exists.

Fades out the screen border.

@param time — The time it takes to fade out the border. Defaults to 0.5.

@param keep_old — Whether the old border stays during fadeout. Defaults to false.

Hides the mouse cursor.

@return console — Whether Kristal is in console mode.

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.

@param id — The library ID to call the function from, or nil to call in all libraries.

@param f — The function name to call.

@param ... — The arguments to pass to the function.

@return ... — The returned values from the function call, if it exists.

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

@param dir — The directory to load assets from.

@param loader — The type of assets to load.

@param paths — The specific asset paths to load.

@param after — The function to call when done.

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

@return config — The user config.

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

@param file — The file name to load.

@param path — The save folder to load from. (Defaults to the current mod's save folder)

@return data — The data loaded from the file, or nil if the file doesn't exist.

Loads the game from a save file.

@param id — The save file index to load. (Defaults to the currently loaded save index)

@param fade — Whether the game should fade in after loading. (Defaults to false)

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

@param id — The id of the mod to load.

@param save_id — The id of the save to load the mod from. (1-3)

@param save_name — The name to use for the save file.

@param after — The function to call after assets have been loaded.

@return success — Whether the mod was loaded successfully.

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

@param id — The id of the mod to load assets from.

@param asset_type — The type of assets to load. (Defaults to "all")

@param asset_paths — The specific asset paths to load.

@param after — The function to call after assets have been loaded.

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

@param f — The function name to call.

@param ... — The arguments to pass to the function.

@return ... — The returned values from the function call, if it exists.

Gets a value from the current Mod.

@param key — The key of the value to get.

@return value — The value at the key, or nil if it doesn't exist.

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

@param id — The id of the mod to pre-initialize.

@return success — Whether the mod should use default handling to enter the game.

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

Reloads the current mod.

@param mode — The mode to reload the mod in.

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

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

Exits the current mod 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.

@param file — The file name to save to.

@param data — The data to save.

@param path — The save folder to save to. (Defaults to the current mod's save folder)

Saves the game.

@param id — The save file index to save to. (Defaults to the currently loaded save index)

@param data — The data to save to the file. (Defaults to the output of Game:save())

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

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

@param presence — The presence information to set.

Switches the Gamestate to the given one.

@param state — The gamestate to switch to.

@param ... — Arguments passed to the gamestate.

state:
    | "Loading" -- The loading state, before entering the main menu.
    | "Menu" -- The main menu state.
    | "Game" -- The game state, entered when loading a mod.
    | "Testing" -- The testing state, used in development.

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

@param volume — The volume to set.

Fades in the screen border.

@param time — The time it takes to fade in the border. Defaults to 0.5.

Shows the mouse cursor.

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

@param time — The total time it takes to fade in and out. Defaults to 1.

Called internally to make sure the correct cursor is displayed.

read args

Chapter defaults

load the settings.json

global stage

load the version

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