### ![Mermaids-Banner](https://media.forgecdn.net/attachments/description/1430860/description_bdf39dac-b010-48cb-a0c8-663b91de15e0.png) ### Ever wanted to be a Mermaid? Now you can with Mermaids, this plugin allows the user to **become a Mermaid** in water! V1.3.3 Description \===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--=== ## **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 * Configurable transformation option * Custom model and animations * and More! \===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--=== ## **Roadmap**: * More ways to become a Mermaid than just entering water * Mermaid transformation particles * Better tail model with multiple color textures * More sea life and underwater things * Better mermaid tail model, with animations going with it * More 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**: ### Commands Extra Info:

/mermaids ui
- Will open a UI where you can select mermaid tail model and color
- May require permission: mermaids.ui
/mermaids toggle true|false
- You can enable or disable Mermaid transformations
- Requires permission: mermaids.toggle
/mermaids bugfix
- Will give the player the Mermaid component, run if mermaid transformations aren't working
/mermaids permpotionremove
- Will remove the permanent potion transformation from the player
/mermaids debug
- Requires permission: mermaids.debug
- /mermaids debug mermaidv2 true|false
  - Allows the user to try out the Mermaid Tail Model v2
  - Requires permission: mermaids.debug.mermaidv2
- /mermaids debug givemermaidring
  - Give the player a testing item called the Mermaid Ring
  - Requires permission: mermaids.debug.mermaidring
/mermaids admin
- Requires permission: mermaids.admin
- /mermaids admin mermaidonland true|false
  - Toggle mermaid on land for all players
  - Requires permission: mermaids.admin.mermaidonland
- /mermaids admin blockstransformation true|false
  - Toggle to allow some blocks to transform players into a mermaid
  - Requires permission: mermaids.admin.blocktransform
- /mermaids admin raintransformation true|false
  - Toggle to allow rain to transform players into a mermaid
  - Requires permission: mermaids.admin.raintransform
- /mermaids admin mermaidglow true|false
  - Toggle to have the mermaid model glow
  - Requires permission: mermaids.admin.mermaidglow

### Permissions Extra Info:

mermaids.transform
- Allows the player to mermaid transform when this option is enabled in config
mermaids.ui
- Run /mermaids ui command
mermaids.toggle
- Run /mermaids toggle (boolean) command
mermaids.debug
- Access to the /mermaids debug commands
mermaids.debug.mermaidv2
- Access to use /mermaids debug mermaidv2 true|false, which allows the user to try out the Mermaid Tail Model v2
mermaids.debug.mermaidring
- Access to use /mermaids debug givemermaidring, which will give the player a testing item called the Mermaid Ring
mermaids.admin
- Access to the /mermaids admin commands
mermaids.admin.mermaidonland
- Access to use /mermaids admin mermaidonland true|false, which toggles mermaid on land for all players
mermaids.admin.blocktransform
- Access to use /mermaids admin blocktransformation true|false, which toggles to allow some blocks to transform players into a mermaid
mermaids.admin.raintransform
- Access to use /mermaids admin raintransformation true|false, which toggles to allow rain to transform players into a mermaid
mermaids.admin.mermaidglow
- Access to use /mermaids admin mermaidglow true|false, which toggles the mermaid model glow

### Config Extra Info:

This is the default config values and descriptions for config version 5

"Config-Information"
- Default Value: "Confused about what one of these statement do? Check out the Mermaids page on the Curseforge website and scroll down to Config Extra Info."
"ConfigVersion"
- Default Value: 6
- Description: Config Version when you first load the plugin.
"PluginName"
- Default Value: "Mermaids"
- Description: Plugin name.
"Version"
- Default Value: "1.3.3"
- Description: Plugin Verison when you first load the plugin.
"Website"
- Default Value: "https://www.curseforge.com/hytale/mods/mermaids"
- Description: A link to the plugin's download page and informatiton.
"Transformation-Mode"
- Default Value: 0
- Description: TransformationMode = 0 : Transform when entering water, TransformationMode = 1 : Requires user to drink Mermaid Potion to Transform.
"Always-A-Mermaid-Even-On-Land"
- Default Value: false
- If you have permissions to be a Mermaid, than you'll always be transformed into a Mermaid even on land.
"Require-Transformation-Permission"
- Default Value: false
- Description: Requires the player to have the permission -- mermaids.transform -- to transform into a Mermaid.
"Require-Mermaids-UI-Permission"
- Default Value: false
- Description: Requires the player to have the permission -- mermaids.ui -- to run the command /mermaids ui.
"Blocks-Can-Cause-Transformations"
- Default Value: true
- Description: Some blocks like mud and a cauldron will cause you to transform into a mermaid.
"Rain-Can-Cause-Transformations"
- Default Value: false
- Description: Walking into the rain will cause you to transform.
"Mermaid-Have-A-Glow/Light"
- Default Value: true
- Description: The mermaid model will light of a glow allowing the player to see better underwater.
"DebugMode"
- Default Value: false
- Run the plugin in debug mode to get alerts about most actions of the plugin.

\===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--=== ## **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. ![Mermaids-Mermaid_showoff](https://media.forgecdn.net/attachments/description/1430860/description_7c762965-7cef-467d-b4ec-66cd9c0edbcf.png) \===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--=== ### **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. \===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===--===

Creators