The system allows for custom modules, which add more content to the system!

This may be helpful:
https://steamcommunity.com/sharedfiles/filedetails/?id=2574693146

• This template![github.com]
  
• If you are creating a new dungeon from scratch, you will need Tiled - see my guide for more info
  
• A text editor that is not windows notepad, I suggest Notepad++ but feel free to use anything you're familiar with, this is just JSON you are editing, not real code.
  
• An image editor, or art program. I suggest paint dot net, however any will work as long as it supports transparency and is not GIMP.
  
• A brain, this is necessary for most actions but if you do not have one, feel free to ask for help! I will help if I get time!

Before we begin, all instances of MODNAME must be the same!

1. Start by downloading this patch template[github.com]
   
2. Navigate to
   /interface/scripted/cityscaper/modules/
3. Rename the folder MODNAME with your mods name. *
   
4. Enter the icons folder and name MODNAME with your mods name. Change the icon to be whatever your like, but avoid changing the size of it to avoid inconsistencies and conflicts.
   
5. Return back to the modules folder, and open
   neb-cityscaper-modules.config.patch
   in your text editor.
   
6. At the top of the file is a template that is also attached here.
   
   { "shortDescription": "Your Dungeon Name", "dungeonSize": [5, 10], //the x, y size of the dungeon "dungeon": "PREFIX-YOURDUNGEONNAME", "previewImage": "/interface/scripted/cityscaper/modules/MODNAME/PREFIX-YOURDUNGEONNAME.png", "cost": { "money": 50000, "essence": 10000 } }
7. Replace PREFIX-YOURDUNGEONNAME with the dungeon that this specific one will be adding, and place it under rooms, prefabs or dungeons. **
   
8. Adjust the costs to what you believe it should cost for your item.
   
9. Navigate to
   /dungeons/cityscaper/
   and place your dungeon in whichever folder it belongs in.**
   
10. Ensure the dungeon name matches the PREFIX-YOURDUNGEONNAME from earlier.
    
11. If your game is open, do /reload, and your changes will be applied! If the game crashes or your file does not appear, you likely made an error! See troubleshooting for more info.

* Try to have a prefix, such as neb- to your mod, I use neb- as this is my name and signature. This prevents conflicting mod names. For example, neb-shellguard. If you do not do this, your content will be merged with other modules of the same name which means they will appear in the same list, or may overwrite each other. This can be intended on your end.
** Rooms are singular rooms, Prefabs are prebuilt houses, or parts of bigger houses, while Dungeons are full builds, like dungeons or full built mansions.

If you are a mod developer of your own mod, you can add compatibility built into your mod with test patches, however as I do not know the ins and outs of these yet, I will have to get back to you on how to do that later.

While modding you will encounter errors, its guaranteed since nobody but me is perfect.
If you encounter an error, go to your local files, navigate to and find the file called ENSURE THERE ARE NO NUMBERS, these are old versions of the log and will not contain the error. Scroll down to the bottom and find the line that has ERROR at the start of it, and read it, it will usually tell you which file failed. Then take it to a json linter and see where you went wrong!

This guide will be updated when I get more time, thanks for reading!