Modding: mod.xml

mod.xml is a metadata file that defines your mod's name, description, and capabilities. It consists of a single xml tag <Mod/>.

Attributes

The following attributes are supported:

Attribute	Type	Default Value	Example Value	Description
name	string			The name of your mod, as it will appear in the mod list (mod menu).
description	string			The description of your mod, as it will appear in the mod list (mod menu) when the mouse hovers over it.
request_no_api_restrictions	bool	false		If a mod requires access to the full lua api e.g. os.* io.* it has to request access via request_no_api_restrictions="1". It is recommended that other options are explored first, as we may completely disable those APIs in the future. By default, mods have access to the table, string, math and bit libraries as well as the APIs exposed by the game. This option only affects the init.lua context, LuaComponents and other contexts remain restricted.
ui_newgame_name	string			The name of the game mode as it appears in the new game (main menu) screen.
ui_newgame_description	string			The description of the game mode as it appears in the new game (main menu) screen when the mouse hovers over the mode.
ui_newgame_gfx_banner_bg	string		"data/ui_gfx/game_mode/banner_normal_background.png"	The background graphic for the game mode banner. Standard size is 64x36 pixels. Must be the full `mods/yourmod/` path.
ui_newgame_gfx_banner_fg	string			The foreground graphic for the game mode banner. Standard size is 64x36 pixels. Must be the full `mods/yourmod/` path.
is_game_mode	bool	false		Indicates that this mod is a game mode that should be shown in the list of game modes on the New Game menu.
game_mode_supports_save_slots	bool	false		April 1 2021 - a mod declared as game mode (is_game_mode="1") can enable support for multiple save slots via game_mode_supports_save_slots="1"
is_translation	bool	false
translation_xml_path	string
translation_csv_path	string

Examples

A basic mod.xml that applies to all game modes and requires the unrestricted API to communicate with an external service.

<Mod
	name="Archipelago"
	description="Archipelago multiworld support for Noita"
	request_no_api_restrictions="1"
/>