Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/retired64/sm64coopdx_launcher/llms.txt

Use this file to discover all available pages before exploring further.

The Mod Manager gives you a live view of every Lua mod installed on your system and lets you toggle them on or off before launching the game — no manual sm64config.txt editing required. Changes are written atomically, so your config is never left in a partially-written state.

​
Opening the Mod Manager

1

Open the arc menu

Press Tab from the main launcher screen to open the arc (radial) navigation menu.
2

Select Mods

Navigate to Mods and confirm. The Mod Manager panel slides into view, listing every detected mod.

​
Supported Mod Types

The Mod Manager scans ~/.local/share/sm64coopdx/mods/ and recognises two kinds of mod:

.lua files

Single-file mods — any file ending in .lua directly inside the mods directory. The mod name shown in the list is the filename without the extension (e.g. my_cool_mod.lua → display name my_cool_mod), but the full filename is used when storing the enabled state in sm64config.txt.

Mod folders

Directory mods — any subdirectory that contains a main.lua file at its root. The mod name is the directory name. All other subdirectories (those without main.lua) are silently ignored.
Symlinks, binary files, and directories without main.lua are not listed in the Mod Manager and are never passed to the game.

​
Mod Directory

All mods live under: 
~/.local/share/sm64coopdx/mods/
The launcher creates this directory automatically the first time it runs if it does not already exist.

​
Toggling Mods On and Off

Use the keyboard to navigate and toggle mods:
KeyAction
↑ / ↓Move selection up or down
Enter or SpaceToggle the selected mod on (✓) or off (—)
EscClose the Mod Manager panel
When you toggle a mod, the launcher immediately rewrites the enable-mod: section of the active profile’s sm64config.txt. All other config lines (network settings, DynOS packs, etc.) are preserved in their original order.

​
How Enabled Mods Are Stored

Enabled mods are recorded as enable-mod: <rel_path> lines in sm64config.txt:
  • For .lua files the stored value is the full filename (e.g. my_cool_mod.lua).
  • For folder mods the stored value is the directory name (e.g. my_folder_mod).
enable-mod: my_cool_mod.lua
enable-mod: my_folder_mod
The list is sorted alphabetically before display. write_enabled_mods rewrites all enable-mod: lines atomically, preserving every other line in the file unchanged.

​
How the Launcher Passes Mods to the Game

When you launch the game, the launcher translates the enable-mod: entries into CLI flags:
  • One or more mods enabled — a --enable-mod <name> flag is appended for each enabled mod.
  • No mods enabled — a single --disable-mods flag is passed, which tells the game to skip loading any mods from the filesystem entirely.
# Example with two mods enabled
sm64coopdx --enable-mod my_cool_mod.lua --enable-mod my_folder_mod ...

# Example with no mods enabled
sm64coopdx --disable-mods ...

​
Installing Mods Manually

1

Locate the mods directory

Open your file manager or a terminal and navigate to ~/.local/share/sm64coopdx/mods/.
2

Copy the mod

  • For a single-file mod: copy the .lua file directly into mods/.
  • For a folder mod: copy the entire directory (the one containing main.lua) into mods/.
3

Refresh the Mod Manager

Close and reopen the Mod Manager panel. The new mod will appear in the list and can be toggled on immediately.
Nested folder mods (e.g. mods/pack/sub/main.lua) are not supported. The main.lua must sit at the top level of the directory inside mods/.

​
Installing Mods from the Download Browser

The launcher includes a built-in Download Browser that lets you search and install mods from a bundled database of 1,000+ community mods without ever leaving the launcher. After a mod is downloaded and extracted, it appears automatically in the Mod Manager.
See the Download Browser page for full instructions on searching, filtering, and installing mods in-app.

​
Keyboard Shortcuts Summary

KeyAction
↑ / ↓Navigate the mod list
Enter / SpaceToggle selected mod on/off
EscClose the Mod Manager panel

Build docs developers (and LLMs) love

Get started for freeTalk to us