Making a custom deck

If you want to let the player start a run with a specific ball set, you want to create a custom deck.

First, make sure you've set up your development environment. Make sure you've also created a mod; once both are done, you can move forward to making your custom deck :3

Setup

To make a custom deck, there are 1 (or more) files you need:

• A DeckResource at <mod folder>/overwrites/data/decks_data/<YourName-YourMod-YourDeck>.tres
• If you want any decorations for the deck selection screen, (see Properties) they should be at <mod folder>/overwrites/ui/deck_decorations/<your deck name>-X.png, where X is which decoration it is.
• If you want an icon for the player card in the shop, they should be at <mod folder>/overwrites/ui/deck_diffs_icons/<your deck name>-deck.png

Next, you want to make sure those files are loaded into the game. In your mod_main.gd inside the _init() function, CUE.take_over any necessary files. (See Making a custom ball for how to use CUE.take_over.)

Properties

Next, edit the DeckResource with your desired properties. Here's a cheatsheet for what the properties do:

Cheatsheet

• name: The translation key of your deck's name. To keep things organized, it should be of the form DECK_<your deck name>_NAME
• description: The translation key of your deck's description. To keep things organized, it should be of the form DECK_<your deck name>_DESC
• show_description: Whether this deck should show a description on the deck selection screen
• ball_set: The set to start your run off with, if you select this deck
• balls: An array of 3 ball ids to show on the deck select screen and to start the run off with. The order they're displayed in is bottom, left, right
• requires_achievement: The achievement the player needs to have before this deck is unlocked and selectable
• can_be_chosen: If the deck shows up on the deck selection screen
• available_in_demo: If the deck can be selected in the demo
• deck_particles: Unused
• decoration1 and decoration2: Decoration images that will show up in the background for this deck selection screen
• small_icon: An icon that will show up in the shop in the bottom left of the player card
• id: The id of this deck. It should be the same as the deck's filename (minus the .tres of course)
• main_color: The background color of this deck in the deck selection screen