Hexenkraft Mana Library

Mana is the main resource used to cast any form of magic. By default, a player can hold up to 1000 mana, once they reach that point, they simply stop regenerating. Without any modifiers, 5 mana points are regenerated per second. Through armor pieces, potions or other sources it's possible to not only increase the amount of mana/second a player regenerates but also to unlock up to 1000 points of overflow mana.

Each point of overflow mana allows the player to store one mana above what would usually be the maximum of 1000, allowing for up to 2000 mana to be stored.

Please do not merge this pack with your own datapacks requiring the pack. Instead, link players to the Modrinth page/this GitHub repo where they can download this pack to use alongside yours. This way, you won't need to update your pack everytime the library gets updated. If you're uploading your pack to Modrinth, best practice is to list this pack as a dependency. You are, however, allowed to merge the resource pack for ease of use, as well as change textures to your liking. Note that when the player uses different resourcepacks modifying these textures, the resource pack highest in the list will override the lower ones.

DO NOT use the textures provided by the resource pack for packs not also using the library and without giving credit.

Making sure the player installs the library

As proven by plenty of evidence, some players simply don't read the pack descriptions before downloading a new pack. To inform those that they need to install the library, please include execute unless score %installed hexenkraft.util matches 777 run tellraw @a ["",{color:"yellow",text:"["},{color:"#CB81FF",text:"Hexenkraft Library"},{color:"yellow",text:"] "},{color:"red",text:"One of the datapacks you're using requires the "},{color:"#CB81FF",text:"Hexenkraft Mana Library "},{color:"red",text:"to function"},". ",{color:"gray",text:"["},{color:"#AFFFAC",text:"Download",click_event:{action:"open_url",url:"https://modrinth.com/datapack/hexenkraft"},hover_event:{action:"show_text",value:["",{text:"Click to download on Modrinth!"}]}},{color:"gray",text:"]"}] in your load function. Feel free to modify the text to your liking but make sure to include a direct download link in the message.

Abilities/Items that use mana:

To use a set amount of mana run: function hexenkraft:_public/mana/use {amount:<AMOUNT>} (e.g. with execute store result) This will only use mana if the player has enough, in which case the function will return 1, if the player does not have enough mana, the function will return -1 and give audible feedback to the player. Additionally, the amount of mana needed, will be highlighted in red on the players mana bar.

Items that grant additional mana regen / overflow

To allow for any item to increase mana regen or overflow, simply add the following to the item's "minecraft:custom_data" component: {hexenkraft:{attributes:{<SLOT TYPE>:true,<MODIFIER TYPE>:true,<MODIFIER TYPE>_amount:<AMOUNT>}}}

<SLOT TYPE>: The slots the item needs to be in for the modifier to activate. Can be any or all of: armor, offhand or mainhand

<MODIFIER TYPE>: The type of the modifier. Can be any or all of: overflow, regen

<AMOUNT>: The amount of additional mana to regenerate per second/of overflow mana to be freed. Can be any integer, though overflow mana can not be negative.

Grating additional mana regen / overflow without items

To increase any players mana regen / overflow stats, run function hexenkraft:_public/attribute/add_modifier {type:<MODIFIER TYPE>,duration:<DURATION>,amount:<AMOUNT>,id:<ID>,persistent:<PERSITENCE> as the player

<MODIFIER TYPE>: The type of the modifier. Can be either overflow, regen

<AMOUNT>: The amount of regen/overflow added to the player

<DURATION>: The duration of how long these modifiers last in ticks. Set to -1 if you don't want them to run out.

<ID>: Unique ID for the modifier. E.g. namespace:mana_potion, namespace:bossfight_modifier, etc.

<PERSISTENCE>: Boolean. True -> modifier automatically gets removed when the player dies. False -> Modifier stays even after a player dies

You can remove existing modifiers before they run out using function hexenkraft:_public/attribute/remove_modifier {id:<ID>} Trying to add multiple modifiers with the same ID to a player will cause the old modifier to be overwritten by the new one

Reading mana values

All mana values are stored in scoreboards:

hexenkraft.mana.amount -> Current amount of stored mana

hexenkraft.mana.overflow -> Amount of theoretically acessible overflow mana

hexenkraft.mana.max -> Maximum mana of a player, including their current overflow mana

hexenkraft.mana.regen -> Amount of mana to be regenerated / second

hexenkraft.mana.amount_used -> Stores the last amount of mana the player used/tried to use.

PLEASE do NOT ever directly modify these scoreboards, as doing so can break core functions of the library or compatibility with other packs. If you feel the need to change any of these and find no native way to do so using the library, please request for such function either via github issues or in the linked discord server!

If you for some reason want to get the current mana percentage of a player simply run: function hexenkraft:_public/get/mana_percentage And then read from scoreboard hexenkraft.mana.percentage

"Event handlers" / Function tags

If you want your pack to respond to certain events, you can add functions to certain tags and they will be called when the event happens. All of these are run as the player, at the player.

hexenkraft:call_on_mana_use_attempt -> called whenever a player attempts to use mana, no matter the success hexenkraft:call_on_mana_use_fail -> called whenever a player attempts to use mana and fails (e.g. because they do not have enough) hexenkraft:call_on_mana_use_success -> called whenever a player attempts to use mana and succeeds

Utility functions

Other functions to interact with a player's mana.

/function hexenkraft:_public/mana/add {amount:<AMOUNT>} -> increases the players mana by a set amount

/function hexenkraft:_public/mana/deplete -> sets the players current mana to 0

/function hexenkraft:_public/mana/fill -> completely fills up the players mana, including overflow

/function hexenkraft:_public/mana/no_overflow -> completely fills up the players mana, excluding overflow

/function hexenkraft:_public/mana/set {amount:<AMOUNT>} -> sets the players mana to a specific amount

/function hexenkraft:_public/mana/remove {amount:<AMOUNT>} -> removes a specific amount of mana from the player. DO NOT use this for spells and things of the like which are only supposed to work if the player has a specific amount of mana. For that see Abilities/Items that use mana above.

/function hexenkraft:_public/z_debug/toggle_debug_bar - Toggles the debug bar, an alternate mana bar numerically displaying current mana, max mana, overflow & regeneration. Shows up in all gamemodes and replaces all actionbar text.

/function hexenkraft:_public/z_debug/toggle_debug_messages - Toggles debug messages. Debug messages with extra information are for example sent whenever attribute modifiers are applied to/removed from a player. More debug messages might be added in the future.

• Any player can disable the sound that is played when they don't have enough mana to perform an action using: /trigger hexenkraft.settings.toggle_sounds Running the command again will re-enable sounds.

• Though internally, the can hold up to 1000/2000 mana, it is recommended to communicate it as 100/200 to the player. E.g. 5 mana points -> 0.5 mana, 500 -> 50 mana, etc.
• Don't run any functions not in the _public folder :P
• When adding mana regeneration modifiers, always think about how fast it would take the player to reach the maximum of 2000 mana, which is the most a spell can cost. Also, consider that other packs might add additional ways to increase regeneration on top of yours, which can quickly become overpowered. In general, try to keep values relatively low. Normally, mana regenerates at 5/s, if you even just add another 5 to that, you have already doubled the speed.
• More recommendations to be added soon™️

• Further optimisation of the pack
• Whatever the people long for :)