mod.toml

# Config file for an example Majora's Mask: Recompiled mod.

# Fields that end up in the mod's manifest.
[manifest]

# Unique ID of this mod. Pick something long enough that it'll never be the same as any other mod.
# The name displayed in the mod management menu is separate from this so this doesn't need to be human readable.
id = "mm_recomp_do_action_helper"

# Version of this mod.
version = "1.0.1"

# The name that will show up for this mod in the mod menu. This should be human readable.
display_name = "Do Action Helper"

# The description that will show up when this mod is displayed in the mod menu. This should be human readable.
description =  """
A library mod that aims to help mod developers manage and implement Do Actions without creating conflicts. 
"""

# A short description that will show up in this mod's entry in the mod list. This should be human readable and kept short
# to prevent it from being cut off due to the limited space.
short_description = "Always perform a quickspin when swinging your sword."

# Authors of this mod.
authors = [ "tomtee" ]

# ID of the target recomp game.
game_id = "mm"

# Minimum version of the target recomp (e.g. Zelda 64: Recompiled) that this mod can run on.
minimum_recomp_version = "1.2.0"

# Dependency mods. Each entry is the mod's ID and then an optional minimum version of the dependency mod.
dependencies = [
    "ProxyMM_Notifications:0.0.1"
]

# Native libraries (e.g. DLLs) and the functions they export.
native_libraries = [
# Example native library:
#    { name = "my_native_library", funcs = ["my_native_library_function"] }
]

# Inputs to the mod tool.
[inputs]

# Input elf file to generate a mod from.
elf_path = "build/mod.elf"

# Output mod filename.
mod_filename = "mm_recomp_do_action_helper"

# Reference symbol files.
func_reference_syms_file = "Zelda64RecompSyms/mm.us.rev1.syms.toml"
data_reference_syms_files = [ "Zelda64RecompSyms/mm.us.rev1.datasyms.toml", "Zelda64RecompSyms/mm.us.rev1.datasyms_static.toml" ]

# Additional files to include in the mod.
additional_files = [
    "thumb.png"
]

[[manifest.config_options]]
id = "conflict_notifications"
name = "Conflict Notifications"
description = """
Would you like to receive notifications on game boot:
- Never (not recommended)
- When two mods change the same Do Action condition
- When two mods change the same condition or when a mod changes a Vanilla condition
- When a mod changes any conditions (even unassigned ones)
"""
type = "Enum"
options = [ "Never", "Mods", "Mods + Vanilla", "Any" ]
default = "Mods"