Hero Template

Templates

This is a simple template for Heroes.

See my guide in the Across the Obelisk Discord or below more information.

Full Guide

How to Create a Custom Hero

Hi everyone, with the release of a couple new heroes, I thought it would be a good idea to teach everyone how to do it themselves. If I am missing out on anything in the guide or anything is unclear, let me know.

Before I begin, the big difficulty with creating heroes is creating their levels 1, 3, and 5 traits (which I will just call Traits from now on, I will refer to the level 2 and level 4 upgrades as Enchantments). These Traits need to be coded in C# and are essentially arbitrary code execution. So they can do practically anything you want. Because of this, I would recommend designing the Traits and then pinging me to actually do the coding for you :)

Now for the actual guide (adapted and updated from: https://code.secretsisters.gay/AtO_How_To):

Guide

For those of you who want more control over how you create your hero (or don’t want me to do as much work), here is a more in-depth guide. This mainly consists of json files that will be directly loaded by Obeliskial Content/Essentials into the game.

To simplify this process, I created a template of all the files necessary to create a hero.

For your convenience, all of the fields which are mandatory/highly recommended for you to fill out have a field have been replaced by a description inside <>s.

For instance, if your character is named Ursur, then ` should be replaced by ursur while would be replaced with Ursur`. Hopefully it is intuitive. If you need help, just ping me.

Additionally, I highly recommend

Step 1: - Setup

Manually Download the Hero Template from Thunderstore. This is a zip that contains the following BepInEx\config\Obeliskial_importing folders:

#### The folders:
 1. audio

1. card
2. cardback
3. gameObject
4. pack
5. skin
6. sprite
7. subclass
8. trait

Plugins

There is also an empty BepInEx\plugins folder. This is where you will place the .dll that includes the traits/some bonus code. I will send this .dll file to you. If you have C# experience, you can create your own traits using the following **Template**

Step 2: Creating your subclass

The most important file in the template is the one found in the subclass folder. This pretty much contains all of the information needed for your Hero. Everything else is just refining and filling out the remainder.

These are the following properties you will need to add/change for your Hero:

• ActionSound: Skip this one, it isn’t used
• AutoUnlock: Sets whether your hero is unlocked by default or needs to be unlocked via quest. Just leave this one as true

- Cards: An array showing the 15 cards that the subclass starts with. There can be a maximum of 7 unique cards. By convention, at least one of these should be a unique/starter card.
 - ChallengePack[0-6]: These are the packs offered in Obelisk Challenge. Pack0 is your starter pack, and packs 1-6 are the six remaining packs. See the Packs section for more info.

• CharacterDescription: A short history of the character (approximately 2 paragraphs). Appears when the character is selected in the Hero Selection screen.
• CharacterDescriptionStrength: A one-line description of the character’s strengths.
• CharacterName: The character’s name.
• Energy: The character’s starting energy. (This is 1 for every hero unless you specifically want to change that)
• EnergyTurn: The amount of energy the character gains each turn. (This is 3 for every hero unless you specifically want to change that)
• Female: Set to true if the character should use female action sounds on cards where available (e.g. Battle Cry makes a different noise when Bree plays it than when Magnus plays it).
• FluffOffsetX: Horizontal offset for fluff text on played cards - pretty much ignore this one
• FluffOffsetY: Vertical offset for fluff text on played cards - pretty much ignore this one
• HeroClass: The character’s class. (i.e. Warrior, Scout, Mage, Healer)
• HeroClassSecondary: Secondary class for dual-class heroes, or “None” if they have only one class.
• HitSound: Sound made when the character takes damage.
• HP: Base max HP.
• ID: The name of your subclass. I would keep it the same as your file name. Lowercase only, no spaces. Must be the same as the SubclassName
• Item: The ID for their unique item
• MaxHP: An array of numbers corresponding to the increase in max HP per level.
• OrderInList: The order that this character appears within its class. Slots 1-4 (corresponding to values 0-3 in this property) are used for vanilla classes. Choosing a value of 0-3 will replace a vanilla hero. Choosing 4 or 5 will put them into the corresponding “modded” hero slot. Numbers ≥6 will not work (for now)
• Resist[DamageType]: Base resistances in %.
• Speed: Base speed.
• SpriteBorderLocked: The filename for the image shown on the Hero Selection screen when the character has not yet been unlocked.

Do not include the .png file extension in the name! I.e if your sprite is named mySpriteBorderLocked.png, enter mySpriteBorderLocked.

• Sticker[Type]: The filename for the character’s stickers (used with the “target” and “heal” emotes).

Do not include the .png file extension!

• StickerOffsetX: Horizontal offset for stickers.
• SubclassName: The name of the character’s class (e.g. Mercenary, Cleric, Elementalist), shown on the Hero Selection screen when they are selected. Must be the same as the ID (but can be capitalized)
• Trait[s]: The ID for the character’s traits and enchantments. 0 is the innate, 1 is level 2, 2 is level 3