JSON Boss Dialogue

This is a BepInEx plugin mod made for Inscryption. This mod lets you load custom dialogue for all bosses in Kaycee's Mod with a JSON file.

It adds a custom menu screen to Kaycee's Mod, which looks like this:

This mod doesn't change your original game files and shouldn't affect your main game save data, but making a backup of your save file before installation is still advised.

Installation

This mod’s only dependencies are BepInEx and the InscryptionAPI mod.

There are two ways of installing this mod: with the help of a mod manager (like r2modman or the Thunderstore Mod Manager) or manually.

Installation (Mod Manager)

1. Download and install r2modman or the Thunderstore Mod Manager.
2. Install this mod and all of its dependencies with the help of the mod manager!

Installation (Manual)

1. Download and install BepInEx.
   1. If you're downloading it from its Github page, follow this installation guide.
   2. If you're downloading "BepInExPack Inscryption" from Thunderstore, follow the manual installation guide on the Thunderstore page itself. This one comes with a preconfigured BepInEx.cfg file, so it's advised.
2. Download and install the Inscryption API mod following its manual installation guide.
3. Find the BepInEx > plugins folder.
4. Place the contents of "JSONBossDialogue.zip" in a new folder within the plugins folder.

Creating the JSON File

When making the JSON file for your custom dialogue, you should be mindful of the following:

1. Your JSON file’s name must end in _bd.json. This is required in order for this mod to find it.
2. Your JSON file can be anywhere in the BepInEx/plugins folder, including subfolders. (And yes, you can put it in the same folder as your own mod.)
3. None of the fields are required, but it's strongly encouraged you put something in the 'FileName' and 'Description' fields so that your file is easy to identify in the dialogue selection screen inside the game.

If you don't know how to create a JSON file, an easy way to do it is creating a .txt file and renaming it to end in .json.

Afterward, paste the following into the file:

{
	"FileName": "",
	"Description": "",
	"Prospector": {
        "PreIntro": "",
		"Intro": "",
		"BeforePickaxe": "",
		"AfterPickaxe": "",
		"IfNoGold": "",
		"MuleKilled": ""
	},
	"Angler": {
		"PreIntro": "",
		"Intro": "",
		"GoFish": "",
		"AimingHook": "",
		"EasyChoose": "",
		"HookPull": ""
	},
	"TrapperTrader": {
		"PreIntro": "",
		"Intro": "",
		"PrePhase2": "",
		"Phase2": "",
		"PreTrade": "",
		"Trade": "",
		"PostTrade": ""
	},
	"Leshy": {
		"Intro": "",
		"AddCandle": "",
		"Deathcards_Intro": "",
		"Deathcards_Outro": "",
		"PreMoon": "",
		"MoonPlayed": "",
		"StinkyMoon": "",
		"MoonDestroyed": ""
	},
	"Royal": {
		"LeshyConfusion": "",
		"WakeUp": "",
		"PreIntro": "",
		"Intro": "",
		"Cannons": "",
		"CannonFire": "",
		"Rodents": "",
		"Limoncello_Charge": "",
		"LeshyStop": "",
		"Limoncello_Intro": "",
		"Limoncello_Mutinee": "",
		"Limoncello_NoCards": "",
		"Limoncello_Sunk": "",
		"Defeated": "",
		"Farewell": ""
	}
}

Your custom dialogue should go between the second pair of quotation marks in each line. Be sure not to erase any commas!

All custom dialogue can only be one line, regardless of how many lines there normally are in the corresponding original dialogue. I'm sorry, but it's simpler that way. I may add support for multiple lines eventually, though!

Empty Fields

You can leave as many fields empty as you wish. If a field is empty, the mod will let the game play the regular dialogue for the corresponding part.

You can erase any fields, so long as you're mindful of JSON syntax!

For example, let's say I'm making a mod that replaces the Pack Mule with an Unicorn, and I want to add custom dialogue for the Prospector only when he talks about his Pack Mule, making him talk about my unicorn instead. I can simply do:

{
        "FileName": "Unicorn Mod",
        "Description": "Changes Prospector dialogue so he'll talk about my Unicorn.",
        "Prospector": {
                "MuleKilled": "YE COWARD!! THAT UNICORN WAS DEFENSELESS!!"
        }
}

And this should be all I need! No need to include the Angler or Trapper/Trader fields, for example.

If you're struggling with JSON syntax, you can use an online JSON validator. There are quite a few. I personally like JSONLint!

And here's an explanation of what each field is for:

Filename & Description

And here's an explanation of each field and the dialogue lines they replace:

Prospector

You can use this to change the Prospector's dialogue lines during his boss fight.

Angler

You can use this to change the Angler's dialogue lines during his boss fight.

Trapper / Trader

You can use this to change the Trapper/Trader's dialogue lines during their boss fight.

Leshy

You can use this to change Leshy's dialogue lines during his boss fight.

Note: The "StinkyMoon" line will not play during Kaycee's Mod thanks to the Moon's "Made of Stone" sigil, and since this mod only works with Kaycee's Mod, this field does nothing. I'm only including the "StinkyMoon" field in case I decide to do something with it in the future.

Royal

You can use this to change Royal's dialogue lines during his boss fight.

Important Notes

A few things you should keep in mind about your JSON file:

• You can have as many _bd.json files in the BepInEx/plugins directory as you wish. Two different mods that use this custom dialogue mod are perfectly compatible with each other.
• This mod may not be compatible with other mods that change boss dialogue.
• Validating your JSON with the help of an online tool can save you a lot of time and headache! Just look up "JSON Validator".
  • An online JSON validator tool I personally like is JSONLint, it's neat!
• Feel free to use a _bd.json file for custom dialogue when making your own mod! So long as you set this mod as a dependency, it should work.

Help

Q: "I got an error that says no _bd.json file could be found! What do I do?"

A: Double-check your JSON file. Make sure it ends in _bd.json and that it's somewhere inside of the BepInEx/plugins folder.

Q: "I got an error that says it could not load JSON from my _bd.json file! What does this mean?

A: It means there's something wrong with your file. Make sure you didn't make any mistakes with the JSON syntax (i.e. erasing any commas).

As I mentioned in the "Important Notes" section above, using an online JSON validator tool can help you a lot with this. I personally like JSONLint, it's neat!

Q: "Does this mod support color codes?

A: I don't think so...?? I haven't tested it enough! If you can get color codes working though, you should totally let me know!

Credits

This project uses Newtonsoft.Json for parsing JSON data.

Newtonsoft.Json's license can be found here.