Skip to content

A Mario Odyssey tool built off Dear ImGui for developers, level builders, glitch hunters, and everyone in-between

License

Notifications You must be signed in to change notification settings

Amethyst-szs/smo-lunakit

Repository files navigation

Luna Kit Logo

LunaKit is a development tool / modification of Super Mario Odyssey designed to assist in debugging, testing, experimenting, and more! Uses ImGui ExLaunch with a special dedicated SD card folder to allow being layered on top of any RomFS or Starlight mod

A gameplay screenshot showing LunaKit in Metro Kingdom with the heap viewer, parameter editor, and info viewer open

Features:

  • Custom in-game GUI built on Dear ImGui Showing the docking system in LunaKit to position windows on the screen
  • View and edit large amounts of game info
  • Browse, search, favorite, and manipulate every object in a stageGameplay screenshot showing the capabilities of the actor browser
  • Many game settings and cheats for players and developers alike
  • Primitive Rendering to visually draw additonal game info Gameplay screenshow showing the primitive rendering options
  • Extremely fast stage warping, including custom stages using Custom Stage plugins
  • Easy to make Custom Theme plugins The window menu open over Cascade Kingdom, showing the bult in themes
  • Automatically install new updates as they come out with a built in automatic updater
  • Highly modular and expandable code with a detailed Wiki page

How to use:

Installation on switch

  • Install Atmosphere and SMO V1.0.0
  • Remove any previous mods that would cause conflicts
  • Download newest build from releases
  • Drag and drop the included atmosphere and LunaKit folders onto the root of your SD card
  • Boot up game in docked mode (not handhled!)

Installation on Ryujinx

  • Enable mouse input in Ryujinx settings
  • Download newest build from releases
  • Drag and drop the included atmosphere and LunaKit folders onto the root of the emulated SD card

Installation on Yuzu is NOT actively supported.

Controls:

  • Open the interface by holding ZR + R and tapping L
    • Dock the Nintendo Switch first, it must have been docked at least once in the current session to function. This bug will hopefully be fixed!
  • Hide windows by pressing L-Stick
  • Mouse controls (RECOMMENDED)
    • Navigate interface with a mouse
    • Connect mouse to switch via USB
  • Controller controls (NOT RECOMMENDED)
    • Activate or deactivate controller mode by holding ZR + R and tapping ZL
    • Navigate window with D-Pad
    • Interact with windows using A or B
    • Change windows by holding Y and using shoulder buttons

Building:

  • Requires running Linux (Ubuntu recommended)
    • If you're running Windows, try WSL!
  • Install devkitPro with the switch-dev platform
  • Clone or fork this repository
    • If using WSL, make sure to clone the repo inside your WSL directories! Using a folder on your windows machine with WSL drastically slows compile times
  • Open bash and run make
    • To send to your switch (requires editing FPT_IP in makefile), run make send
    • To increase core usage for compile, run make -j# (# for total cores to use)

Credits:

Original SMO-Exlaunch-Base Description

A base repository using exlaunch-cmake that contains code for modifying Super Mario Odyssey 1.0.

Credits