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.
2. If you're downloading it from its Github page, follow this installation guide.
3. 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.
4. Download and install the Inscryption API mod following its manual installation guide.
5. Find the BepInEx > plugins folder.
6. 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

Field — Explanation

FileName — The name of your mod. This is the name that will be displayed in the dialogue selection screen when the player hovers over your file.

Description — The description of your custom dialogue mod. If you don't want to spoil what lines you replaced, that's fine too!

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.

| Field | Dialogue