Nx86 - NDX: nxmod.toml Reference

nxmod.toml Reference

[mod]
id = "example_mod"
name = "Example Mod"
version = "1.0.0"
format = "ndx"
author = "Example Author"
description = "Short description of the mod."
license = "Unknown"

[target]
title_id = "0100000000000000"
game_version = "optional"
build_id = "optional"

[content]
romfs = true
romfs_ext = false
exefs = false
cheats = false
native = false
lua = false

[cache]
impact = "runtime-only"
affects_executable = false
partial_recompile_supported = false

[security]
requires_native_code = false
requires_lua = false
requires_network = false
requires_filesystem = false

[repository]
source = "https://example.com/source"
update_url = "https://example.com/update"

[mod]

Field	Description
`id`	Unique identifier. Lowercase letters, digits, underscores.
`name`	Display name shown in the mod UI.
`version`	Version string. Semantic versioning recommended.
`format`	Must be `"ndx"`.
`author`	Author name or handle.
`description`	One or two sentences shown in the mod list.
`license`	SPDX identifier (e.g. `"MIT"`) or `"Unknown"`.

[target]

Field	Description
`title_id`	16-character hex Title ID. Required.
`game_version`	Target game version. Omit if version-agnostic.
`build_id`	Target Build ID. Required for ExeFS mods and cheats.

[content]

Field	Default	Description
`romfs`	`false`	Includes a `romfs/` overlay.
`romfs_ext`	`false`	Includes `romfs_ext/`.
`exefs`	`false`	Includes ExeFS patches.
`cheats`	`false`	Includes cheat code files.
`native`	`false`	Includes a compiled native module. Requires explicit trust.
`lua`	`false`	Includes Lua scripts. Requires explicit trust.

[cache]

Field	Description
`impact`	Declared cache impact value. See below.
`affects_executable`	`true` if the mod changes game executable code.
`partial_recompile_supported`	`true` if a partial rebuild is safe. Only valid when `affects_executable` is `true`.

cache.impact values

Value	Meaning
`no-rebuild`	Does not affect compiled output or asset caches.
`runtime-only`	Applied at runtime, no cache changes needed.
`asset-cache`	Asset index update needed, no native recompile.
`partial-native-rebuild`	A subset of compiled blocks is invalidated and rebuilt.
`full-profile-rebuild`	All compiled output for the game is rebuilt.
`unsupported`	Cannot be applied with the current Nx86 version.

[security]

Field	Description
`requires_native_code`	Mod includes a native binary module running inside Nx86.
`requires_lua`	Mod includes Lua scripts.
`requires_network`	Mod makes network requests.
`requires_filesystem`	Mod accesses the host filesystem beyond its own package directory.

[repository]

Field	Description
`source`	URL of the mod's source repository or homepage.
`update_url`	URL Nx86 checks for newer versions.