Crypt of the NecroDancer Steam Workshop Instructions

OVERVIEW

Crypt of the NecroDancer's Steam Workshop integration allows you to download mods and dungeons created by other users, or create and share your own masterpieces! Mods allow the game's graphics, music, sounds, and XML data to be altered, completely changing the look and feel of the game. Dungeons allow players to experience hand-crafted content, rather than the game's default procedurally generated zones.


DOWNLOADING MODS
  1. First, visit the game's Steam Workshop page: http://steamcommunity.com/app/247080/workshop/
  2. If desired, you can click the "Mod" link in the "Browse By Tag" area on the right side of the screen.
  3. Look through the mods and click on one you like.
  4. Click the "Subscribe" button to indicate that you'd like to download the mod.
  5. Start "Crypt of the NecroDancer" via Steam. (Or, if it was already running, you will need to restart the game.)
  6. Get to the lobby and hit ESC. Select "MODS" from the pause menu.
  7. Select "PLAY A MOD" then find the mod you downloaded and select it.
NOTE: If you use a mod that alter's the game's XML data you will see a warning. Such mods prevent you from submitting high scores or unlocking achievements. This is to prevent cheating!


DOWNLOADING DUNGEONS
  1. First, visit the game's Steam Workshop page: http://steamcommunity.com/app/247080/workshop/
  2. If desired, you can click the "Dungeon" link in the "Browse By Tag" area on the right side of the screen.
  3. Look through the dungeons and click on one you like.
  4. Click the "Subscribe" button to indicate that you'd like to download the dungeon.
  5. Start "Crypt of the NecroDancer" via Steam. (Or, if it was already running, you will need to restart the game.)
  6. Get to the lobby and enter the "Level Editor" staircase at the bottom right. (If the staircase is locked you'll need to complete Zone 3 to unlock it.)
  7. Select "Load Dungeon" from the list.
  8. Select "Steam Workshop" to check the checkbox.
  9. Find the dungeon you downloaded in the list and select it.
  10. Select "Play Dungeon!" from the list.
NOTE: Achievements and high scores can not be earned while playing custom dungeons.


CREATING MODS
  1. Navigate to the game's install folder.
  2. Open the "mods" subfolder and create a folder inside it with the name you'd like to use for your mod.
  3. To modify a certain file, find it in the game's /data/ subfolder and then copy it to your new mod folder (preserving directory structure). Then edit the file as you see fit
  4. For example, to modify the way a white skeleton looks, copy the /data/entities/skeleton.png file to /mods/YOUR_MOD_NAME/entities/skeleton.png and then modify it.
  5. If you copy over the /data/necrodancer.xml file and edit it, you will have control over many properties of the game's enemies, items, and NPCs.
  6. If you'd like to add a preview thumbnail image for your mod, add a JPG at this location: /mods/YOUR_MOD_NAME.jpg (Replace "YOUR_MOD_NAME" with a case-sensitive copy of your mod folder's name. Ensure that the JPEG is less than 1MB in size.)
  7. Once you've copied over and modified all the files you wish to modify, open the game.
  8. Go to the lobby, hit ESC, and select "MODS".
  9. Select "PLAY A MOD" and select your mod in the list to test it.
  10. When satisfied with your mod, return to that "MODS" menu and select "PUBLISH A MOD".
  11. Select your mod in the list to upload it to Steam Workshop.
  12. Then, visit the game's Steam Workshop page and find your mod.
  13. From the Workshop site you can edit your mod's title, description, images, links, etc.
NOTE: YOU are responsible for the content you upload, and are only permitted to upload files that you've created yourself!
NOTE: Image files MUST be the same pixel dimensions after you make your modifications to them!
NOTE: If you modify music files, be sure to include appropriate beat data .txt files. Also, you may want to modify the shopkeeper singalong tracks in the /sounds_streaming/ subfolder.


CREATING DUNGEONS
  1. Start "Crypt of the NecroDancer" via Steam.
  2. Get to the lobby and enter the "Level Editor" staircase at the bottom right. (If the staircase is locked you'll need to complete Zone 3 to unlock it.)
  3. Use the various tools available via the Level Editor to create a level.
  4. If you wish to have multiple levels in your dungeon, select "Add Level".
  5. If you'd like to add a preview thumbnail image for your dungeon, navigate to the game's install folder and add a JPG at this location: /dungeons/YOUR_DUNGEON_NAME.jpg (Replace "YOUR_DUNGEON_NAME" with a case-sensitive copy of your dungeon's filename. Ensure that the JPEG is less than 1MB in size.)
  6. When satisfied with your dungeon, select "Save Dungeon" and then "Publish Dungeon".
  7. Then, visit the game's Steam Workshop page and find your dungeon.
  8. From the Workshop site you can edit your dungeon's title, description, images, links, etc.


Have questions? Visit our forums to find help!