View source for Custom Forms

<translate>
<!--T:1-->
'''Custom forms''' are transformations you add or change with JSON files. Forms can live in two places; both use exactly the same JSON schema and Java class (<code>FormConfig.java</code>), and only the folder they sit in changes what they mean:
</translate>

{| class="wikitable"
! <translate><!--T:2--> Location</translate> !! <translate><!--T:3--> What it is</translate>
|-
| <code>config/dragonminez/races/<race>/forms/*.json</code> || <translate><!--T:4--> '''Race forms''' belong to one race only (for example, Super Saiyan only exists for Saiyans). See [[Special:MyLanguage/Custom Races|Custom Races]].</translate>
|-
| <code>config/dragonminez/forms/*.json</code> || <translate><!--T:5--> '''Stack forms''' are shared by all races and designed to layer on top of whatever race form is already active.</translate>
|}

<translate>
<!--T:6-->
This page is about the second kind, stack forms, but the [[Special:MyLanguage/Custom Forms#Field reference|field reference]] below applies to race forms too.
</translate>

<translate>
<!--T:7-->
Loader: <code>ConfigManager.createOrLoadStackForms()</code> reads every file in <code>config/dragonminez/forms/</code> (<code>ConfigLoader.loadStackForms</code>). Files whose name starts with <code>old_</code> are ignored.
</translate>

<translate>
== What a stack form is == <!--T:8-->
</translate>
{{Main|Transformations}}
<translate>
<!--T:9-->
A stack form doesn't replace your current transformation: it stacks its multipliers on top of it. The clearest example is [[Special:MyLanguage/Kaioken|Kaioken]]: a Saiyan can be in base form or Super Saiyan and ''also'' be in Kaioken x2 at the same time, multiplying whatever form they are already in. The built-in stack form groups are <code>kaioken</code> (x2, x3, x4, x10, x20) and <code>ultimate</code> (<code>StackForms.java</code>).
</translate>

<translate>
<!--T:10-->
A stack group is unlocked by the stack skill named in its <code>formType</code>: <code>kaioken</code> or <code>ultimate</code>. A form of the group becomes available when that skill reaches the form's <code>unlockOnSkillLevel</code>.
</translate>

<translate>
== File structure == <!--T:11-->
</translate>
<translate>
<!--T:12-->
There is one file per group, for example <code>config/dragonminez/forms/kaioken.json</code> (shortened):
</translate>

<syntaxhighlight lang="json">
{
  "configVersion": "2.2.0",
  "groupName": "kaioken",
  "formType": "kaioken",
  "forms": {
    "x2": {
      "name": "x2",
      "unlockOnSkillLevel": 1,
      "keepBaseFormHeadBones": true,
      "strMultiplier": 1.1,
      "skpMultiplier": 1.1,
      "defMultiplier": 1.125,
      "pwrMultiplier": 1.1,
      "speedMultiplier": 1.1,
      "healthDrain": 0.03,
      "attackSpeed": 1.1,
      "tintColor": "#FF0000",
      "tintIntensity": 0.1,
      "auraColor": "#DB182C",
      "auraLayer": 1,
      "formStackable": true,
      "stackDrainMultiplier": 1.0,
      "incompatibleWith": ["ultimate.ultimate"],
      "shareMasteryWith": ["kaioken.x3"],
      "shareMasteryMultiplier": 0.25
    }
  }
}
</syntaxhighlight>

<translate>
<!--T:13-->
<code>groupName</code> is the group key (lowercase); groups are identified by it, not by the filename. Everything nested under <code>forms</code> is one form entry, keyed by its own <code>name</code>. Any field you leave out takes the default shown below.
</translate>

{{Note|type=config|title=<translate><!--T:14--> Config version</translate>|text=<translate><!--T:15--> Use <code>"configVersion": "2.2.0"</code>. A custom form file with an older or missing version is backed up to <code>config/dragonminez/oldBackup/</code> and saved again with the current version; your values are kept. A file with broken JSON syntax is skipped and reported until you fix it.</translate>}}

<translate>
== Field reference == <!--T:16-->
</translate>
<translate>
<!--T:17-->
Schema source: <code>src/main/java/com/dragonminez/common/config/FormConfig.java</code>.
</translate>

<translate>
=== Unlock and requirements === <!--T:18-->
</translate>
{{Config|General Server Config|gameplay}}

{| class="wikitable"
! <translate><!--T:19--> Field</translate> !! <translate><!--T:20--> Type</translate> !! <translate><!--T:21--> Default</translate> !! <translate><!--T:22--> What it does</translate>
|-
| <code>name</code> || <translate><!--T:23--> String</translate> || <code>""</code> || <translate><!--T:24--> Form key within the group (for example <code>x2</code>, <code>x3</code> or <code>ultimate</code>).</translate>
|-
| <code>unlockOnSkillLevel</code> || <translate><!--T:25--> Integer</translate> || <code>0</code> || <translate><!--T:26--> Level of the group's form skill that unlocks this form.</translate>
|-
| <code>formRequisite</code> || <translate><!--T:27--> String</translate> || <code>""</code> || <translate><!--T:28--> Other forms that must be mastered first, as <code>"group.form"</code>. Separate several with commas.</translate>
|-
| <code>formRequisiteType</code> || <translate><!--T:29--> String</translate> || <code>all</code> || <translate><!--T:30--> <code>all</code>: every listed form needs the mastery. <code>any</code>: one is enough.</translate>
|-
| <code>unlockOnMastery</code> || <translate><!--T:31--> Double</translate> || <code>0.0</code> || <translate><!--T:32--> Mastery the <code>formRequisite</code> forms need. <code>0</code> turns the requirement off.</translate>
|-
| <code>levelRequisite</code> || <translate><!--T:33--> Integer</translate> || <code>0</code> || <translate><!--T:34--> Player level needed. Until it is reached, the form skill cannot be leveled up to this form. Toggle: <code>levelFormRequisiteEnabled</code> in <code>general-server.json</code> → <code>gameplay</code>.</translate>
|-
| <code>sagaRequisite</code> || <translate><!--T:35--> String</translate> || <code>""</code> || <translate><!--T:36--> Saga quest that must be completed first, as <code>"sagaId:questId"</code> (for example <code>"frieza_saga:10"</code>). Until it is completed, the form skill cannot be leveled up to this form. Ignored when story mode is off or the quest does not exist. Toggle: <code>sagaFormRequisiteEnabled</code> in <code>general-server.json</code> → <code>gameplay</code>.</translate>
|}

<translate>
=== Visuals === <!--T:37-->
</translate>

{| class="wikitable"
! <translate><!--T:38--> Field</translate> !! <translate><!--T:39--> Type</translate> !! <translate><!--T:40--> Default</translate> !! <translate><!--T:41--> What it does</translate>
|-
| <code>customModel</code> || <translate><!--T:42--> String</translate> || <code>""</code> || <translate><!--T:43--> Model key for the form. Looked up like a race model: built-in keys or your own <code>geo/entity/races/<key>.geo.json</code> (see [[Special:MyLanguage/Custom Models and Assets|Custom Models and Assets]]). A stack form's model wins over the race form's.</translate>
|-
| <code>keepBaseFormHeadBones</code> || <translate><!--T:44--> Boolean</translate> || <code>false</code> || <translate><!--T:45--> Keeps the player's chosen head bone (ears, horns and so on) visible in this form.</translate>
|-
| <code>hideTail</code> || <translate><!--T:46--> Boolean</translate> || <code>false</code> || <translate><!--T:47--> Hides the Saiyan tail while in this form.</translate>
|-
| <code>transformationAnimation</code> || <translate><!--T:48--> String</translate> || <code>transf.generic</code> || <translate><!--T:49--> Animation played while charging into this form. Built-in values: <code>transf.generic</code>, <code>transf.ssj</code>, <code>transf.ssj3</code>, <code>transf.ssg2</code>, <code>transf.ozaru</code>, <code>transf.absorb</code>, <code>transf.berserker</code>, <code>transf.freezer</code>, <code>transf.freezer2</code>, <code>transf.janemba</code>, <code>transf.daima</code>. Any animation name from the player animation files (<code>assets/dragonminez/animations/entity/races/*.animation.json</code>) works, so a resource pack can add its own. Empty means the generic animation.</translate>
|-
| <code>bodyColor1</code>, <code>bodyColor2</code>, <code>bodyColor3</code>, <code>hairColor</code>, <code>eye1Color</code>, <code>eye2Color</code> || <translate><!--T:50--> Hex string</translate> || <code>""</code> || <translate><!--T:51--> Color overrides. Empty keeps the player's color. Colors blend in while charging.</translate>
|-
| <code>furUsesHairColor</code> || <translate><!--T:52--> Boolean</translate> || <code>false</code> || <translate><!--T:53--> On SSJ4 models (a <code>customModel</code> containing <code>ssj4gt</code> or <code>ssj4d</code>), colors the fur with the hair color.</translate>
|-
| <code>hairType</code> || <translate><!--T:54--> String</translate> || <code>""</code> || <translate><!--T:55--> Which of the player's hair styles to show: <code>base</code>, <code>ssj</code>, <code>ssj2</code>, <code>ssj3</code> or <code>ssj4</code>.</translate>
|-
| <code>forcedHairCode</code> || <translate><!--T:56--> String</translate> || <code>""</code> || <translate><!--T:57--> A hair code (from the hair editor) forced while in this form.</translate>
|-
| <code>extraFormLayer</code>, <code>extraFormColor</code> || <translate><!--T:58--> String / Hex</translate> || <code>""</code> || <translate><!--T:59--> Extra texture drawn over the body, tinted with <code>extraFormColor</code> (white if empty). Use a full <code>namespace:path</code> or a path inside the <code>dragonminez</code> namespace, for example <code>textures/entity/races/my_overlay.png</code>.</translate>
|-
| <code>auraType</code> || <translate><!--T:60--> String</translate> || <code>kakarot</code> || <translate><!--T:61--> 2D aura sprite set: <code>kakarot</code> or <code>god</code>.</translate>
|-
| <code>auraType3D</code> || <translate><!--T:62--> String</translate> || <code>userPreference</code> || <translate><!--T:63--> 3D aura style: <code>smooth</code>, <code>sparking</code>, <code>god</code> or <code>userPreference</code> (each player's own setting). A form that names <code>god</code> shows it for any race; as a player preference it is Glind-only.</translate>
|-
| <code>auraColor</code> || <translate><!--T:64--> Hex string</translate> || <code>""</code> || <translate><!--T:65--> Aura color. Empty keeps the player's aura color.</translate>
|-
| <code>auraLayer</code> || <translate><!--T:66--> Integer</translate> || <code>0</code> || <translate><!--T:67--> Aura layer slot. Forms on different layers show separate auras at the same time (the Kaioken forms use layer <code>1</code>).</translate>
|-
| <code>aura3DStyle</code> || <translate><!--T:68--> Object</translate> || <translate><!--T:69--> See below</translate> || <translate><!--T:70--> Shape of the 3D aura (see [[Special:MyLanguage/Custom Forms#3D aura shape|3D aura shape]]).</translate>
|-
| <code>extraAuraType</code>, <code>extraAuraType3D</code>, <code>extraAuraColor</code>, <code>extraAuraLayer</code>, <code>extraAura3DStyle</code> || — || <translate><!--T:71--> <code>kakarot</code>, <code>userPreference</code>, <code>#FFFFFF</code>, <code>-1</code>, defaults</translate> || <translate><!--T:72--> A second aura. <code>extraAuraLayer</code> must be <code>1</code>–<code>6</code> to show; <code>-1</code> means none.</translate>
|-
| <code>hasLightnings</code>, <code>lightningColor</code> || <translate><!--T:73--> Boolean / Hex</translate> || <code>false</code>, <code>""</code> || <translate><!--T:74--> Lightning bolts around the player.</translate>
|-
| <code>modelScaling</code> || <translate><!--T:75--> <code>[x, y, z]</code> floats</translate> || <code>[0.9375, 0.9375, 0.9375]</code> || <translate><!--T:76--> Model scale factors.</translate>
|-
| <code>tintColor</code>, <code>tintIntensity</code> || <translate><!--T:77--> Hex / Double</translate> || <code>#FF0000</code>, <code>0.0</code> || <translate><!--T:78--> Color tint over the player while transformed. <code>0</code> means no tint.</translate>
|-
| <code>outlineShader</code> || <translate><!--T:79--> Object</translate> || — || <translate><!--T:80--> <code>enabled</code> (<code>false</code>), <code>primaryColor</code> (<code>#7FFFFF</code>), <code>secondaryColor</code>, <code>outlineThickness</code> (<code>1.5</code>), <code>fireIntensity</code> (<code>0</code>–<code>3</code>, default <code>0</code>: animated flame tongues), <code>colorMode</code> (<code>"pulse"</code>, the default, shifts between the two colors; <code>"gradient"</code> goes from <code>primaryColor</code> next to the body to <code>secondaryColor</code> at the outer edge) and <code>bodyGlow</code> (<code>0</code>–<code>1</code>, default <code>0</code>: a glow of the outline color along the edges of the body). The same <code>outlineThickness</code> draws a wider outline than before 2.2.</translate>
|}

<translate>
=== 3D aura shape === <!--T:81-->
</translate>
<translate>
<!--T:82-->
These keys go inside <code>aura3DStyle</code> and <code>extraAura3DStyle</code> (and inside a race's <code>aura3DStyle</code> in <code>character.json</code>). Every key is optional; a missing key uses the default.
</translate>

{| class="wikitable"
! <translate><!--T:83--> Key</translate> !! <translate><!--T:84--> Default</translate> !! <translate><!--T:85--> What it does</translate>
|-
| <code>size</code> || <code>[1.10, 1.17, 1.02]</code> || <translate><!--T:86--> Width, height and depth of the aura shell.</translate>
|-
| <code>flamePeaks</code> || <code>12</code> || <translate><!--T:87--> Number of flame tongues around the shell (1–64). Smooth style only.</translate>
|-
| <code>waveFrequency</code>, <code>waveSpeed</code>, <code>waveAmplitude</code> || <code>2.0</code>, <code>5.0</code>, <code>0.75</code> || <translate><!--T:88--> Flame waves. In the sparking style, <code>waveAmplitude</code> is the spike reach and <code>waveSpeed</code> is the surge speed.</translate>
|-
| <code>noiseDetail</code>, <code>upwardBias</code> || <code>0.10</code>, <code>0.54</code> || <translate><!--T:89--> Flame turbulence, and how strongly it flows upwards.</translate>
|-
| <code>coreAlpha</code>, <code>rimAlpha</code>, <code>rimPower</code>, <code>rimThreshold</code> || <code>0.05</code>, <code>1.0</code>, <code>4.0</code>, <code>0.05</code> || <translate><!--T:90--> Opacity of the center and of the edge.</translate>
|-
| <code>coreColor</code>, <code>rimColor</code>, <code>noiseColor</code> || <code>""</code> || <translate><!--T:91--> Hex colors. Empty means derived from the aura color.</translate>
|-
| <code>secondBorderColor</code> || <code>""</code> || <translate><!--T:92--> Hex color of an outer fringe around the edge. Sparking style only; empty means no fringe.</translate>
|-
| <code>bloomIntensity</code> || <code>1.0</code> || <translate><!--T:93--> Glow strength.</translate>
|-
| <code>spikeDensity</code>, <code>spikeBurstRate</code>, <code>spikeRarity</code>, <code>bandStart</code> || <code>32</code>, <code>3.0</code>, <code>3.0</code>, <code>0.50</code> || <translate><!--T:94--> Sparking style only: spike columns (4–32), burst rate, how rare spikes are, and where the outline band starts.</translate>
|}

<translate>
=== Stats and drains === <!--T:95-->
</translate>

{| class="wikitable"
! <translate><!--T:96--> Field</translate> !! <translate><!--T:97--> Type</translate> !! <translate><!--T:98--> Default</translate> !! <translate><!--T:99--> What it does</translate>
|-
| <code>strMultiplier</code>, <code>skpMultiplier</code>, <code>stmMultiplier</code>, <code>defMultiplier</code>, <code>vitMultiplier</code>, <code>pwrMultiplier</code>, <code>eneMultiplier</code>, <code>speedMultiplier</code> || <translate><!--T:100--> Double</translate> || <code>1.0</code> || <translate><!--T:101--> Stat multipliers. RES uses the average of <code>defMultiplier</code> and <code>stmMultiplier</code>. A race form and a stack form add their bonuses together, or multiply them if <code>multiplicationInsteadOfAdditionForMultipliers</code> is on in <code>general-server.json</code>.</translate>
|-
| <code>attackSpeed</code> || <translate><!--T:102--> Double</translate> || <code>1.0</code> || <translate><!--T:103--> Attack speed multiplier.</translate>
|-
| <code>energyDrain</code>, <code>staminaDrain</code>, <code>healthDrain</code> || <translate><!--T:104--> Double</translate> || <code>0.0</code> || <translate><!--T:105--> Drain while transformed (also used for the cost of transforming). Values below <code>0</code> are treated as <code>0</code>.</translate>
|-
| <code>staminaDrainMultiplier</code> || <translate><!--T:106--> Double</translate> || <code>1.0</code> || <translate><!--T:107--> Multiplier on the stamina each attack costs while transformed.</translate>
|-
| <code>otherworldTimeDrain</code>, <code>otherworldTimeDrainMastered</code> || <translate><!--T:108--> Double</translate> || <code>1.0</code>, <code>1.0</code> || <translate><!--T:109--> How fast this form drains Baba's temporary-revive timer, at 0 mastery and at full mastery (blended in between). See [[Special:MyLanguage/Otherworld|Otherworld]].</translate>
|}

<translate>
=== Mastery === <!--T:110-->
</translate>

{| class="wikitable"
! <translate><!--T:111--> Field</translate> !! <translate><!--T:112--> Type</translate> !! <translate><!--T:113--> Default</translate> !! <translate><!--T:114--> What it does</translate>
|-
| <code>maxMastery</code> || <translate><!--T:115--> Double</translate> || <code>100.0</code> || <translate><!--T:116--> Maximum mastery (<code>0</code> means no mastery progression).</translate>
|-
| <code>masteryPerHitDealt</code>, <code>masteryPerHitReceived</code> || <translate><!--T:117--> Double</translate> || <code>0.01</code> || <translate><!--T:118--> Mastery gained per hit.</translate>
|-
| <code>passiveMasteryEveryFiveSeconds</code> || <translate><!--T:119--> Double</translate> || <code>0.001</code> || <translate><!--T:120--> Passive mastery gained every 5 seconds in the form.</translate>
|-
| <code>maxStatsMultiplier</code> || <translate><!--T:121--> Double</translate> || <code>1.25</code> || <translate><!--T:122--> At full mastery, stat multipliers above <code>1</code> are multiplied by this (scales up linearly with mastery).</translate>
|-
| <code>maxCostMultiplier</code> || <translate><!--T:123--> Double</translate> || <code>0.5</code> || <translate><!--T:124--> At full mastery, the form's drains are multiplied by this (scales linearly with mastery).</translate>
|-
| <code>stackOnMastery</code> || <translate><!--T:125--> Double</translate> || <code>0.0</code> || <translate><!--T:126--> Mastery this form needs before it can be combined with a stack form (or, for a stack form, with a race form).</translate>
|-
| <code>instantTransformOnMastery</code> || <translate><!--T:127--> Double</translate> || <code>40.0</code> || <translate><!--T:128--> Mastery this form needs for instant transformation (no charge, costs ki).</translate>
|-
| <code>allowFreeTransformOnMastery</code> || <translate><!--T:129--> Double</translate> || <code>50.0</code> || <translate><!--T:130--> Mastery this form needs before you can transform straight into it instead of going through the group in order. The group's first unlocked form never needs it.</translate>
|-
| <code>shareMasteryWith</code>, <code>shareMasteryMultiplier</code> || <translate><!--T:131--> List / Double</translate> || <code>[]</code>, <code>1.0</code> || <translate><!--T:132--> Whenever this form gains mastery, each listed form (<code>"group.form"</code>) gains that amount × <code>shareMasteryMultiplier</code>. The default Kaioken forms share 25% with the next one up.</translate>
|}

<translate>
=== Stacking behavior === <!--T:133-->
</translate>

{| class="wikitable"
! <translate><!--T:134--> Field</translate> !! <translate><!--T:135--> Type</translate> !! <translate><!--T:136--> Default</translate> !! <translate><!--T:137--> What it does</translate>
|-
| <code>formStackable</code> || <translate><!--T:138--> Boolean</translate> || <code>true</code> || <translate><!--T:139--> Both the race form and the stack form must allow stacking.</translate>
|-
| <code>stackDrainMultiplier</code> || <translate><!--T:140--> Double</translate> || <code>2.0</code> || <translate><!--T:141--> While a race form and a stack form are combined, the drains of both forms are multiplied by the <code>stackDrainMultiplier</code> of both forms.</translate>
|-
| <code>incompatibleWith</code> || <translate><!--T:142--> List of <code>"group.form"</code></translate> || <code>["ultimate.ultimate"]</code> || <translate><!--T:143--> Forms that cannot be active at the same time as this one (checked both ways). On a race form, listing <code>ultimate.ultimate</code> also keeps the Ultimate form from copying it as your best form; DragonMineZ's own forms only list it on each race's top tier.</translate>
|-
| <code>formCombo</code> || <translate><!--T:144--> String</translate> || <code>""</code> || <translate><!--T:145--> Weapon attributes id used for melee combos while in this form, for example <code>dragonminez:giant</code> for giant forms. A bare name is looked up under <code>dragonminez:</code>, then <code>minecraft:</code>. See [[Special:MyLanguage/Weapon Attributes|Weapon Attributes]].</translate>
|}

<translate>
=== Costs and effects === <!--T:146-->
</translate>

{| class="wikitable"
! <translate><!--T:147--> Field</translate> !! <translate><!--T:148--> Type</translate> !! <translate><!--T:149--> What it does</translate>
|-
| <code>triggerItemCosts</code> || <translate><!--T:150--> List of <code>{ itemId</code> or <code>itemTag, nbt, count, consume }</code></translate> || <translate><!--T:151--> Items needed to transform. Entries are alternatives: the first one the player can pay is used. <code>count</code> defaults to <code>1</code> and <code>consume</code> to <code>true</code>. <code>itemTag</code> is a tag id without <code>#</code>. Creative players skip it.</translate>
|-
| <code>durationItemCosts</code> || <translate><!--T:152--> List of <code>{ itemId</code> or <code>itemTag, nbt, durationSeconds }</code></translate> || <translate><!--T:153--> Items that keep the form going: one item buys <code>durationSeconds</code> (default <code>1</code>) of form time. When none is left, the form ends.</translate>
|-
| <code>mobEffects</code> || <translate><!--T:154--> List of <code>{ effectId, amplifier, durationTicks, ambient, visible, showIcon }</code></translate> || <translate><!--T:155--> Potion effects applied while transformed. <code>durationTicks</code> <code>-1</code> (the default) means as long as the form lasts.</translate>
|}

<translate>
== Translation keys == <!--T:156-->
</translate>
<translate>
<!--T:157-->
Stack form groups and forms are named with these keys:
</translate>

<syntaxhighlight lang="text">
race.dragonminez.stack.group.<groupName>       # e.g. "race.dragonminez.stack.group.kaioken" -> "Kaioken"
race.dragonminez.stack.form.<groupName>.<name>  # e.g. "race.dragonminez.stack.form.kaioken.x2" -> "x2"
</syntaxhighlight>

<translate>
<!--T:158-->
Add these to your <code>en_us.json</code> or to your own language file. Custom translations merge with the Crowdin ones in the same way as for [[Special:MyLanguage/Custom Races#Step 4: Add translation keys|custom races]].
</translate>

<translate>
== Reload and validate == <!--T:159-->
</translate>
<translate>
<!--T:160-->
# Save your file under <code>config/dragonminez/forms/</code>.
# Validate the JSON syntax (see [[Special:MyLanguage/How to JSON|How to JSON]]).
# Run <code>/dmzreload config</code> (see [[Special:MyLanguage/Reloading and Updating Changes|Reloading and Updating Changes]]).
# Transform in game and check that stats, drains, visuals and stacking behave as expected.
</translate>

{{Navbox Modding}}