TVFLabs-CustomSideDeck icon

CustomSideDeck

Change the side deck to something other than squirrels! Lots of options for making your own side deck with JSON Loader (or C#). Works with Side Deck Selector!

By TVFLabs
Last updated a day ago
Total downloads 31958
Total rating 8 
Categories Tweaks Libraries Misc Kaycee's Mod
Dependency string TVFLabs-CustomSideDeck-2.3.1
Dependants 14 other packages depend on this package

This mod requires the following mods to function

API_dev-API-2.22.3 icon
API_dev-API

The de-facto standard core API for all Inscryption mods. This lets you create new cards, abilities, challenges, map nodes, starter decks, and more.

Preferred version: 2.22.3

README

TVFLabs's Custom Side Deck

This mod lets you change the side deck to something other than squirrels, and allows changing the number of cards in the side deck, having more than one type of card in the side deck, having cards be selected when starting the run, and even displaying custom card backs.

About the Side Deck Selector mod

This mod should work alongside Side Deck Selector for the most part, but you should be aware of a few things:

  • CustomSideDeck and Side Deck Selector will both display their own separate side deck selection screen when starting a run. Side Deck Selector's screen will show up first, then CustomSideDeck's screen will appear when you choose a Side Deck Selector side deck.
  • No matter what side deck you choose from Side Deck Selector, the CustomSideDeck side deck you select will take priority.
  • CustomSideDeck's side deck selection screen will display side decks from Side Deck Selector, but not the other way around.
  • The side deck choice node added by Side Deck Selector's challenge hasn't been tested with CustomSideDeck, but I doubt it would work at all.
  • Currently, CustomSideDeck doesn't support changing your side deck partway through a run. Aside from that, though, I'm fairly sure every other feature in Side Deck Selector exists in CustomSideDeck as well.
  • Side Deck Selector works with P03 in Kaycee's Mod, but CustomSideDeck does not.

Config options

  • GenerateDefaultCardBacks:
    • How the mod should handle side deck card backs for side decks that don't add their own custom card back. If enabled, automatically generates a unique card back based on the side deck's main card's portrait. Otherwise, the default squirrel back will be used.
      • I personally like the way this looks, but a lot of people hated it so it's off by default now.
  • GenerateAquaVersions
    • Whether to automatically add an Aqua version of all custom side decks.
      • This one is very buggy, and I'd recommend keeping it disabled. But it's there if you want to use it.
  • ShowAquaSideDecksWhenSquirrelFishChallengeDisabled
    • Whether or not Aquasquirrels and custom side decks marked as CSDIsAqua should be shown as options even when the Squirrel Fish challenge isn't on.
      • This does not affect which side decks are available when Squirrel Fish is enabled.

How to use (with JSON Loader):

Basic Side Deck:

"extensionProperties": {
  "CSDIsSideDeck": "true",
  "CSDSideDeckType": "Basic"
}

Basic side decks work like most side decks: they have 10 copies of one type of card.

Set Count Side Deck:

"extensionProperties": {
  "CSDIsSideDeck": "true",
  "CSDSideDeckType": "SetCount",
  "CSDNumCards": "3"
}

Set Count side decks are like Basic ones, except that you can set the number of cards in the deck using the CSDNumCards extension property.

Configurable Side Deck:

"extensionProperties": {
  "CSDIsSideDeck": "true",
  "CSDSideDeckType": "Configurable",
  "CSDNumCards": "10",
  "CSDNumOptions": "4",
  "CSDOption1": "Squirrel",
  "CSDOption2": "Bee",
  "CSDOption3": "Rabbit",
  "CSDOption4": "Geck",
  "CSDCanEditDuringRun": "true"
}

Configurable side decks allow the player to choose which cards to put in the side deck before they start the run. Clicking on a card in the Configure Side Deck screen cycles through the options. There are CSDNumCards cards in the deck, each of which can be any of the CSDOptions. Make sure that the number of CSDOption properties is the same as the value of CSDNumOptions, or it won't work. CSDCanEditDuringRun makes it so that the player can edit their selected cards during a run instead of just at the very beginning, similar to how Gem Vessels work in Act 3.

Advanced Side Deck:

"extensionProperties": {
  "CSDIsSideDeck": "true",
  "CSDSideDeckType": "Advanced",
  "CSDNumCards": "5",
  "CSDCard1": "Squirrel",
  "CSDCard2": "Bee",
  "CSDCard3": "Rabbit",
  "CSDCard4": "self",
  "CSDCard5": "conf",
  "CSDNumOptions": "2",
  "CSDOption1": "Cat",
  "CSDOption2": "Goat",
  "CSDCanEditDuringRun": "true"
}

Advanced side decks can do everything that the other types of side decks can, and they also allow setting a specific amount of each type of card. In any of the CSDCard properties, you can enter the name of a card directly, or, alternatively, you can enter self or conf. CSDCards set to self will be the card the extension properties are on, while CSDCards set to conf will act like the cards in a Configurable side deck. Make sure that the number of CSDCard properties is the same as the value of CSDNumCards, and that the number of CSDOption properties is the same as the value of CSDNumOptions or it won't work. CSDCanEditDuringRun works the same as in a configurable side deck, as long as your side deck has some amount of conf cards.

Bonus Properties:

"extensionProperties": {
  "CSDIsSideDeck": "true",
  "CSDSideDeckType": "Basic",
  "CSDCardBack": "AquaBee_back.png",
  "CSDIsAqua": "true",
  "CSDChallengePoints": "-5"
}

These properties can be used by any kind of side deck. When CSDCardBack is set to a 125 by 190 pixel PNG file, that image will render in place of the standard side deck back. Check the mod's folder for a template image. There are a few default images available. Instead of the path to a PNG file, you can choose to use these:

  • squirrel will use the Squirrel side deck back from the base game
  • bee will use the Bee side deck back from the base game
  • aquasquirrel will use the Aquasquirrel side deck back (which is just the Waterborne card back)
  • blank will use a generic blank back with no icon
  • gen will make a side deck back automatically based on the main card's portrait

If CSDIsAqua is set to true, the side deck will be selectable when the Squirrel Fish challenge is enabled. You can use this to make Aquasquirrel-style variants of your custom side decks.

The value of CSDChallengePoints will be added to the player's challenge points when they use the side deck in a run.