# Pentamana Pentamana is a very customizable mana library for storing, modifying, and displaying mana that runs server-side. If you'd like to add a feature, feel free to open an issue [here](https://github.com/CookedSeafood/pentamana/issues). ## Feature - 1 manabar (1 text pattern, 3 display position, 4 render type). - 4 attribute modifiers. - 4 enchantments. - 8 status effects. - Datapack interactable. - Very configurable. - Nothing presented unless turning on or generating by yourself. ## Installation `gradle.properties`: ```properties pentamana_version=0.7.1 ``` `build.gradle`: ```gradle repositories { exclusiveContent { forRepository { maven { name = "Modrinth" url = "https://api.modrinth.com/maven" } } filter { includeGroup "maven.modrinth" } } } dependencies { modImplementation "maven.modrinth:pentamana:${project.pentamana_version}" } ``` ## Configuration Here is a template configuration file `config/pentamana.json` filled with default values. You may only need to write the lines you would like to modify. ```json { "manaPerPoint": 1, "manaCapacityBase": 2.0, "manaRegenerationBase": 0.0625, "enchantmentCapacityBase": 2.0, "enchantmentStreamBase": 0.015625, "enchantmentUtilizationBase": 0.1, "enchantmentPotencyBase": 0.5, "statusEffectManaBoostBase": 4.0, "statusEffectManaReductionBase": 4.0, "statusEffectInstantManaBase": 4.0, "statusEffectInstantDepleteBase": 6.0, "statusEffectManaPowerBase": 3.0, "statusEffectManaSicknessBase": 4.0, "statusEffectManaRegenerationBase": 50, "statusEffectManaInhibitionBase": 40, "isConversionExperienceLevel": false, "conversionExperienceLevel": 0.5, "displayIdleInterval": 40, "displaySuppressionInterval": 40, "isForceEnabled": false, "isEnabled": true, "isVisible": true, "isCompression": false, "compressionSize": 20, "manaPattern": [{"text":"$"}], "manaRenderType": "character", "manaBarPosition": "actionbar", "manaBarColor": "blue", "manaBarStyle": "progress", "pointsPerCharacter" : 2, "manaCharset": [[{"text":"★","color":"aqua"}],[{"text":"⯪","color":"aqua"}],[{"text":"☆","color":"black"}]], } ``` ### `manaPerPoint` Amount of mana to be considered as 1 mana point. ### `manaCapacityBase`, `enchantmentCapacityBase`, `statusEffectManaBoostBase`, `statusEffectManaReductionBase`, `isConversionExperienceLevel`, `conversionExperienceLevel` Are used by the formula below: ```java float capacity = (float)this.player.getCustomModifiedValue(PentamanaAttributeIdentifiers.MANA_CAPACITY, Pentamana.manaCapacityBase); capacity += Pentamana.enchantmentCapacityBase * this.player.getWeaponStack().getEnchantments().getLevel(PentamanaEnchantmentIdentifiers.CAPACITY); capacity += statusEffectManager.containsKey(PentamanaStatusEffectIdentifiers.MANA_BOOST) ? Pentamana.statusEffectManaBoostBase * (statusEffectManager.getActiveAmplifier(PentamanaStatusEffectIdentifiers.MANA_BOOST) + 1) : 0; capacity -= statusEffectManager.containsKey(PentamanaStatusEffectIdentifiers.MANA_REDUCTION) ? Pentamana.statusEffectManaReductionBase * (statusEffectManager.getActiveAmplifier(PentamanaStatusEffectIdentifiers.MANA_REDUCTION) + 1) : 0; capacity += Pentamana.isConversionExperienceLevel ? Pentamana.conversionExperienceLevelBase * this.player.experienceLevel : 0; capacity = Math.max(capacity, 0.0f); ``` ### `manaRegenerationBase`, `enchantmentStreamBase`, `statusEffectInstantManaBase`, `statusEffectInstantDepleteBase`, `statusEffectManaRegenerationBase`, `statusEffectManaInhibitionBase` Are used by the formula below: ```java float regen = (float)this.player.getCustomModifiedValue(PentamanaAttributeIdentifiers.MANA_REGENERATION, Pentamana.manaRegenerationBase); regen += Pentamana.enchantmentStreamBase * this.player.getWeaponStack().getEnchantments().getLevel(PentamanaEnchantmentIdentifiers.STREAM); regen += statusEffectManager.containsKey(PentamanaStatusEffectIdentifiers.INSTANT_MANA) ? Pentamana.statusEffectInstantManaBase * Math.pow(2, statusEffectManager.getActiveAmplifier(PentamanaStatusEffectIdentifiers.INSTANT_MANA)) : 0; regen -= statusEffectManager.containsKey(PentamanaStatusEffectIdentifiers.INSTANT_DEPLETE) ? Pentamana.statusEffectInstantDepleteBase * Math.pow(2, statusEffectManager.getActiveAmplifier(PentamanaStatusEffectIdentifiers.INSTANT_DEPLETE)) : 0; regen += statusEffectManager.containsKey(PentamanaStatusEffectIdentifiers.MANA_REGENERATION) ? Pentamana.manaPerPoint / (float)Math.max(1, Pentamana.statusEffectManaRegenerationBase >> statusEffectManager.getActiveAmplifier(PentamanaStatusEffectIdentifiers.MANA_REGENERATION)) : 0; regen -= statusEffectManager.containsKey(PentamanaStatusEffectIdentifiers.MANA_INHIBITION) ? Pentamana.manaPerPoint / (float)Math.max(1, Pentamana.statusEffectManaInhibitionBase >> statusEffectManager.getActiveAmplifier(PentamanaStatusEffectIdentifiers.MANA_INHIBITION)) : 0; ``` ### `enchantmentUtilizationBase` Is used by the formula below: ```java float targetConsum = (float)player.getCustomModifiedValue(PentamanaAttributeIdentifiers.MANA_CONSUMPTION, consum); targetConsum *= 1 - Pentamana.enchantmentUtilizationBase * player.getWeaponStack().getEnchantments().getLevel(PentamanaEnchantmentIdentifiers.UTILIZATION); ``` ### `enchantmentPotencyBase`, `statusEffectManaPowerBase`, `statusEffectManaSicknessBase` Are used by the formula below: ```java float castingDamage = manaCapacity; castingDamage /= Pentamana.manaCapacityBase; castingDamage *= (float)player.getCustomModifiedValue(PentamanaAttributeIdentifiers.CASTING_DAMAGE, baseDamage); castingDamage += potencyLevel != 0 ? ++potencyLevel * Pentamana.enchantmentPotencyBase / Integer.MAX_VALUE : 0; castingDamage += statusEffectManager.containsKey(PentamanaStatusEffectIdentifiers.MANA_POWER) ? (statusEffectManager.getActiveAmplifier(PentamanaStatusEffectIdentifiers.MANA_POWER) + 1) * Pentamana.statusEffectManaPowerBase : 0; castingDamage -= statusEffectManager.containsKey(PentamanaStatusEffectIdentifiers.MANA_SICKNESS) ? (statusEffectManager.getActiveAmplifier(PentamanaStatusEffectIdentifiers.MANA_SICKNESS) + 1) * Pentamana.statusEffectManaSicknessBase : 0; castingDamage = Math.max(castingDamage, 0.0f); castingDamage *= entity instanceof WitchEntity ? 0.15f : 1; ``` ### `displayIdleInterval` Ticks actionbar not updating if idle. ### `displaySuppressionInterval` Ticks actionbar not updating if interrupted. ### `isForceEnabled` True if mana should be ticked for every player, regardless of their own preference. This do not modify player preference. ### `isEnabled` Default player preference. True if mana should be ticked for the player. ### `isVisible` Default player preference. True if manabar should be visible for the player. ### `isCompression` Default player preference. True if `character` type manabar should be in fixed size for the player. ### `compressionSize` Default player preference. The size of the `character` type manabar if `isCompression` is true. ### `manaPattern` Default player preference. Use `$` to represent mana render text. ### `manaRenderType` Default player preference. Can be `character`, `numeric`, `percentage` and `none`. ### `manaBarPosition` Default player preference. Can be `actionbar`, `bossbar` and `siderbar`. ### `manaBarColor` Default player preference. The color of `bossbar` position manabar. ### `manaBarStyle` Default player preference. The style of `bossbar` position manabar. ### `pointsPerCharacter` Default player preference. Amount of mana points to be considered as 1 mana character. ### `manaCharset` Default player preference. from 100% to 0% point character. ## Command - `/mana enbale` Enable this mod for yourself. - `/mana disable` Disable this mod for yourself completely. - `/manabar set visibility ` Set the manabar visibility for yourself. - `/manabar set pattern ` Set the manabar pattern for yourself. Use `$` to represent mana render text. Text which not in `extra` is ignored. - `/manabar set type ` Set the mana render text type for yourself. - `/manabar set position ` Set the manabar position for yourself. - `/manabar set color ` Set the color of `bossbar` position manabar for yourself. - `/manabar set style ` Set the style of `bossbar` position manabar for yourself. - `/manabar set points_per_character ` Set the amount of mana points to be considered as 1 mana character for yourself. - `/manabar set character [] []` Set the #`[]` `[]` point mana character for yourself. - `/manabar reset []` Reset manabar options for yourself. - `/pentamana debug config` Print config file. (from disk, _NOT_ from loaded config) - `/pentamana debug manabar server []` Print server manabar info of the player. - `/pentamana debug manabar client []` Print client manabar info of the player. - `/custom reset []` Reset custom things. The commands following require premission level 2 to execute. - `/mana reload` Reload config file. - `/mana get` Get mana supply. Returns mana supply in point. - `/mana set` Set mana supply. Returns modified mana supply in point. - `/mana add` Add mana supply. Returns modified mana supply in point. - `/mana subtract` Subtract mana supply. Returns modified mana supply in point. - `/custom effect give [] []` Give custom status effect. `` can be `pentamana.mana_boost`, `pentamana.mana_reduction`, `pentamana.instant_mana`, `pentamana.instant_deplete`, `pentamana.mana_regeneration`, `pentamana.mana_inhibition`, `pentamana.mana_power`, `pentamana.mana_sick`. - `/custom effect clear []` Clear custom status effect. ## Modifier Modifiers can be added or removed from items using custom data components. They are active when equipped in the written slot. ```txt [List] modifiers |- [Compound] |- [String] attribute: Can be `pentamana:mana_capacity`, `pentamana:mana_regeneration`, `pentamana:mana_consumption` and `pentamana:casting_damage`. |- [Double] base: Any. |- [String] id: Any. |- [String] operation: Can be `add_value`, `add_multiplied_base` and `add_multiplied_total`. \- [String] slot: Can be `mainhand`, `offhand`, `feet`, `legs`, `chest` and `head`. ``` Below is an example modifier which increase mana capacity by 120(![2PointManaChar.png](https://cdn.modrinth.com/data/UgFKzdOy/images/a26007574007d784e65c79cb957c3e0d3e94be6f.png)×60) when held in offhand. ```component [ minecraft:custom_data={ modifiers: [ { attribute: "pentamana:mana_capacity", base: 120.0d, operation: "add_value", slot: "offhand" } ] } ] ``` ## Status Effect Status effects can be added or removed from items using custom data components. They are applied when the item is consumed. ```txt [List] status_effects |- [Compound] |- [String] id: Can be `pentamana:mana_boost`, `pentamana:mana_reduction`, `pentamana:instant_mana`, `pentamana:instant_deplete`, `pentamana:mana_regeneration`, `pentamana:mana_inhibition`, `pentamana:mana_power` and `pentamana:mana_sickness`. |- [int] duration: value. \- [int] amplifier: value. ``` Below is an example status effect which increase the mana regeneration by 16(![2PointManaChar.png](https://cdn.modrinth.com/data/UgFKzdOy/images/a26007574007d784e65c79cb957c3e0d3e94be6f.png)×8) when the item is consumed. ```component [ minecraft:custom_data={ status_effects: [ { id: "pentamana:instant_mana", duration: 1, amplifier: 2 } ] } ] ``` - Mana Boost: Increase mana capacity by `level * statusEffectManaBoostBase`. - Mana Reduction: Decrease mana capacity by `level * statusEffectManaReductionBase`. - Instant Mana: Increase mana regeneration by `2 ^ level * statusEffectInstantManaBase`. - Instant Deplete: Decrease mana regeneration by `2 ^ level * statusEffectInstantDepleteBase`. - Mana Regeneration: Increase mana regeneration by `manaPerPoint / statusEffectManaRegenerationBase >> level` - Mana Inhibition: Decrease mana regeneration by `manaPerPoint / statusEffectManaInhibitionBase >> level` - Mana Power: Increase casting damage by `level * statusEffectManaPowerBase`. - Mana Sickness: Decrease casting damage by `level * statusEffectManaSicknessBase`. ## Enchantment ### Capacity - Maximum level: II - Primary items: Stick - Secondary items: Axe, Hoe, Mace, Pickaxe, Shovel, Sword, Trident - Enchantment weight: 2 Capacity adds extra mana capacity `level * enchantmentCapacityBase`. ### Stream - Maximum level: III - Primary items: Stick - Secondary items: Axe, Hoe, Mace, Pickaxe, Shovel, Sword, Trident - Enchantment weight: 5 Stream adds extra mana regeneration by `level * enchantmentStreamBase`. ### Potency - Maximum level: V - Primary items: Stick - Secondary items: Axe, Hoe, Mace, Pickaxe, Shovel, Sword, Trident - Enchantment weight: 10 Potency adds the casting damage by `(level + 1) * enchantmentPotencyBase`. ### Utilization - Maximum level: V - Primary items: Stick - Secondary items: Axe, Hoe, Mace, Pickaxe, Shovel, Sword, Trident - Enchantment weight: 5 Utilization reduces the mana cost of casting by `level * enchantmentUtilizationBase` percent. ## Tutorial: Create your very own magic weapon Codes in this tutorial are licenced under CC-0. Let's say we want a right-click weapon named `Magik Wand` that consumes 1(![1PointManaChar.png](https://cdn.modrinth.com/data/UgFKzdOy/images/d943f1772f350c1645aef349b1c0dcd86a90296c.png)) mana per use when held in mainhand. Here is a callback which will be called everytime a player uses items: ```java UseItemCallback.EVENT.register((player, world, hand) -> { }) ``` Check if the hand is mainhand: ```java if (Hand.OFF_HAND.equals(hand)) { return ActionResult.PASS; } ``` Check if the item has a `Magik Wand` name: ```java ItemStack stack = player.getMainHandStack(); if (!"Magik Wand".equals(stack.getItemName().getString())) { return ActionResult.PASS; } ``` Check if the player has mana enabled: ```java if (!ManaPreferenceComponentInstance.MANA_PREFERENCE.get(player).isEnabled()) { return ActionResult.PASS; } ``` Consume the mana and fire your weapon if the consumption is successful. Consumption will succeed if the player has enough mana supply. ```java if (!ServerManaBarComponentInstance.SERVER_MANA_BAR.get(player).getServerManaBar().consum(1.0f)) { return ActionResult.PASS; } // Your code here ``` ## Event - `TickManaCallback` Called after the mana capacity calculation, before everything else. - `RegenManaCallback` Called when a player is regenerating mana. After the mana regeneration calculation, before regenerating mana. - `ConsumeManaCallback` Called when a player is consuming mana. After the mana consumption calculation, before consuming mana. ## FAQ ### Containing in mod packs Yes, As long as the download source is modrinth. ### Back porting / porting to other mod loaders No. You can port it yourself as long as you give credit to the original work.

CookedSeafood

CookedSeafood

Tarso