Test your mod in game

Test every mod on your own PC before you share it: load it, start a private map, and check every part for your mod type. You need a packed VPK first: Pack your mod into a VPK.

What you need

Your mod as a VPK

Deadlock Mod Manager

or by hand

Source 2 Viewer

optional

• Name your mod like pak05_dir.vpk.
• Set up Deadlock to load mods. Deadlock Mod Manager does it for you, or install mods by hand for the same setup without a manager.
• Use Source 2 Viewer to compare paths when something does not show.

Load and check your mod

Use one fixed pak number for test builds

Pick one number for your work in progress, such as pak05_dir.vpk, and overwrite that file with every new build. Old test builds then never pile up in your addons folder.

1. Close Deadlock. The game reads mods only when it starts.
2. Copy your VPK into game/citadel/addons/, over the old test build.
3. Start Deadlock.

Restart the game after every new build. No source confirms that it reloads a changed VPK while running.

• Turn off your other mods while you test. A mod with a lower number can hide yours.
• If you test through Deadlock Mod Manager, zip your VPK first. Put the .vpk at the top level of the zip, not in a folder.

Turn on the console

1. Open Deadlock's settings.
2. Turn on Dev command console.
3. Press F7 to open the console.

Load a private map

These maps run on your own PC, not on Valve's servers.

1. Press F7 to open the console.
2. Type one of these commands and press Enter:
   • map dl_hideout: the hideout.
   • map new_player_basics: the new player basics map.
   • map dl_midtown: the full main map.
3. Pick your hero.
4. To pick another hero, type changeteam 0. The team and hero choice opens again.

The game also has a sandbox mode. Some creators use it to spawn their hero and check the health bar.

What to check

Check every part of your mod, not only the part you changed.

Skins and modelsSoundsIcons and UIParticles

1. Walk around and look at your hero from every side.
2. Aim down sights. The camera should sit where it does on the normal hero, not in the middle of the screen.
3. Use every ability. Some switch parts of the model on or off.
4. Die once and look at the body.
5. Check that the health bar floats above the hero, not at the feet.
6. Check the hero select and shop screens.
7. Look for missing or wrong textures on every part.

1. Type snd_showstart 1 in the console. It now prints each sound path as the sound starts.
2. Make the sound play, for example by using the ability.
3. Check that your sound plays and its path shows in the console.
4. Compare volume and length with the original sound. Keep them close.

1. Check every place your image appears. A hero has six portraits: the hero card, the small icon, the minimap icon, the tall portrait, and the low health and kill streak portraits.
2. Check that each image is sharp and not stretched.
3. Check that see-through parts stay see-through, like in the original.

1. Use the ability with your effect.
2. While it plays, type dumpparticlelist in the console to list the particle files in use.
3. Check that your color shows on every part. Some effects use several particle files.
4. Make sure the effect is as easy to see as the original.

Keep it fair

A skin, sound, or effect must not make enemies easier to see or hear. What's allowed and how to stay safe lists what crosses the line.

Useful console commands

These commands come from community notes written before the "City Never Sleeps" update. Some may have changed.

Read errors in the console

Load a private map with your mod in place, open the console with F7, and read any errors or warnings that name your files.

For example, a model with broken camera attachments fills the console with green text that names the bad attachment. If your mod does not show at all, the cause is almost always the file name, the folder, or a path inside the VPK.

Fixes for common errors are in Errors when making mods and Model and skin problems.

Before you queue again

1. Close CSDK 12 and every other modding tool.
2. Remove any custom map VPKs you tested. Custom maps do not work in Valve matches.
3. Check that you changed only the SearchPaths part of gameinfo.gi. Edits to other parts can block matchmaking.
4. Restart Deadlock, so nothing from your test session carries over.

Next steps

Divine is adding Deadlock mods. When they arrive, you'll find them in Explore mods, and you'll publish yours from the Creator Panel.

Credits

This guide is based on the work of these creators. Check out their original guides.

• Guide: Hosting a Local Listen Server and Replacing Sounds from Deadlock Modding Notes.
• Tool: DeadPacker by Artemon121.
• Video: (Read Desc) Deadlock - General Model Swap Steps by Pugzilla.
• Video: (New Tool) Deadlock - Particle Color Change Tutorial by Pugzilla.
• Guide: From Start to Finish (Fuji's Asset Replacement Guide) by Fuji (FellOffFuji).
• Guide: Neutral's General Guide for Modding Deadlock by Neutraldrift.