Home

Disclaimer

You are strongly discouraged from using any modding tools in your actual online Steam installation as to prevent unlocking achievements, corrupting your savefile and cheating in the leaderboards. You should make a copy of your game somewhere else and install Mr. Goldbergs Steam Emulator in the game directory. (TL;DR: Copy the steam_api64.dll from the zip to the offline game directory and create steam_appid.txt with the text 418530 in it.) Also block the modded installation in your firewall. If you break anything using this tool you get to keep both pieces. Do not report modding related bugs to Blitworks.

Now that that's out of the way, you can probably use texture mods online in Steam just fine.

Quick Start

• Download modlunky2.exe to the game directory where Spel2.exe is, usually C:\Program Files (x86)\Steam\SteamApps\common\Spelunky 2

Installing Spelunky 2 Mods with Playlunky❤️Modlunky

1. Verify game files in Steam to make sure you have the latest, clean version of the game executable
2. Start modlunky2.exe from the game directory. This creates a Mods\Packs directory inside.
3. Create a new directory Mods\Packs\Example Mod for your mod and copy the mod files (.png/.lvl/.txt/.hlsl/.wav/main.lua/...) there. If the mod is zipped, extract the zip first. Subdirectories inside the mod directory don't matter. For example, a simple character mod file structure could look like Spelunky 2\Mods\Packs\Example Mod\char_yellow.png
4. Go to the Playlunky tab and in the Version box, select the newest version and click Download, then select your mods [x] Packs\Example Mod, click Play! First launch will take some time, but you should be playing your mods soon enough.
5. Refer to the Playlunky guide for additional information.
6. If you want to play without mods, just launch the game normally through Steam.

Packing assets (Deprecated, DON'T DO THIS!)

- You have to do all of these steps every time the game is updated!

1. Verify game files in Steam to make sure you have the latest, clean version of the game executable
2. Start modlunky2.exe from the game directory
3. Go to Extract Assets tab, select Spel2.exe and click Extract. This will take a few minutes. Just sit back and wait for the process in the console to finish with Extraction complete!
4. There's a new directory in the game directory called Mods. Create a new directory Mods\Packs\Example Mod for your mod and copy the mod files (.png/.lvl/.txt/.hlsl/.bank) there. If the mod is zipped, extract the zip first. Subdirectories inside the mod directory don't matter. For example, a simple character mod file structure could look like Spelunky 2\Mods\Packs\Example Mod\char_yellow.png
5. Go to Pack Assets tab (you may need to switch tabs for it to update), select [x] Packs\Example Mod, click Pack. Once again, this will take a while, so wait for the console window to say Repacking complete! Done! Play the game through Steam or Spel2.exe

Notes

• It is a good idea to copy a backup of your savefile.sav from the game directory somewhere safe before using mods
• If you want to get rid of the mods, click Restore EXE or verify game files in Steam if you have somehow messed up the local backup
• If there hasn't been an update and you're sure you have already extracted this version, you can obviously skip some steps, but it doesn't hurt to do it all if you're not sure
• If the quick start wasn't clear enough for you, continue reading!

How to use Modlunky 2

Creating a backup of the Spel2.exe and savegame.sav

• Head to your Spelunky 2 game folder, for me that's in C:\Program Files (x86)\Steam\SteamApps\common\Spelunky 2

Note: You can also find your Spelunky 2 folder by right clicking on Spelunky 2 in the Steam client and then heading to Manage > Browse Local Files

• Now copy the file Spel2.exe and savegame.sav and paste it in a new folder or somewhere safe on your desktop

How to verify the game files

This is just so if anything goes wrong have a copy of the clean .exe file. You can also restore the original .exe by using the steps below

• Right Click on Spelunky 2 in the Steam client
• Click on Properties
• Click on the Local Files
• Click onVerify Integrity of Game Files

Downloading Modlunky 2

• Head to Modlunky Releases
• Click on the modlunky2.exe to download it

Note: It may pop with a warning that the file can harm your computer. The file is fine to use and you can just select keep if using Google Chrome

• Copy the modlunky2.exe you just downloaded to the Spelunky 2 folder

Extracting with Modlunky 2

Note: This must be done each time Spelunky 2 is updated as to not cause any issues or errors when repacking.

• Head to your Spelunky 2 folder where you have just copied modlunky2.exe
• Double click on modlunky2.exe and wait for the window to pop up
• Select the Extract Assets tab and click on Spel2.exe
• Make sure the Generate Entity Sheets and Generate String Hashes boxes are ticked on the right
• Hit the Extract button at the bottom of the window
• The other window Modlunky2 Console will display the message "Extraction complete!" when done

Note: Do not edit these files directly. Always copy them elsewhere BEFORE editing them. (See "Editing files for repacking" below)

File location info

• Images are in Mods/Extracted/Data/Textures/
• Entity Images are in Mods/Extracted/Data/Textures/Entities, always use those if possible
• Level files are in Mods/Extracted/Data/Levels
• String files are in Mods/Extracted

Editing files for repacking

• Make a custom folder inside Mods/Packs and copy the file you want to edit to that custom folder

Note: Do not edit files in the Extracted folder directly. Always copy them elsewhere BEFORE edit them.

• There are many free image editing programs you can use such as: GIMP, Paint.net, Pixlr or for a paid option you can use Adobe Photoshop
• For text editing there are also many free programs to use such as: Notepad (comes with Windows anyway), Notepad++, Atom
• Save the edited file in the custom folder you created earlier

Editing sounds

• You can extract the ogg and wav files from the soundbank while extracting with Modlunky2
• You can load loose audio files with Playlunky (usable via Modlunky2 via the Playlunky tab)

Adding mod packs

• Place the mod files to Spelunky 2/Mods/Packs/Mod name here. If the mod is in a zip file, extract it first. There should only be .png / .lvl / .txt / .hlsl / .bank files in the directory. Subdirectories don't matter.

Repacking with Modlunky 2

Note: You MUST put the files you edited in Mods/Overrides/ or Mods/Packs/ otherwise errors will occur.

• Copy/place the file you edited into Mods/Overrides/

Note: You can also make a folder in the Mods/Packs/ folder with the name of your mod which helps with installing single or multiple mods

• Head to your Spelunky 2 folder

Note: You can find your Spelunky 2 folder by right clicking on Spelunky 2 in the Steam client and then heading to Manage > Browse Local Files

• Double click on modlunky2.exe to open it
• Select the Pack Assets tab
• If you have multiple folders in the Mods/Packs/ folder it may look like this

Note: If you just have a single file and don't wish to put it in a named folder, you can put it in Mods/Overrides/

• You can click on one or more of the folders which contain your mods.

(Using this preview image) For example if I wanted to install just the Max 404 mod I can click on that to select it. However if I wanted the Companion Cube Push Block mod as well, I can click on it to select it as well.

This way you can select which mods you wish to repack or not

• Then hit the pack button which will then repack your files/mods into the game
• The other window Modlunky2 Console will display the message "Repacking complete!" when done

You can now enjoy your modded game simply by starting it through Steam!