Config
Every config file the mod generates, every option and its default. Updated for 4.0.0.
On this page
- In-Game Server Configuration Menu
- Default Config
- Mermaids Config
- Siren Song
- Drying Out
- Werewolf Config
- Silver Weakness
- Werewolf Howl
- Vampire Config
- Sunlight and Blood
- Blood Drain
- Lamia Config
- Store Config
- Mermaid Zones and Whitelist Config
- Mermaids Orbis Origins Config
- Mermaids Endless Leveling Config
- Endless Leveling Race Files
- Mermaids Cultivation Config
- Cultivation Merfolk Race Config
This page covers every config file the Mermaids mod generates, updated for Mermaids Update Version 4.0.0. Every file lives under mods/Siren_Mermaids/ and each one carries its own ConfigVersion, which increases automatically whenever that file’s layout changes – your existing settings are migrated for you, and new options are appended with their defaults. You never need to edit ConfigVersion by hand.
New in 4.0.0: a Lamia Config for the new Lamia creature,
"Enable-Lamia-Transformation"in the Default Config, and a Store Config for the Octopus, Manta and Seahorse tails sold at the store.
The long Description-* and *-Information strings in each file are written by the mod and reset to the current text whenever it loads, so editing them has no lasting effect. They are listed below as “a long string” for completeness.
In-Game Server Configuration Menu
Everything on this page can be edited from inside the game, without opening a file or restarting the server.
Open the Mythical Creatures menu with /mc and pick Server Settings. The card only appears for players holding the mermaids.admin.config permission.
- Changes are pending until you press Save. The menu shows a running count of unsaved changes, and a Revert button discards them.
- Settings are grouped into sections: Mermaid, Drying Out, Appearance, Siren Song, Creatures, Werewolf, Silver Weakness, Werewolf Howl, Vampire, Lamia, Sunlight and Blood, Blood Drain, Zones, Hunger Mods and Store Tails.
- Compatibility sections for Cultivation, Endless Leveling and Orbis Origins only appear when that mod is actually installed.
- Each row’s caption shows the exact config key it edits, and saving writes straight to the same JSON files documented below, so the two ways of configuring the mod never disagree.
The files remain fully supported – edit them directly if you prefer, then run /mermaids admin reload. A file with a typo in it is skipped with a warning rather than reset, so a mistake never wipes your settings.
Default Config
This is the default config values and descriptions for the Default Config, config version 1,
found in the path mods/Siren_Mermaids/Config.json. This file controls settings that are shared across every Mythical Creature.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| “PluginName” | “Mermaids and Mythical Creatures” | Plugin name. |
| “ModVersion” | Version of the last ran mod jar. | Version of the last ran mod jar. |
| “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. |
| “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. |
| “Default-Player-Creatures-Values” | A long string explaining the accepted values for Default-Player-Creatures. | Tells you the accepted string values: Mermaid, Werewolf, Vampire, and Lamia (not case-sensitive). |
| “Default-Player-Creatures” | [“Mermaid”] | An array of the Mythical Creature(s) new players default to when they first join the server. |
| “Enable-Creatures-Information” | A long string explaining the Enable-*-Transformation options. | Information about the Enable-Mermaid/Werewolf/Vampire/Lamia-Transformation options below. |
| “Enable-Mermaid-Transformation” | true | Enable or disable Mermaid transformations on the server entirely. |
| “Enable-Werewolf-Transformation” | true | Enable or disable Werewolf transformations on the server entirely. |
| “Enable-Vampire-Transformation” | true | Enable or disable Vampire transformations on the server entirely. |
| “Enable-Lamia-Transformation” | true | New in 4.0.0. Enable or disable Lamia transformations on the server entirely. |
| “Enable-Generic-Console-Logs” | false | Send console logs for the majority of Mythical Creature actions: transforming and modifying settings. |
| “New-Version-Message” | true | When the Mermaids mod version is outdated, send a message to OPed players when they join. |
| “Do-Not-Change:Add-mermaids-Permission-For-Default” | false | Ignore this value; the mod uses it to remember that it has added the permission “mermaids” to the Adventure permission group. |
| “Do-Not-Change:Add-mermaids-Permission-For-LuckPerms” | false | Ignore this value; the same as above, but for the LuckPerms plugin if installed. |
| “DebugMode” | false | Run the plugin in debug mode to get alerts about most actions of the plugin. |
Mermaids Config
This is the default config values and descriptions for the Mermaids Config, config version 22,
found in the path mods/Siren_Mermaids/MermaidsConfig.json. This file only controls Mermaid-specific settings.
Older installs will have this data inside
Config.jsoninstead – the mod automatically copies it over toMermaidsConfig.jsonthe first time you launch Update Version 3 or newer.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| “ConfigName” | “Mermaids Mythical Creature Config” | The name given to this config file. |
| “Config-Information” | A long string that tells you to come to this site. | Information about how to find stuff related to the config. |
| “ConfigVersion” | 22 | Current Version when you have loaded for the plugin. |
| “Transformation-Mode” | 0 | 0: Transform when entering water. 1: Requires the user to drink a Mermaid Potion or have a Mermaid Pendant to transform into a Mermaid. 2: Transform when entering water, but Mermaid Potions and Mermaid Pendants have no effect. |
| “Description-Transformation-Mode” | A long string that tells you about the description for Transformation-Mode. | A description of the Transformation-Mode config option. |
| “Always-A-Mermaid-Even-On-Land” | false | If you have permissions to be a Mermaid, then you’ll always be transformed into a Mermaid even on land. |
| “Allow-Players-To-Toggle-Transformation-On-Land” | true | Allows individual players to toggle whether they stay a Mermaid while on land. |
| “Require-Transformation-Permission” | false | Requires the player to have the permission – mermaids.transform – to transform into a Mermaid. |
| “Mermaid-On-Land-Speed-Debuff” | true | If the player is transformed as a Mermaid, they will have a speed debuff while on land. |
| “Blocks-Can-Cause-Transformations” | true | Some blocks like mud and a cauldron will cause you to transform into a mermaid. Only water counts – lava, tar, poison and slime never do. |
| “Rain-Can-Cause-Transformations” | false | Walking into the rain will cause you to transform into a mermaid. |
| “Mermaid-Gives-Fullbright” | false | Whether being transformed into a Mermaid grants fullbright vision underwater. |
| “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. The Server Settings menu accepts 0 to 127. |
| “Mermaid-Transformation-Particles” | true | A burst of bubbles when a player grows their tail, and a smaller puff when it goes again. Purely cosmetic, and only sent to players in range. Set to false for invisible transformations. |
| “Mermaid-Transformation-Particles-Description” | A long string describing the transformation particles. | A description of the Mermaid-Transformation-Particles config option. |
| “Mermaid-Transformation-Sound” | true | A chime when a player grows their tail and a lower one when it goes. Bystanders hear it in the world; the transforming player hears it in stereo. Set to false for silent transformations. |
| “Mermaid-Transformation-Sound-Description” | A long string describing the transformation sound. | A description of the Mermaid-Transformation-Sound config option. |
| “Mermaid-Shimmer” | true | Lets mermaids wear a shimmer – a band of light that drifts up them for as long as they have their tail. Cosmetic only: it does not tint the tail or fins. |
| “Mermaid-Shimmer-Description” | A long string describing the shimmer. | A description of the Mermaid-Shimmer config option. |
| “Mermaid-Companion” | true | Lets each mermaid pick a companion fish from the mermaid menu. It swims in while they are transformed and in water, follows them, and swims off when they leave the water. It cannot be hurt or killed. Set to false to remove the option for everyone. |
| “Mermaid-Companion-Description” | A long string describing the companion fish. | A description of the Mermaid-Companion config option. |
| “Siren-Song” | true | Gives transformed mermaids the Siren Song. Set to false to remove the ability entirely. |
| “Siren-Song-Description” | A long string describing the Siren Song ability. | A description of the Siren-Song config option. |
| “Siren-Song-Radius” | 12.0 | How far the song carries, in blocks, for all three of its effects. |
| “Siren-Song-Cooldown-Seconds” | 60.0 | The wait between songs, in seconds. |
| “Siren-Song-Transfix-Seconds” | 6.0 | How long a hostile creature is held in place, in seconds. 0 drops this effect. |
| “Siren-Song-Ally-Buff-Seconds” | 10.0 | How long nearby players keep the regeneration buff, in seconds. 0 drops this effect. |
| “Siren-Song-Lure-Seconds” | 8.0 | How long sea life keeps being drawn in, in seconds. 0 drops this effect. |
| “Siren-Song-Tuning-Description” | A long string explaining the five Siren-Song tuning options. | A description of the Siren-Song tuning options. |
| “Enable-Drying-Out” | false | Mermaids slowly dry out while on land – see Drying Out below. Off by default. |
| “Description-Enable-Drying-Out” | A long string explaining what drying out does. | A description of the Enable-Drying-Out config option. |
| “Drying-Out-Only-While-Transformed” | false | Only drain the meter while the player is actually transformed with a tail. See Drying Out for why the default is false. |
| “Description-Drying-Out-Only-While-Transformed” | A long string explaining both settings of this option. | A description of the Drying-Out-Only-While-Transformed config option. |
| “Drying-Out-Seconds-To-Empty” | 60 | Seconds on land to drain the meter from full to empty. |
| “Description-Drying-Out-Seconds-To-Empty” | A long string comparing this to vanilla drowning. | A description of the Drying-Out-Seconds-To-Empty config option. |
| “Drying-Out-Seconds-To-Refill” | 3 | Seconds in contact with water to refill the meter from empty to full. Set to 0 to refill instantly. |
| “Drying-Out-Damage” | 4 | Damage dealt each interval once the meter is empty (lowered from 10 in 3.2.0). Set to 0 to make drying out harmless – meter and HUD only, no damage. |
| “Drying-Out-Damage-Interval-Seconds” | 3 | Seconds between each point of drying out damage while the meter is empty (raised from 1 in 3.2.0). |
| “Tail-Color-Permissions” | false | When true, each tail color requires its own permission – see Tail Color Permissions. Off by default, so every color stays available to everyone. |
| “Description-Tail-Color-Permissions” | A long string explaining the permission nodes and wildcards. | A description of the Tail-Color-Permissions config option. |
| “Description-Drying-Out-Damage” | A long string explaining the damage and its damage cause. | A description of the Drying-Out-Damage config option. |
| “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. |
Siren Song
/mermaids song (permission mermaids.song) is a transformed mermaid’s active ability: one burst that holds hostile creatures where they stand, gives every player nearby a regeneration buff, and draws sea life that is in the water in toward the singer – never through walls. Its cooldown survives a relog or a toggle. With the Cultivation mod installed, Merfolk perform it as a cultivation technique instead, and the command steps aside.
Drying Out
Off by default – turning it on changes how a mermaid server plays, so it is opt-in.
With "Enable-Drying-Out" set to true, a mermaid standing on land slowly dries out. A meter appears above the hotbar and drains like the vanilla breath bar; once it empties, the player takes Drying-Out-Damage every Drying-Out-Damage-Interval-Seconds under the mod’s own Mermaids_DryingOut damage cause. This can kill. Any contact with water refills the meter, and the HUD disappears once the player is safe again. Dying refills it too, and toggling the transformation off and on does not.
Rebalanced in 3.2.0. The damage default dropped from 10 every 1 second to 4 every 3 seconds. The old rate could kill a full-health player in about ten seconds, which was often faster than the trip to the nearest lake – drying out is meant to push a mermaid back toward water, not execute them.
Your existing values decide what happens on update. If your
Drying-Out-DamageandDrying-Out-Damage-Interval-Secondsare still sitting at the old defaults of10and1, they are retuned to4and3for you. If you changed either one, your number is kept exactly as it is – a server that deliberately tuned this keeps its balance.
What does not dry you out:
- Rain. Standing in a downpour counts as being wet and keeps the meter full. This applies even when
"Rain-Can-Cause-Transformations"isfalse– rain not transforming you on this server does not mean rain fails to wet you. - Creative mode. Creative players are exempt entirely; the meter and HUD switch off. Switching to creative resets the meter rather than pausing it, so coming back to survival starts you from full instead of resuming a stale drain that could kill instantly.
A few things worth knowing before enabling it:
Drying-Out-Only-While-Transformedisfalsefor a reason. Mermaids revert to their human model moments after leaving water, so setting this totruemeans the meter almost never gets the chance to drain – unless you also run"Always-A-Mermaid-Even-On-Land". Leave itfalseunless you know you want the narrower behavior.- Keep
Drying-Out-Seconds-To-Emptyabove ~17 seconds. That is roughly how long vanilla drowning takes to empty, and drying out is meant to be the slower, more forgiving of the two. - Set
Drying-Out-Damageto0if you want the meter purely as flavor. The bar and HUD still work, they just never hurt anyone.
Werewolf Config
See the Werewolf page for more info.
This is the default config values and descriptions for the Werewolf Config, config version 4,
found in the path mods/Siren_Mermaids/WerewolfConfig.json.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| “ConfigName” | “Werewolf Mythical Creature Config” | The name given to this config file. |
| “Config-Information” | A long string that tells you to come to this site. | Information about how to find stuff related to the config. |
| “ConfigVersion” | 4 | Current Version when you have loaded for the plugin. |
| “Transformation-Mode” | 0 | 0: Transform at night. 1: Requires the user to drink a Werewolf Potion or have the Moon Charm to transform into a Werewolf. 2: Transform at night, but Werewolf Potions and the Moon Charm have no effect. |
| “Description-Transformation-Mode” | A long string that tells you about the description for Transformation-Mode. | A description of the Transformation-Mode config option. |
| “Description-Transformation-Daytime-Cycle” | A long string explaining the time format and the two options below. | Explains that times are in 24-hour format, and how Werewolf-Nighttime-Transform/Werewolf-Daytime-Transform work together. |
| “Werewolf-Nighttime-Transform” | 21 | The in-game hour (0-23) that a Werewolf transformation begins at night. |
| “Werewolf-Daytime-Transform” | 3 | The in-game hour (0-23) that a Werewolf transforms back into a Human. |
| “Description-Moon-Phase-Transformation” | A long string explaining the moon phase numbering. | Explains the Disabled-Moon-Phase-Transformation option: 0 = Full Moon, 1 = Waxing Gibbous, 2 = First Quarter, 3 = Waxing Crescent, 4 = New Moon. |
| “Disabled-Moon-Phase-Transformation” | [4] | An array of moon phases that will NOT trigger a Werewolf transformation, even during the configured nighttime hours. Defaults to disabling transformations during the New Moon. |
| “Werewolf-Transformation-Particles” | true | A burst of moonlight, torn fur and kicked-up dust when a player turns into a Werewolf, and a smaller shed of fur when they turn back. Cosmetic only. |
| “Werewolf-Transformation-Particles-Description” | A long string describing the particles. | A description of the Werewolf-Transformation-Particles config option. |
| “Silver-Weakness” | false | A Werewolf takes extra damage from an attacker holding an item on the Silver-Item-Ids list – see Silver Weakness. Off by default. |
| “Silver-Weakness-Description” | A long string describing silver weakness. | A description of the Silver-Weakness config option. |
| “Silver-Weakness-Only-While-Transformed” | true | Only take extra silver damage while actually transformed. Set to false to apply it in human form too. |
| “Silver-Weakness-Only-While-Transformed-Description” | A long string describing the option. | A description of the Silver-Weakness-Only-While-Transformed config option. |
| “Silver-Item-Ids” | [] | Item ids (the same value as an item’s id in its asset JSON) that count as silver. Empty by default, because no silver item exists in vanilla or this mod. |
| “Silver-Item-Ids-Description” | A long string describing the item id list. | A description of the Silver-Item-Ids config option. |
| “Silver-Damage-Multiplier” | 1.5 | Multiplier applied to damage from a silver-wielding attacker. Never goes below 1. |
| “Silver-Damage-Multiplier-Description” | A long string describing the multiplier. | A description of the Silver-Damage-Multiplier config option. |
| “Werewolf-Howl” | true | Gives transformed werewolves the Howl. Set to false to remove the ability entirely. |
| “Werewolf-Howl-Description” | A long string describing the howl. | A description of the Werewolf-Howl config option. |
| “Werewolf-Howl-Radius” | 10.0 | How far the howl carries, in blocks, for both of its effects. |
| “Werewolf-Howl-Cooldown-Seconds” | 45.0 | The wait between howls, in seconds. |
| “Werewolf-Howl-Fear-Seconds” | 5.0 | How long a hostile creature is slowed, in seconds. 0 drops that half. |
| “Werewolf-Howl-Pack-Buff-Seconds” | 12.0 | How long the pack keeps its rallying buff, in seconds. 0 drops that half. |
| “Werewolf-Howl-Tuning-Description” | A long string explaining the four Howl tuning options. | A description of the Werewolf-Howl tuning options. |
Silver Weakness
Off by default, and the item list starts empty, so nothing happens until an admin both turns it on and lists which items count as silver. Once set up, damage from an attacker holding one of those items is multiplied by Silver-Damage-Multiplier. It matches the Mermaid’s drying out and the Vampire’s sunlight: a weakness each creature can be given, never one forced on a server by an update.
Werewolf Howl
/mc werewolf howl (permission mermaids.werewolf.howl) is a transformed werewolf’s active ability: one cry that gives every werewolf nearby – the howler included – a timed regeneration buff, and slows anything hostile to the howler for a few seconds. Its cooldown survives a relog or a toggle.
Vampire Config
See the Vampire page for more info.
This is the default config values and descriptions for the Vampire Config, config version 3,
found in the path mods/Siren_Mermaids/VampireConfig.json.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| “ConfigName” | “Vampire Mythical Creature Config” | The name given to this config file. |
| “Config-Information” | A long string that tells you to come to this site. | Information about how to find stuff related to the config. |
| “ConfigVersion” | 3 | Current Version when you have loaded for the plugin. |
| “Transformation-Mode” | 0 | 0: Always be transformed into a Vampire. 1: Only transform into a Vampire at night or with a Vampire Potion. 2: Always be transformed, but Vampire Potions have no effect. |
| “Description-Transformation-Mode” | A long string that tells you about the description for Transformation-Mode. | A description of the Transformation-Mode config option. |
| “Vampire-Transformation-Particles” | true | A crimson flare, scattering bats and blood mist when a player turns into a Vampire, and a smaller dark puff when they turn back. Cosmetic only. |
| “Vampire-Transformation-Particles-Description” | A long string describing the particles. | A description of the Vampire-Transformation-Particles config option. |
| “Enable-Sunlight-And-Blood” | false | Vampires burn in daylight and must feed to keep their Blood up – see Sunlight and Blood. Off by default. |
| “Description-Enable-Sunlight-And-Blood” | A long string describing Sunlight and Blood. | A description of the Enable-Sunlight-And-Blood config option. |
| “Sunlight-And-Blood-Only-While-Transformed” | true | Only burn and drain Blood while actually transformed. Set to false to apply it in human form too. |
| “Description-Sunlight-And-Blood-Only-While-Transformed” | A long string describing the option. | A description of the Sunlight-And-Blood-Only-While-Transformed config option. |
| “Sunlight-Exposure-Threshold” | 7.0 | How much daylight counts as burning, from 0 to 15: the block’s sky light multiplied by how high the sun is. 15 is open ground at noon, about 7 is thin cover or just after dawn, 0 is underground or deep night. Raise it for more forgiving shade, lower it to make dawn lethal. |
| “Description-Sunlight-Exposure-Threshold” | A long string explaining the 0-15 scale. | A description of the Sunlight-Exposure-Threshold config option. |
| “Sunlight-Water-Shelters” | true | Lets deep water count as cover from the sun. |
| “Sunlight-Damage” | 1.0 | Damage dealt every Sunlight-Damage-Interval-Seconds while exposed. |
| “Sunlight-Damage-Interval-Seconds” | 1.5 | Seconds between sunlight damage ticks. |
| “Sunlight-Damage-Multiplier-When-Starved” | 2.0 | Multiplier on sunlight damage once Blood is empty. Never below 1. |
| “Sunlight-Minimum-Health” | 1.0 | The health floor: burning never takes a Vampire below it, so the sun drives them indoors but never kills outright. |
| “Description-Sunlight-Damage” | A long string explaining the sunlight damage options. | A description of the sunlight damage options. |
| “Blood-Seconds-To-Empty” | 600.0 | How long a full Blood meter (0-100) lasts with no feeding, in seconds. |
| “Blood-Per-Damage-Dealt” | 2.0 | Blood returned per point of damage dealt (a 5 damage hit at 2.0 refills 10 of the 100-point meter). |
| “Blood-Only-From-Living-Targets” | true | Stops item frames, blocks and other bloodless things from feeding the Vampire. |
| “Blood-Regen-Health-Per-Second” | 0.125 | Health per second a fed Vampire regenerates. Stops entirely at empty Blood. |
| “Description-Blood” | A long string explaining the four Blood options. | A description of the Blood options. |
| “Blood-Drain-Ability” | true | Gives transformed vampires Blood Drain. Works even with Sunlight and Blood off. Set to false to remove the ability entirely. |
| “Blood-Drain-Ability-Description” | A long string describing Blood Drain. | A description of the Blood-Drain-Ability config option. |
| “Blood-Drain-Cooldown-Seconds” | 30.0 | The wait between activations, in seconds. |
| “Blood-Drain-Duration-Seconds” | 6.0 | How long the window stays open once activated, in seconds. |
| “Blood-Drain-Lifesteal-Percent” | 0.5 | Share of the damage dealt during the window that comes back as health (0.5 = half), from 0 to 1. |
| “Blood-Drain-Tuning-Description” | A long string explaining the three Blood Drain options. | A description of the Blood Drain tuning options. |
Sunlight and Blood
Off by default – it is a survival mechanic, and a server should only see it if it deliberately turns it on. With it on, a transformed Vampire standing in enough daylight takes Sunlight-Damage every Sunlight-Damage-Interval-Seconds, but never below Sunlight-Minimum-Health: the sun drives them indoors rather than killing them. Their Blood meter drains on its own over Blood-Seconds-To-Empty and refills from the damage they deal to living things. While a Vampire has Blood it slowly regenerates health; once starved, the sun burns harder.
Blood Drain
/mc vampire drain (permission mermaids.vampire.drain) opens a timed window on a cooldown: while it is open, a share of every point of melee damage the Vampire deals comes back as health. It works whether or not Sunlight and Blood is on, and its cooldown survives a relog or a toggle.
Lamia Config
New in 4.0.0, see the Lamia page for more info.
This is the default config values and descriptions for the Lamia Config, config version 1,
found in the path mods/Siren_Mermaids/LamiaConfig.json.
A deliberately thin file: a Lamia has exactly one mode – chosen in the menu, on land and in water – so there is no Transformation-Mode here. Turning the creature off for the whole server is "Enable-Lamia-Transformation" in the Default Config.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| “ConfigName” | “Lamia Mythical Creature Config” | The name given to this config file. |
| “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. |
| “Lamia-Transformation-Particles” | true | A green-gold flare, shed scales and a low ring of dust when a player turns into a Lamia, and a smaller version when they turn back. Cosmetic only, and only sent to players in range. |
| “Lamia-Transformation-Particles-Description” | A long string describing the particles. | A description of the Lamia-Transformation-Particles config option. |
Store Config
New in 4.0.0. This is the default config values and descriptions for the Store Config, config version 1,
found in the path mods/Siren_Mermaids/StoreConfig.json.
It controls the Octopus, Manta and Seahorse tails – cosmetic tails a player buys once, bound to their Hytale account, and usable on any server running Mermaids 4.0.0. The server learns who owns one by reading a public list of buyers’ player ids, one file per tail. Each check is a plain download; nothing about your server is sent. The last lists are kept in Data/StoreCache.json, so purchases still apply if the store cannot be reached.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| “ConfigName” | “Mermaids Store Config” | The name given to this config file. |
| “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. |
| “Paid-Content-Enabled” | true | Offers the store tails. When true, everyone sees them on the Model tab – unlocked for buyers, locked with a store link for everyone else – and the server reads the purchase lists. When false they are hidden, nobody can wear one (wearers go back to the Curve Tail, saved looks are kept) and nothing is fetched. Applies live, no restart. |
| “Paid-Content-Enabled-Description” | A long string describing the option. | A description of the Paid-Content-Enabled config option. |
| “Check-Interval-Hours” | 6 | How often to re-read the purchase lists, in hours, from 1 to 168. The first check runs about 25 seconds after start-up. Applies on Save in the Server Settings menu or /mermaids admin reload. |
| “Check-Interval-Hours-Description” | A long string describing the option. | A description of the Check-Interval-Hours config option. |
| “Allow-Recheck-Command” | true | Whether players may run /mermaids store recheck to pick up a new purchase sooner. |
| “Allow-Recheck-Command-Description” | A short string describing the option. | A description of the Allow-Recheck-Command config option. |
| “Recheck-Cooldown-Seconds” | 60 | Server-wide cooldown between rechecks, in seconds, from 10 to 3600, shared by every player. |
| “Recheck-Cooldown-Seconds-Description” | A short string describing the option. | A description of the Recheck-Cooldown-Seconds config option. |
| “Base-Url” | “https://xianxia.dev/api/get/entitlements/” | Where each tail’s list is read from (<Base-Url><product>.json). Change it only to test with a local copy; a blank value falls back to the default. |
| “Base-Url-Description” | A short string describing the option. | A description of the Base-Url config option. |
Mermaid Zones and Whitelist Config
This is the default config values and descriptions for the Mermaid Zones and Whitelist Config, 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. |
| “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 included when true. If you have an instance in blacklist, then 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 transform 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 transforming into mermaids inside of that world. |
| “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, 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, config version 5,
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” | 5 | Current Version when you have loaded for the plugin. |
| “Enable-Endless-Leveling-Compatibility” | true | Toggle for the Mermaids mod to 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, every Mythical Creature transformation depends on the player’s Endless Leveling race: mermaid and merfolk races can become a Mermaid, werewolf races a Werewolf, vampire races a Vampire and lamia races a Lamia, and no race can take another race’s form. The werewolf, vampire, merfolk and lamia races come from Mermaids Premium. |
| “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. |
| “Race-Lock-Ignore-Potions” | false | Only applies while “Default-Mermaids-Content” is false. When true, Mermaid potions and pendants no longer transform non-mermaid-race players – only the Endless Leveling mermaid races can transform at all. When false, potions and pendants still work as a temporary transformation for anyone. |
| “Description-Race-Lock-Ignore-Potions” | A description of what the “Race-Lock-Ignore-Potions” does. | A description of what another variable does. |
| “Race-Sync-Interval-Seconds” | 30 | Race changes apply instantly through Endless Leveling’s own events – this only controls a safety-net sweep that re-checks every online player’s race on this interval, in case an event was ever missed. Set to 0 to turn the sweep off; any other value is raised to at least 5. |
| “Description-Race-Sync-Interval-Seconds” | A description of what the “Race-Sync-Interval-Seconds” does. | A description of what another variable does. |
| “Ignore-DoNotChange-Detected-Endless-Before” | false | Ignore this value; the mod uses it to remember that it has already detected the Endless Leveling mod once. |
| “Disable-Mermaid-Items” | false | When true, the Mermaids Workbench stops crafting, and the Mermaid potions, Mermaid Pendant and Moon Charm stop working (the Pendant and Moon Charm also stop dropping from mobs), so a race-locked server’s race is the only way in. Their tooltips show (Disabled). It does not race-lock anything on its own – "Default-Mermaids-Content" must also be false. |
| “Description-Disable-Mermaid-Items” | A long string describing the option. | A description of the Disable-Mermaid-Items config option. |
Endless Leveling Race Files
Without Mermaids Premium installed, the mod registers its own nine-race Mermaid line into Endless Leveling, and writes each race’s definition to its own file under mods/Siren_Mermaids/Compatibility/EndlessLevelingRaces/ (mermaid.json, mermaid_princess.json, mermaid_crown_princess.json, mermaid_tidebreaker.json, mermaid_abyssal.json, mermaid_tideweaver.json, mermaid_moonbinder.json, mermaid_queen.json and mermaid_empress.json). Each holds that race’s display name, description, base attributes, passives and ascension requirements, and can be tuned like any Endless Leveling race file.
Each file carries a
Race-Version. When the mod ships a new version of the races, every field is reset to the new defaults – and the file you had is first copied into a.oldfolder beside it, so your edits can be carried over by hand.
With Premium installed, Premium’s own race lines are used instead and these files are not.
Mermaids Cultivation Config
See the Cultivation Addon page for more info.
This is the default config values and descriptions for the Mermaids Cultivation config, config version 2,
found in the path mods/Siren_Mermaids/Compatibility/Cultivation.json.
Requires the Cultivation mod, version 0.9.1 or newer. Without it this file is still generated, but nothing in it does anything.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| “Config-Name” | “Cultivation Compatibility” | The name given to this config file. |
| “Config-Description” | “This config file allows the user to modify compatibility issues with the Cultivation 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” | 2 | Current Version when you have loaded for the plugin. |
| “Enable-Cultivation-Compatibility” | true | Toggle for the Mermaids mod to add a brand new Merfolk race to Cultivation. Its stats live in the Merfolk race config below. |
| “Description-Enable-Cultivation-Compatibility” | A description of what the “Enable-Cultivation-Compatibility” does. | A description of what another variable does. |
| “Default-Mermaids-Content” | false | Toggle the Mermaids mod content. If false, all Mermaid transformations depend on the player being the Cultivation Merfolk race. |
| “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 the Merfolk race, they will only have a Mermaid tail while in water. |
| “Race-Lock-Ignore-Potions” | false | Only applies while “Default-Mermaids-Content” is false. When true, Mermaid potions and pendants no longer transform non-Merfolk players – only the Merfolk race can transform at all. When false, potions and pendants still work as a temporary transformation for anyone. |
| “Description-Race-Lock-Ignore-Potions” | A description of what the “Race-Lock-Ignore-Potions” does. | A description of what another variable does. |
| “Ignore-DoNotChange-Detected-Cultivation-Before” | false | Ignore this value; the mod uses it to remember that it has already detected the Cultivation mod once. |
| “Disable-Mermaid-Items” | false | The same switch as in the Endless Leveling config: the Mermaids Workbench, Mermaid potions, Mermaid Pendant and Moon Charm stop working, so Merfolk is the only way in on a race-locked server. It does not race-lock anything on its own – "Default-Mermaids-Content" must also be false. |
| “Description-Disable-Mermaid-Items” | A long string describing the option. | A description of the Disable-Mermaid-Items config option. |
Cultivation Merfolk Race Config
See the Cultivation Addon page for more info.
This is the default config values and descriptions for the Merfolk race the Mermaids mod registers into Cultivation, config version 1,
found in the path mods/Siren_Mermaids/Compatibility/CultivationRaces/merfolk.json.
These are the same stat knobs Cultivation’s own Race/*.json files use, so a Merfolk cultivator can be balanced against the mod’s built-in races directly.
| Variable Name: | Default Value: | Description: |
|---|---|---|
| “Config-Name” | “Cultivation Merfolk Race” | The name given to this config file. |
| “Config-Description” | “This config file tunes the Merfolk race the Mermaids mod registers into the Cultivation 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. |
| “ID” | “Siren:Merfolk” | The internal race id Cultivation stores on the player. |
| “Description-ID” | A long string warning about changing the ID. | Warns that changing the ID after players have already picked Merfolk resets them back to Human, so only change it on a fresh world. |
| “Display-Name” | “Merfolk” | The race name shown in Cultivation’s race menu. |
| “Display-Name-Translation-Key” | “server.races.merfolk.name” | The translation key used for the display name, so the race name localizes. |
| “Description” | “Born of the tide. Their bodies remember the sea, and the Water Dao answers them readily.” | The race description shown in Cultivation’s race menu. |
| “Unlock-Realm” | “BodyRefinement” | The Cultivation realm a player must reach before Merfolk can be chosen. Accepts BodyRefinement, QiCondensation, FoundationEstablishment, GoldenCoreFormation, NascentSoul, SoulFormation, VoidRefinement, or a 1-based realm number. An unrecognized value logs a warning and falls back to Body Refinement. |
| “Description-Unlock-Realm” | A long string listing the accepted realm values. | A description of the Unlock-Realm config option. |
| “Health-Bonus-Percent” | 5 | Percent bonus to the Merfolk cultivator’s maximum health. |
| “Damage-Bonus-Percent” | -5 | Percent change to damage dealt. Negative by default – Merfolk trade raw force for Qi affinity. |
| “Qi-Gain-Rate-Percent-Bonus” | 15 | Percent bonus to the rate Qi is absorbed while meditating. |
| “Breakthrough-Duration-Percent-Reduction” | 5 | Percent reduction to how long a breakthrough ritual takes. |
| “Qi-Alignment-Yin-Bias-Percent” | 20 | Percent Yin bias applied to absorbed Qi. Positive because water is a Yin element, so Merfolk Qi darkens slightly. |
| “Description-Stats” | A long string explaining the stat knobs and the Yin bias. | A description of the five stat options above. |