Adding collectibles - Pandemonium14/ExoLoader GitHub Wiki

Instructions on how to add custom collectible cards.

Like other content, collectibles are added by creating a folder in the Exocolonist/CustomContent folder. Create a folder named Collectibles inside your content folder. The folder structure should be: Exocolonist/CustomContent/YourFolderName/Collectibles. Each collectible should have its own .json file and corresponding .png image file in this folder.

Creating the data file

Mandatory Entries

  • An ID entry. This will be used to identify your collectible internally. It cannot contain special characters and should be unique.
  • A Name entry. This is the singular display name of your collectible (e.g., "Template", "Crystal", "Flower").
  • A Plural entry. This is the plural form of your collectible's name (e.g., "Templates", "Crystals", "Flowers").

Optional Entries

Acquisition Properties

  • A HowGet entry. Determines how the collectible can be obtained:
    • none - default value for most of the collectibles in the game
    • shopDefault - Available in Supply Depot (same as Cake)
    • shopClothes - Available in Supply Depot with the first perk from "Creativity" skill
    • shopWeapons - Available in Supply Depot with the first perk from "Combat" skill
    • shopGadgets - Available in Supply Depot with the second perk from "Engineering" skill
  • A Kudos entry (number as string). The cost in Kudos if the collectible can be purchased.

Character Preferences

  • A Like entry. Comma-separated list of character IDs who will like receiving this collectible as a gift. (Typically you always want to add sym to the list, he likes everything)
  • A Dislike entry. Comma-separated list of character IDs who will dislike receiving this collectible as a gift.

Note: for custom characters you can either add your custom collectible to the like/dislike of the character directly or via collectible property, either way should work. These fields are here mostly so you can update existing character preferences.

Artist Credits

  • An ArtistName entry. Credit for the collectible's artwork.
  • An ArtistSocialAt entry. Social media handle for the artist.
  • An ArtistLink entry. Link to the artist's social media or other page.

Abilities

Collectibles can have up to three abilities defined as Ability1, Ability2, and Ability3. Each ability entry contains:

  • ID - The ability identifier (for example, collectiblePlus, collectiblePlusSuit, collectibleDraw, collectibleNewHand)
  • Value - The numerical value for the ability (as string)
  • Suit - The suit the ability applies to (if applicable)

Example Collectible

Here's an example of a custom collectible:

{
    "ID": "templatecollectible",
    "Name": "Template",
    "Plural": "Templates",
    "HowGet": "shopDefault",
    "Kudos": "10",
    "Like": "sym, dys, template",
    "Dislike": "tang",
    "ArtistName": "Poayo_",
    "ArtistSocialAt": "",
    "ArtistLink": "",
    "Ability1": {
        "ID": "collectiblePlusSuit",
        "Value": "2",
        "Suit": "mental"
    },
    "Ability2": {
        "ID": "",
        "Value": "",
        "Suit": ""
    },
    "Ability3": {
        "ID": "",
        "Value": "",
        "Suit": ""
    }
}

Adding Collectible Images

Each collectible requires a corresponding .png image file with the same name as the .json file. For example, if your collectible data file is named templatecollectible.json, you need an image file named templatecollectible.png in the same Collectibles folder.

The image will be displayed as the collectible's artwork when viewed as a card in the game.