Mermaids

Ever wanted to be a Mermaid? Now you can with Mermaids, this plugin allows the user to become a Mermaid in water!

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Features:

After entering the water for a couple seconds, you'll turn into a mermaid. Once you enter the land, your legs will regenerate.

Grow a Mermaid Tail and keep your cosmetics

Breathe underwater with quicker movement

Permissions and config

Custom model and animations

and More!

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Roadmap:

Custom ways to become a Mermaid than just entering water

Mermaid transformation particles

Better tail model with multiple color textures

Save your mermaid settings (Mermaid tail model and color)

More sea life and underwater things

Better mermaid tail model, with animations going with it

Mermaid cosmetic armor

Fix walking on land with tail (by adding a crawling animation on land and more)

Trailer and showcase video

Disclaimer: Plugin is still in early development so expect bugs and if you encounter any, please report them to me.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Commands, Config, and Permissions:

Command: /mermaid true|false

Desc: Allow the player to enable or disable mermaid transformations

Permission: mermaids.toggle

Command: /mermaids

Desc: Opens a UI to change the mermaid tail model and color (Still in Development)

Permission: mermaids.ui

Config: "Require-Mermaids-UI-Permission"

Default: Set to false

Desc: Requires the user to have the mermaids.ui permission to run the command /mermaids to open the Mermaids UI

Config: "Require-Transformation-Permission"

Default: Set to false

Desc: Requires the user to have mermaids.transform permission to transform

Permission: mermaids.transform

Desc: Permission to allow the player to transform into a mermaid

Commands Extra Info:

/mermaids

Will open a UI where you can select mermaid tail model and color

May require permission: mermaids.ui

/mermaid true|false

You can enable or disable Mermaid transformations

Requires permission: mermaids.toggle

/mermaidbugfix

Will give the player the Mermaid component, run if mermaid transformations aren't working

Permissions Extra Info:

mermaids.transform

Allows the player to mermaid transform when this option is enabled in config

mermaids.ui

Run /mermaids command

mermaids.toggle

Run /mermaid (boolean) command

Config Extra Info:

This is the default config values for config version 3

{ "ConfigVersion": 3, //Config Version when you first load the plugin "PluginName": "Mermaids", //Plugin name "Version": "1.2.5", //Plugin Verison when you first load the plugin "Website": "https://www.curseforge.com/hytale/mods/mermaids", //A link to download the plugin "DebugMode": false, //Run the plugin in debug mode to get alerts about most actions of the plugin "Require-Transformation-Permission": false, //Requires the player to have the permission -- mermaids.transform -- to transform into a Mermaid "Require-Mermaids-UI-Permission": false, //Requires the player to have the permission -- mermaids.ui -- to run the command /mermaids "Blocks-Can-Cause-Transformations": true, //Some blocks like mud and a cauldron will cause you to transform into a mermaid "Rain-Can-Cause-Transformations": false //Walking into the rain will cause you to transform }

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

HOW TO INSTALL:

Client:

Upload the Mermaids.jar file into your %appdata%\Hytale\UserData\Mods\ Folder

Server:

Upload the Mermaids.jar file into your servers mods\ folder

Make sure you delete any previous version of Mermaids otherwise your world may not start.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Known Bugs

Mermaid transformation cause your skin to go white and not your player's skin color.

You keep your tail for a small amount of time once you go on land.

Animations are weird when you hit a block or when you're above water.

Seashell Bra still shows your Outer cosmetic layers when in Mermaid model.

===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===