This is the official continuation of DivisionByZ0rro's original Spell Card Toolkit.
New additions and features include:
This mod is meant to replace the original version, not be used alongside it. Installing both will likely cause problems!!
This mod contains special abilities that allow you to create a new type of card called a 'spell'. Spells are cards that:
In other words, these are cards you play entirely because they have an immediate effect. There are also some additional sigils in this pack that might be useful for you when creating spells.
There are two main types of spells:
These affect a specific space on the board that is selected by the player (or opponent AI).
Use this type if you want to use sigils like 'Direct Damage' (included in this pack) or something like the Beaver's dam creation ability.
These have an immediate, board-wide effect when played, and can be played on any board space.
If you attach a sigil that expects to be in a specific slot on board, there may be unexpected behavior. For example, the Beaver's dam ability will more than likely give Leshy a free dam.
There are additionally two sub-types of spells:
A variant of global spells that trigger immediately upon being selected in the hand, unless they cost Blood to play.
By setting a spell card's hideAttackAndHealth field to 'false' (or using one of the mod's extension methods),
you can make the card's stats display whenever you hover over it.
Use this if you want to create a spell whose effect depends on its stats, or are using this mod's Give Stats ability.
You can also make spell cards show negative stat values by setting the card's extended property Spells:NegativeStats to 'true'.
Original mod by divisionbyz0rro.
This mod would not be possible without signifcant contributions from the Inscryption Modding discord channel.
Pixel icons were contributed by Arakulele.
It can, but it doesn't by default.
If you want the example cards added to the card pool, go to the config file zorro.infiniscryption.sigils.cfg and set 'AddCards' to true.
This will add the following cards:
These cards are not meant to be balanced, but rather to demonstrate how the mod works (hence why they are not added by default).
As with most mods, you need BepInEx installed.
You will also need the API installed.
When a spell is played, it will fire either three or four triggers (depending upon the type of spell) in this specific order.
As a card developer, it is up to you to put sigils (either existing or custom) on the card to actually make it have an effect when played.
When it comes time to select a target for a targeted card, the game will ask the card if it responds to being targeted at that card slot using the 'RespondsToSlotTargetedForAttack' override. It will only allow you to target a spell at a slot if the card says it will respond to being pointed at that slot. Additionally, if the card responds to 'ResolveOnBoard,' the game will allow you to target any of the player's four slots.
The sigils included in this pack are built so that the ones that do harm will respond 'false' when pointed at a player card and 'true' when pointed at an opposing card (and vice versa for sigils that are beneficial). Note that this means if you combine a positive and negative effect on the same card (for example, a spell that increases attack by one but also damages the card for one), that card will be able to target both friendly and enemy cards.
If you are adding sigils that are intended to be used on targeted spells, you need to make sure that the override bool 'RespondsToSlotTargetedForAttack' correctly identifies what slots should be targetable.
So far we have the following:
These sigils do nothing for global spells, but behave as you would expect for targeted spells. Be careful when putting Split Strike on a targeted spell, as it will behave exactly as expected, which is not necessarily intuitive. Rather than affecting the targeted space, it will affect the spaces on either side.
The spell will trigger once for each targeted slot, but only the SlotTargetedForAttack and ResolveOnBoard triggers will fire multiple times. The PlayFromHand and Die triggers will only happen once.
So, for example:
Note that abilities that modify the way cards attack (custom "strike" sigils) are not supported - only Split-, Tri-, and AllStrike.
The best way to add a spell using the API is to also create a reference to this mod's DLL in your project and use the custom extension method helpers SetGlobalSpell() or SetTargetedSpell() to turn a card into a spell:
using InscryptionAPI;
using Infiniscryption.Spells.Sigils;
CardManager.New("Spell_Kettle_of_Avarice", "Kettle of Avarice", 0, 0, "A jug that allows you to draw two more cards from your deck.")
.SetDefaultPart1Card()
.SetPortrait(AssetHelper.LoadTexture("kettle_of_avarice"))
.SetGlobalSpell() // Makes this card into a global spell
.SetCost(bloodCost: 1)
.AddAbilities(DrawTwoCards.AbilityID);
CardManager.New("Spell_Lightning", "Lightning", 0, 0, "A perfectly serviceable amount of damage.")
.SetDefaultPart1Card()
.SetPortrait(AssetHelper.LoadTexture("lightning_bolt"))
.SetTargetedSpell() // Makes this card into a targeted spell
.SetCost(bloodCost: 1)
.AddAbilities(DirectDamage.AbilityID, DirectDamage.AbilityID);
Additional extension method helpers for C#:
To add a spell using JSON loader, you simply need to add either the global spell or the targeted spell special ability to the card:
{
"specialAbilities": [ "zorro.infiniscryption.sigils.Spell (Global)" ]
}
{
"specialAbilities": [ "zorro.infiniscryption.sigils.Spell (Targeted)" ]
}
{
"specialAbilities": [ "zorro.infiniscryption.sigils.Spell (Global, Instant)" ]
}
Spell cards with a Health or Attack above or below 0 will automatically be converted to stat spells; this can be disabled by setting the CardInfo's "hideAttackAndHealth" to "true" when creating your card.
If you want your spell card to be able to display negative stat values, or want to disable this behaviour,
set the extended property Spells:NegativeStats to 'false'.
To create a spell card that can never be buffed at the campfire, you need to add this mod's special Trait:
{
"traits": [ "zorro.infiniscryption.sigils.NeverBoostStats" ]
}
Don't worry about adding the Stat Icon to your card; the mod will do it for you.
It's been a while since you've heard from me. Life changes quickly. I got a bad case of Covid, I had family members get seriously injured, and was just generally unavailable for a while.
Working on this and other Inscryption mods has been an amazing collaborative journey over the past months. Ever since I completed Inscryption for the first time in the fall of 2021, I spent all of my spare time (and then some) working on modding this game and being a part of an incredible community. But unfortunately, things change, and I cannot keep this up moving forward. I simply don't have the same amount of spare time that I used to, and it's time for me to move on.
I have nothing but gratitude for everyone who supported me and helped me accomplish what I have been able to accomplish. I know I'm leaving work unfinished, but I know that would be true no matter when I called it quits.
If anybody wants to continue any of my work, I hereby grant unrestricted permission for anyone to fork any of projects and make it their own moving forward. This work was always a passion project for the community, and I would be honored if anyone on the community wanted to continue that work. Please feel free to copy anything I've done and use it for yourself.
Thanks for everything, /0