BlackMagicAPI

BlackMagicAPI

BlackMagicAPI is a powerful BepInEx plugin that simplifies the process of adding custom spells to Mage Arena. The API provides an intuitive framework for spell, item, crafting recipe, and soup creation, handling all the complex backend systems so modders can focus on design and effects.

Features

• Simplified Spell Creation: Create new spells with minimal boilerplate code
• Simplified Item Creation: Create new weapons, and tools with minimal boilerplate code.
• Simplified Crafting Recipe Creation: Define new crafting recipes with minimal boilerplate code.
• Simplified Soup Creation: Add new stew effects with minimal boilerplate code.
• Automatic Networking: Handles multiplayer synchronization automatically
• Resource Management: Built-in asset loading system

Installation

1. Prerequisites:

• Mage Arena with BepInEx 5.4.21 or newer
• FishUtilities
• ModSync

1. Installation:

   MageArena/
   └── BepInEx/
       └── plugins/
           └── BlackMagicAPI
			   └── BlackMagicAPI.dll

Changelog

v3.0.2

• Fixed item drop sound not working.

v3.0.1

• Use ModSync Notifications for failed registration.

v3.0.0 (Major Update)

• Updated function parameters in SpellLogic.
• Updated function parameters in ItemBehavior.
• Added compatibility checks for future updates.
• Outdated mods registration now automatically fail.

v2.6.3

• Add public static string BlackMagicSyncHash

v2.6.2

• Fixes on scene load.

v2.6.1

• Updated default bowl texture.

v2.6.0

• Added ability to create custom soups.
• Added RegisterSoup to BlackMagicManager.
• Added SoupData class.
• Added SoupEffect class.

v2.5.0

• Added GetData to Spell
• Made Plugin in Spell and Item Data public.
• Fixed issues with RegisterCraftingRecipe.

v2.4.0

• Added LastOwner to ItemBehavior.
• Added OnItemDropped to ItemBehavior.
• Added SetDefaultTransforms to ItemBehavior.
• Added SetTransformOnCraftingForge to ItemBehavior.
• Added AddColliderToPrefab to ItemBehavior.

v2.3.2

• Added GetSpellLogicPrefab to BlackMagicManager.
• Backend cleanup.

v2.3.1

• Added KeepOnDeath to ItemData.
• Added KeepOnDeath to SpellData.

v2.3.0

• Added Spell to to access spell instances.
• Added IsPrefab to SpellLogic.
• Added OnItemEquipped to ItemBehavior.

v2.2.1

• Publication of source code.
• Backend cleanup.

v2.2.0

• Added the ability to spawn items as host with BlackMagicManager.SpawnItem
• Added the ability to spawn spell pages as host with BlackMagicManager.SpawnSpell
• Added the ability to get item prefab with BlackMagicManager.GetItemPrefab
• Added the ability to get spell page prefab with BlackMagicManager.GetSpellPagePrefab
• Add xml documentation.

v2.1.1

• Update to FishUtilities v1.1.0 which fixes all desyncing issues!

v2.1.0 (Major Update)

• Added PageController parameter to CastSpell in SpellLogic.
• Added OnPageItemUse in SpellLogic.
• Added SubNames virtual override for SpellData.
• Fixed folder structure for mod managers.
• Now when a update releases that's incompatible with mods using older versions of BlackMagicAPI it will be labeled (Major Update)

v2.0.4

• Added FishUtilities as Hard Dependency.

v2.0.3

• Backend fixes.

v2.0.2

• Completely fixed mod desyncing.
• Added LoadAssetBundleFromDisk and LoadAssetBundleFromResources to Utils.

v2.0.1

• Added nine digit synchronization number at the bottom right of the main menu, use this hash to determine that all clients will be synchronized.

v2.0.0 (Major Update)

• Added the ability to register custom death icons.
• Moved all registering functions to BlackMagicManager.

v1.8.0 (Major Update)

• Added the ability to register spells in custom recipes, they must be inherited SpellLogic or ISpell, which allows custom and vanilla spells to be registered.

v1.7.0 (Major Update)

• Added the ability for spells, and items spawn in the Coloseum.

v1.6.0

• Added the ability to create custom item recipes with vanilla and custom items.

v1.5.0 (Major Update)

• Added the ability to create custom items.
• Added the ability to load .Wav audio files.
• Added to have spells spawn in the team chest.
• Added debug featuring that forces spells or items to spawn in the team chest at a 100% chance.

v1.4.1

• Added documentation

v1.4.0

• Added the ability to synchronize data in spell logic with overrides WriteData, and SyncData.
• Added the ability to customize UI Sprints with a "YourSpellName_Ui.png" file in the Sprints mod folder or manually overriding it with GetUiSprite in SpellData

v1.3.0

• Backend cleanup.

v1.2.0 (Major Update)

• Fixed huge oversight of Prefab ids being desynced between clients.
• Automatic spell sprites now have to be spaceless, for example "Cool Spell Name" has to be "CoolSpellName_Main.png" for the sprite to be registered

v1.1.0

• Added ModSync dependency.

v1.0.0

• Initial release.