Welcome to the Monster Girl Dreams Modding Documentation for v27¶
Create and modify game content the exact same way Threshold makes game content. Complete coverage of all possible features and systems, featuring a quick starter guide from the first minutes in making a basic mod, all the way to publishing mods.
It is assumed readers are already experienced with the game and understand its various stats by hovering over them in the in-game character menu's 'Stats' tab.
Potential game spoilers ahead.
Warning
Monster Girl Dreams is still in active alpha development. Mods you make aren't guaranteed to work with the latest version of the game. Your mods are entirely up to you to maintain, unless someone decides to patch your mod for you. Warning sounds scarier than it actually is.
Is Modding Hard?¶
Most will find that the things they thought were going to be hard while modding, were actually the easiest parts. You will not read or touch a single line of actual code, just using already predefined actions with basic checks. This multiple choice scene for example, is in a minimal format very close to writing in plain english what you want to happen.
"Speak", "Perpetua",
"What will it be, [ThePlayerName]?"
"Menu",
"'You will never defeat me!'",
"'I just want to go home...'",
"'Wanna hold hands?'",
"EndLoop"
As long as you are not actively avoiding testing in-game till the end of development, your more likely problem will be writing the actual content players will read. The challenge of the natural creative process has led to far more struggling modders than any potential 'technical' or 'complicated' problems while modding.
Beginning the tutorial in the Getting Started section should only take minutes to get to visible results in-game you can toy with, even if you have never modded any other game before.
Navigating The Docs¶
All topics and pages in the documentation can be found using the navigation menu to the left.
Use the 'Search' box in the top right to quickly find specific information you're looking for. It will try to autocomplete your words.
Your browser supports searching for words on any page as well.
You can press Ctrl + F
or ⌘ + F
to open it at any time.
See the overview below for a summary of the documentations layout.
Getting Help¶
If you're having trouble, there are a couple of options:
- Try looking through the FAQ.
- Ask yourself once more what you need to know in its most specific fundamental
steps, then try navigating the navigation menu down to the most relevant topics.
For example,
I need to learn how to add an item I made as a drop to a Blue Slime, which is a monster, so I should check for information on Monsters. I see there is a section for Monsters under the JSON Manual. It says to check out Monster Additions for adding to existing content. It shows how to get a blank template. It looks like I can add the item to the
itemDropList
object field and then test in-game, I will give it a guaranteed drop rate for now to make sure. - If all else fails, you're encouraged to try getting help on the MGD Discord.
There are knowledgeable, depraved, and friendly people who may be able to help you.
Head to the
#modding-help
forum channel towards the bottom of the channel list.
Overview¶
-
Getting Started
If you are working on your first mod, starting here is highly recommended.
-
Tutorials
Specialized tutorials on specific modding situations for novice to advanced modders.
-
JSON Manual
Comprehensive information on each type of JSON modders can use to add and modify game content.
-
Reference
General information you will consistently use while modding, from how to embolden text, available options for stats and stances, updating to incompatible mods to newer versions, and more.
-
Function Reference
Everything there is to know about functions, used for scripting your content with choices, progression, specialized combat behavior, and more. Modders refer to this section while writing content the most!