(Original guide by Zura)

Playing YWML Mods

Download the appropriate extension

  1. Open the extension library and select the correct region for your game.
  2. This ensures that auto-installation works correctly.

The extension library window

Select Your Target Game

In the main menu, click Load and choose the appropriate game extension you downloaded.

TargetGame

Generate your Installation Directory

For 3DS with MicroSD Inserted

  1. Select Modded3DS in the Platform/Emulator dropbox and click Generate installation dir.
  2. Select your microSD drive (e.g., D:/) and click Select.

For Emulators

  1. Select your emulator from the Platform/Emulator dropbox.
  2. Click Generate installation dir.

Your mod installation directory field should now be filled automatically.

Add and Install Your Mod

  1. Click Add mod and select your mod folder.

mod

  1. Click Install selected mods to install all mods in the list.

mod

You’re done! Enjoy!

Making YWML Mods

Migrating an Existing FA Mod

  1. Go to the YWML main menu and click Migrate old mod.
  2. Fill out mod information. (Name, Author, and Version.)

migrate info

  1. Select your mod folder.

select folder
Ensure your folder matches the structure in the screenshot.

  1. Select your unmodified RomFS folder. (Usually the original dumped RomFS from your game.)
    • To dump RomFS: Open your 3DS emulator, right-click your game, and select Dump RomFS.
    • After dumping, select the folder that matches your mod folder’s structure.

dump romfs

  1. Click Migrate and select the folder where you want the YWML mod to be saved.

Creating a YWML Mod from Scratch

  1. Sort your mod files in a loose fashion inside an include folder. For example, if I edited data/menu/title_screen.xa, This is how my folder structure will look:
    -MyMod
     -include
         -data
             -menu
                 -title_screen.xa
    
  2. Right outside of the include folder, create a file called ywml.json and paste the following into it:
    {
     "Name": "Your mod's name",
     "Author": "Your name",
     "Version": "Your mod's version"
    }
    

Fill out all of the fields!

But wait, what if you edited files that are already loose, like files in mov or snd? Well, it’s super simple to integrate! Simply paste your mov and snd folders, for example, right outside the include folder!

Your mod is now ready to load with YWML!

Happy Mod Loading!


This site uses Just the Docs, a documentation theme for Jekyll.