Merge pull request #1094 from Zurphing/fix-creating-mods

[Docs] Fixes regression to Table of Contents, adds FMAB example
OpenKH · Aug 1, 2024 · f634d8e · f634d8e
2 parents 8807c94 + 18823ae
commit f634d8e
Showing 1 changed file with 79 additions and 35 deletions.
diff --git a/docs/tool/GUI.ModsManager/creatingMods.md b/docs/tool/GUI.ModsManager/creatingMods.md
@@ -21,6 +21,7 @@ This document will focus on teaching you how to create mods using the OpenKH Mod
       * [sklt](#sklt-source-example)
       * [arif](#arif-source-example)
       * [memt](#memt-source-example)
+      * [fmab](#fmab-source-example)
       * [enmp](#enmp-source-example)
       * [fmlv](#fmlv-source-example)
       * [lvup](#lvup-source-example)
@@ -282,24 +283,25 @@ Asset Example
  * `cmd`
  * `item`
  * `sklt`
- * 'arif'
- * 'memt'
+ * `arif`
+ * `memt`
+ * `fmab`
  * `enmp`
  * `fmlv`
  * `lvup`
  * `bons`
  * `atkp`
  * `przt`
  * `magc`
- * 'limt'
- * 'vtbl'
- * 'btlv'
+ * `limt`
+ * `vtbl`
+ * `btlv`
  * `objentry`
- * 'libretto'
- * 'localset'
- * 'soundinfo'
- * 'place'
- * 'jigsaw'
+ * `libretto`
+ * `localset`
+ * `soundinfo`
+ * `place`
+ * `jigsaw`
 
 Asset Example
 ```
@@ -314,12 +316,12 @@ Asset Example
         type: fmlv
 ```
 
-`trsr` Source Example
+### `trsr` Source Example
 ```
 2:
   ItemId: 347
 ```
-`cmd` Source Example
+### `cmd` Source Example
 ```
 - Id: 1
   Execute: 3
@@ -346,7 +348,7 @@ Asset Example
   Group: 2
   Reserve: 0
 ```
-`item` Source Example
+### `item` Source Example
 ```
 Stats:
 - Ability: 412
@@ -380,13 +382,13 @@ Items:
   Icon1: 9
   Icon2: 0
 ```
-`sklt` Source Example
+### `sklt` Source Example
 ```
 - CharacterId: 1
   Bone1: 178
   Bone2: 86
 ```
-`arif` Source Example
+### `arif` Source Example
 ```
 End of Sea: #End of Sea. Names are taken from worlds.md
   2:
@@ -416,7 +418,7 @@ End of Sea: #End of Sea. Names are taken from worlds.md
     Command: 60
     Reserved: []
 ```
-`memt` Source Example
+### `memt` Source Example
 ```
 MemtEntries: 
   - Index: 0 #Specify a memt index to edit. Use a new index to create a new MemtEntry.
@@ -447,7 +449,49 @@ MemberIndices:
     Friend2: 32
     FriendWorld: 42
 ```
-`enmp` Source Example
+
+### `fmab` Source Example
+```
+Entries:
+  1: #This is "Growth Ability Level"; so this edits the second entry in the list, or, LV 2.
+    HighJumpHeight: 999
+    AirDodgeHeight: 999
+    AirDodgeSpeed: 3.0
+    AirSlideTime: 1.0
+    AirSlideSpeed: 2.0
+    AirSlideBrake: 1.0
+    AirSlideStopBrake: 1.0
+    AirSlideInvulnerableFrames: 0.5
+    GlideSpeed: 2.0
+    GlideFallRatio: 0.8
+    GlideFallHeight: 1.2
+    GlideFallMax: 1.5
+    GlideAcceleration: 2.5
+    GlideStartHeight: 1.0
+    GlideEndHeight: 0.8
+    GlideTurnSpeed: 1.5
+    DodgeRollInvulnerableFrames: 0.7
+  2:
+    HighJumpHeight: 9999
+    AirDodgeHeight: 999
+    AirDodgeSpeed: 3.0
+    AirSlideTime: 1.0
+    AirSlideSpeed: 2.0
+    AirSlideBrake: 1.0
+    AirSlideStopBrake: 1.0
+    AirSlideInvulnerableFrames: 0.5
+    GlideSpeed: 2.0
+    GlideFallRatio: 0.8
+    GlideFallHeight: 1.2
+    GlideFallMax: 1.5
+    GlideAcceleration: 2.5
+    GlideStartHeight: 1.0
+    GlideEndHeight: 0.8
+    GlideTurnSpeed: 1.5
+    DodgeRollInvulnerableFrames: 0.7
+```
+
+### `enmp` Source Example
 ```
 - Id: 0
   Level: 1
@@ -473,7 +517,7 @@ MemberIndices:
   BonusLevel: 1  
 ```
 
-`fmlv` Source Example
+### `fmlv` Source Example
 ```
 Final:
 - Ability: 578
@@ -483,7 +527,7 @@ Final:
   GrowthAbilityLevel: 1
 ```
 
-`lvup` Source Example
+### `lvup` Source Example
 ```
 Sora:
   2:
@@ -500,7 +544,7 @@ Sora:
     SwordAbility: 577
 ```
 
-`bons` Source Example
+### `bons` Source Example
 ```
 2:
   Sora:
@@ -518,7 +562,7 @@ Sora:
     Unknown0c: 0
 ```
 
-`atkp` Source Example
+### `atkp` Source Example
 ```
 - Id: 0 #Hitbox 0
   SubId: 3
@@ -555,7 +599,7 @@ Sora:
   HpDrain: 15
 ```
 
-`przt` Source Example
+### `przt` Source Example
 ```
 - Id: 1
   SmallHpOrbs: 0
@@ -575,7 +619,7 @@ Sora:
   Item3Percentage: 0
 ```
 
-`magc` Source Example
+### `magc` Source Example
 ```
 - Id: 0 
   Level: 3
@@ -593,7 +637,7 @@ Sora:
   VoiceFinisher: 11
   VoiceSelf: -1
 ```
-`limt` Source Example
+### `limt` Source Example
 ```
 - Id: 1
   Character: Sora
@@ -617,7 +661,7 @@ Sora:
   Padding: []
 ```
 
-`vtbl` Source Example
+### `vtbl` Source Example
 ```
 - Id: 26
   CharacterId: 1
@@ -636,7 +680,7 @@ Sora:
   Reserved: 0
 ```
 
-`btlv` Source Example
+### `btlv` Source Example
 ```
 - Id: 0
   ProgressFlag: 0x1099
@@ -661,7 +705,7 @@ Sora:
   Padding: []
 ```
 
-`objentry` Source Example
+### `objentry` Source Example
 ```
 4:
   ObjectId: 4
@@ -687,7 +731,7 @@ Sora:
   SpawnObject4: 0
 ```
 
-`libretto` Source Example
+### `libretto` Source Example
 ```
 - TalkMessageId: 752 #Id to update.
   Unknown: 3 #Unknown to update.
@@ -697,12 +741,12 @@ Sora:
     - Unknown1: 0x00010001
       TextId: 0x183C
 ```
-`localset` Source Example
+### `localset` Source Example
 ```
 - ProgramId: 999
   MapNumber: 25
 ```
-`soundinfo` Source Example
+### `soundinfo` Source Example
 ```
 - Index: 0			#Specify an index to modify; otherwise if the index doesn't exist it will be created.
   Reverb: -1
@@ -717,13 +761,13 @@ Sora:
   FootstepWORLDFRIEND: 99
   FootstepOTHER: 99
 ```
-`place` Source Example
+### `place` Source Example
 ```
 - Index: 0			#Index should match the ID of the room in the world; i.e, Index 0 = al00 if you were modifying Agrabah.
   MessageId: 1234
   Padding: 0
 ```
-`jigsaw` Source Example
+### `jigsaw` Source Example
 ```
 - Picture: 2
   Part: 4
@@ -756,7 +800,7 @@ Asset Example
         type: recipe
 ```
 
-`recipe` Source Example
+### `recipe` Source Example
 ```
 - Id: 1
   Unlock: 0
@@ -777,7 +821,7 @@ Asset Example
   Ingredient6Amount: 6
 ```
 
-`level` Source Example
+### `level` Source Example
 ```
 - Title: 48338 #TextID to use for Moogle Level "Title", pulls from Sys.Bar.
   Stat: 48740
@@ -786,7 +830,7 @@ Asset Example
   Exp: 0
 ```
 
-`condition` Source Example
+### `condition` Source Example
 ```
 - TextId: 151
   RewardId: 0