Modding

Adding a mod

1. Download or create the mod you want to use
2. Put the mod in sd:/_nds/WordleDS on your SD card
   • If it is in a ZIP file you will need to extract that, the files should be such that you have sd:/_nds/WordleDS/[name of the mod] with all of the mod's files (mod.json, etc) inside of that folder

If you're on 3DS you can download mods from Universal-Updater using the Wordle DS Mods UniStore. To get this UniStore:

1. Open Universal-Updater and go to settings
2. Click Select UniStore...
3. Click the + button at the bottom
4. Scroll one past the end of the list
   • This is a bug in the current release of Universal-Updater and will be fixed by the next version
5. Once it downloads, select wordle-ds.unistore

You can now download any Wordle DS mod from the official repository, they will be automatically downloaded and extracted to the correct location ready for you to select in game.

Selecting a mod

1. Open settings
2. Click the arrow by the "Mod" option
3. Select the mod you want to use

Creating a mod

All mod elements except the mod folder itself are optional, so for example if you just want to edit graphics you don't need a mod.json and if you just want to edit the word lists you don't need any GRF files. If you just want a second copy of your stats for multiple people to play you can even just use an empty folder.

Mod folder

The mod folder is any folder inside of sd:/_nds/WordleDS. These can have any name, but using only ASCII characters is recommended so that it displays correctly with the default font.

Editing word lists, max guesses, keyboard, emoji grid, etc

The mod.json file inside your mod folder controls most of the behavior of Wordle DS. Please see the mod.json page for more details on its content.

Music

The music.msl file in your mod folder is the background music of Wordle DS. Due to issues with maxmod music is only loaded once on app load so changing songs when switching mods requires closing and reopening Wordle DS completely.

Wordle DS music must be in the form of module file. Module files are sequenced akin to a MIDI file, so you cannot convert a normal streamed audio file into a module without remaking it from scratch. Many modules can be found on websites such as The Mod Archive.

To convert a module in the .it, .mod, .s3m, or .xm formats to .msl for Wordle DS, use the following mmutil command:

mmutil -d [module] -omusic.msl

Graphics

All images in Wordle DS can be customized using GRF files in your mod folder with the same names and conversion settings as those in the repo.

For an example of how to convert .png or .bmp images to .grf for Wordle DS please see the png folder of the Wordle (ES) example mod. You can also upload your .png/.bmp and .grit files to this web app if you do not have access to the grit terminal command. For .grit files not in the Wordle (ES) example, download them from the gfx folder of the repo, linked above.

The more complex images in Wordle DS also have their source GIMP files in the resources folder of the repo. If you can't use GIMP, Photopea is an online editor able to use GIMP files, however it seems to struggle with paletted images.

When editing the keyboard keys or letter tiles images, be sure to update the letters array of the mod.json file.

Fonts

Fonts must be NFTR files using the same names as in the repo. They can be edited with an NFTR editor.

Other info

Stats are stored individually for each mod at sd:/_nds/WordleDS/[mod folder]/stats.json.

A file named share.txt will be created with a sharable emoji grid inside your mod folder on completion of each day.

Sharing your mod

To share your mod you can post to to the mod sharing discussion here on GitHub.