List of all Configs inside the Mermaids mod:
Mermaids Config.
This is the default config values and descriptions for the Mermaids config version 19,
found in the path mods/Siren_Mermaids/Config.json.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| "Config-Information" | A long string that tells you to come to this site. | Information about how to find stuff related to the config. |
| "ConfigVersion" | 19 | Current Version when you have loaded for the plugin. |
| "PluginName" | "Mermaids" | Plugin name. |
| "Version" | "2.7.1" | Version of the last ran mod jar. |
| "Website" | "https://www.mermaids.dev/mermaids/" | Official website for the Mermaids mod. |
| "Download-Site" | "https://www.curseforge.com/hytale/mods/mermaids" | Website to download this mod, check for updates, and information. |
| "Enable-Generic-Console-Logs" | false | Send console logs for majority of mermaid actions: transforming and modifying settings. |
| "Transformation-Mode" | 0 | TransformationMode = 0 : Transform when entering water, TransformationMode = 1 : Requires user to drink Mermaid Potion to Transform. |
| "Description-Transformation-Mode" | A long string that tells you about the description for Transformation-Mode. | A description of the Transformation-Mode config option. |
| "Default-Toggle-Mermaid-Setting-For-Players-On-First-Join" | true | What the default value for players to toggle into a mermaid to have when they first join the server. |
| "Always-A-Mermaid-Even-On-Land" | false | If you have permissions to be a Mermaid, than you'll always be transformed into a Mermaid even on land. |
| "Mermaid-On-Land-Speed-Debuff" | true | If the player is transformed as a Mermaid, they will have a speed debuff while on land. |
| "Require-Transformation-Permission" | false | Requires the player to have the permission -- mermaids.transform -- to transform into a Mermaid. |
| "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 into a mermaid. |
| "Mermaid-Have-A-Glow/Light" | true | The mermaid model will light of a glow allowing the player to see better underwater. |
| "Mermaid-Glow/Light-Radius" | 33 | The radius of the mermaid glow. |
| "EasyHunger-By:Haasapenas-Compatibility" | true | Compatibility with the EasyHunger Mod, see Compatibilities page for more info. |
| "AquaThirst&Hunger-By:Jume-Compatibility" | true | Compatibility with the Aqua Thirst & Hunger Mod, see Compatibilities page for more info. |
| "New-Version-Message" | true | When Mermaids mod version is outdated, send a message to OPed players when they join. |
| "Do-Not-Change:Add-mermaids-Permission" | false, but on startup it will set it to true | Ignore this value; however, it will add the permission "mermaids" to the Adventure permission group on startup. |
| "DebugMode" | false | Run the plugin in debug mode to get alerts about most actions of the plugin. |
Mermaid Zones and Whitelist Config
This is the default config values and descriptions for the Mermaid Zones and Whitelist Config version 1,
found in the path mods/Siren_Mermaids/WhitelistZonesConfig.json.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| "Config-Name" | "Mermaid Zones and Whitelist Config" | The name given to this config file. |
| "Config-Description" | "This config file allows the server owner to modify the Mermaid transformation zones and/or whitelist/blacklist instances." | Description of what this config can modify. |
| "Config-Information" | A long string that tells you to come to this site. | Information about how to find stuff related to the config. |
| "ConfigVersion" | 1 | Current Version when you have loaded for the plugin. |
| " " | " " | A spacing/gap inside the config file. |
| "Whitelist/Blacklist-Information" | A long string giving information about whitelist/blacklist. | Whitelist will allow Mermaid transformation to only happen in that world. Blacklist will deny Mermaid transformation inside that instance. You must have Enable-Whitelist true for whitelist to work because it will disable all instances that aren't include when true. If you have an instance in blacklist, than unless added to whitelist, the player won't transform into a Mermaid inside that instance. |
| "Enable-Whitelist" | false | Enable to allow whitelist. When true, every world will be blacklisted except the ones inside Whitelist. |
| "Whitelist" | ["Example_Instance_Name1", "Example_Instance_Name2"] | An array of strings of world names that will allow players to transfrom into a mermaid inside of when Enable-Whitelist is true. |
| "Blacklist" | ["Example_Instance_Name1", "Example_Instance_Name2"] | An array of strings of world names that will disable players from transfroming into mermaids inside of that world. |
| " " | " " | A spacing/gap inside the config file. |
| "Zones-Information" | A long string giving information about how to add a zone. | Zones: They are a Map with the Map key being the instance name. The value of the Map is an array of ints. The order for the array of ints are [pos_x1, pos_y1, pos_z1, pos_x2, pos_y2, pos_z2]. |
| "Transformation-Zones-Whitelist" | "Example_Instance_Name1": [-100, 0, -100, 100, 250, 100], "Example_Instance_Name2": [200, 25, 50, 250, 200, 100] | When a world is blacklisted, you can setup a zone where mermaids will only transform inside the zone. Format: "World_Name": [pos_x1, pos_y1, pos_z1, pos_x2, pos_y2, pos_z2] |
| "Blacklist-Transformation-Zones" | "Example_Instance_Name1": [-250, 100, -200, -100, 225, -100], "Example_Instance_Name2": [20, 0, -20, 80, 220, 50] | Setup a zone where players will not be allowed to transform into a mermaid. Format: "World_Name": [pos_x1, pos_y1, pos_z1, pos_x2, pos_y2, pos_z2] |
Mermaids Orbis Origins Config
This is the default config values and descriptions for the Mermaids Orbis Origins config version 1,
found in the path mods/Siren_Mermaids/Compatibility/OrbisOrigins.json.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| "Config-Name" | "Orbis Origins Compatibility" | The name given to this config file. |
| "Config-Description" | "This config file allows the user to modify compatibility issues with the Orbis Origins mod." | Description of what this config can modify. |
| "Config-Information" | A long string that tells you to come to this site. | Information about how to find stuff related to the config. |
| "ConfigVersion" | 1 | Current Version when you have loaded for the plugin. |
| "Enable-Orbis-Origins-Compatibility" | false | Toggle for the Mermaids mod to add a brand new mermaids species to the Orbis Origins mod. |
| "Description-Enable-Orbis-Origins-Compatibility" | A description of what the "Enable-Orbis-Origins-Compatibility" does. | A description of what another variable does. |
| "Default-Mermaids-Content" | false | Toggle the Mermaids mod content. If false, you can only transform into a Mermaid as a mermaid species. |
| "Description-Default-Mermaids-Content" | A description of what the "Default-Mermaids-Content" does. | A description of what another variable does. |
| "Mermaid-Only-In-Water" | true | When the player is a mermaid species, they will only have a Mermaid tail while in water. |
Mermaids Endless Leveling Config
This is the default config values and descriptions for the Mermaids Endless Leveling config version 1,
found in the path mods/Siren_Mermaids/Compatibility/EndlessLeveling.json.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| "Config-Name" | "Endless Leveling Compatibility" | The name given to this config file. |
| "Config-Description" | "This config file allows the user to modify compatibility issues with the Endless Leveling mod." | Description of what this config can modify. |
| "Config-Information" | A long string that tells you to come to this site. | Information about how to find stuff related to the config. |
| "ConfigVersion" | 1 | Current Version when you have loaded for the plugin. |
| "Enable-Endless-Leveling-Compatibility" | false | Toggle for the Mermaids mod will add a brand new mermaid race to Endless Leveling. |
| "Description-Enable-Endless-Leveling-Compatibility" | A description of what the "Enable-Endless-Leveling-Compatibility" does. | A description of what another variable does. |
| "Default-Mermaids-Content" | false | Toggle the Mermaids mod content. If false, you can only transform into a Mermaid as a mermaid species. |
| "Description-Default-Mermaids-Content" | A description of what the "Default-Mermaids-Content" does. | A description of what another variable does. |
| "Mermaid-Only-In-Water" | true | When the player is a mermaid race, they will only have a Mermaid tail while in water. |
