HyFlask

HyFlask

HyFlask adds a new potion Flask to the game that is not consumed upon use. Instead, it has multiple charges that can be replenished by sleeping through the night. The effect of the flask can be changed by learning new effects at the Research Table and then be equipped at the Effect Cauldron. You can have multiple effects active at the same time, as long as your capacity is not exceeded.

Always open to critique or ideas!

Getting Your Flask

The flask can be crafted at the Alchemist Workbench.

Usage

You can use the flask like any other potion. However, instead of consuming the potion itself, you consume a use bound to your player. This means you cannot have multiple flasks or use another player's flask to gain additional uses. To replenish your charges, you must sleep through the night.

You get more charges the more often you use the flask. Whenever you sleep, it will check how many times you have used the flask and then upgrades your maximum number of charges if a new threshold is reached.

Effects

The flask starts with the health regeneration level 1 effect, but you can learn new effects by using effect scrolls crafted at the Research Table. Effects have different levels, and you always need the previous levels to learn a higher level effect.

After learning a new effect, they can be equipped at the Effect Cauldron. You can equip as many effects as you want. However, every effect has a cost and the flask has a maximum capacity that limits the number of effects you can have active at the same time.

The capacity of the flask is increased by the CapacityScroll effects at the Research Table.

Commands

The root command is hyflask. Explanation of the available subcommands can be found in Hytale with the command ui or using --help.

Configuration

Upon loading the plugin, it will create a config file in the mod folder that contains the following settings:

Field	Description
StartingLearnedEffects	List of FlaskEffect asset IDs that new players start with as learned effects, available for equipping at the Effect Cauldron.
StartingActiveEffects	List of FlaskEffect asset IDs that are active by default for new players.
UsesUpgradeMap	Maps cumulative flask use counts to a maximum uses modifier. When the player's total uses reach a key's threshold, their maximum uses modifier is updated to the corresponding value.

Credits

• Flask Model was done by my friend Haruka

Required Plugins

• Hytalor by HypersonicSharkz

Custom Effects

You can read more about adding your own effects at GitHub