Merge 27aa7a0 into 1745a6d

OpenKH · Jul 13, 2024 · 9fa8e88 · 9fa8e88
2 parents 1745a6d + 27aa7a0
commit 9fa8e88
Show file tree

Hide file tree

Showing 24 changed files with 543 additions and 57 deletions.
diff --git a/docs/bbs/dictionary/NumberingSchemeAnimations.md b/docs/bbs/dictionary/NumberingSchemeAnimations.md
@@ -0,0 +1,35 @@
+# Numbering Scheme for Animations
+
+## Bosses
+
+| Anim Number | Descripton
+--- | ---
+010 | Idle
+011 | Idle (Variation 1)
+030 | Walking (Forward)
+031 | Walking (Backwards)
+032 | Walking (Left)
+033 | Walking (Right)
+040 | Running (Forward)
+041 | Running (Backwards)
+042 | Running (Left)
+043 | Running (Right)
+051 | Jump Fall
+052 | Landing
+200 | Damage 1 (Ground)
+201 | Damage 2 (Ground)
+202 | Damage 3 (Ground)
+220 | Damage 1 (Air)
+221 | Damage 2 (Air)
+222 | Damage 3 (Air)
+230 | Stun Ailment
+231 | Stun Ailment (Exit)
+300 | Attack (Ground 1)
+
+## Playable characters
+
+| Anim Number | Descripton
+--- | ---
+|
+
+## Non-Playable Characters
diff --git a/docs/bbs/dictionary/worlds.md b/docs/bbs/dictionary/worlds.md
@@ -410,7 +410,7 @@ Maps with 00 in the name do not exist as files, but the game displays the world'
 |  JF02   | ジャンフェス(cd09) | Jump Festa (cd09)  |             |
 |  JF03   | ジャンフェス(sb10) | Jump Festa (sb10  |             |
 |  JF10   | シンデレラ城下町 | The Town  |             |
-|  JF11   | ポリゴンぶんかつけんしょ | Poly. Partition Test  |             |
+|  JF11   | ポリゴンぶんかつけんしょ | Polygon Partition Test  |             |
 |  JF20   | ノートルダム（そと） |   | Notredame (Exterior)            | Text only present in HD ReMiX
 |  JF21   | ノートルダム（なか） |   | Notredame (Interior)            | Text only present in HD ReMiX
 |  JF70   | tt27 | tt27  |             |

diff --git a/docs/bbs/file/type/CommandData.md → docs/bbs/executable/CommandData.md b/docs/bbs/file/type/CommandData.md → docs/bbs/executable/CommandData.md
diff --git a/docs/bbs/file/type/CommandParam.md → docs/bbs/executable/CommandParam.md b/docs/bbs/file/type/CommandParam.md → docs/bbs/executable/CommandParam.md
@@ -10,7 +10,7 @@ This data is located with the game's executable.
 |--------|-------|------------
 | 0x0     | int16  | Buy Price
 | 0x2     | uint8  | Sell Price
-| 0x3     | uint8  | Reload Time (seconds) / Amount uses for Items
+| 0x3     | uint8  | Reload Time (seconds) / Amount uses for Items / Maximum level for Abilities
 | 0x4     | uint8  | Gauge Fill (out of 100)
 | 0x5     | uint8  | Maximum Level
 | 0x6     | int16  | CP for Base Level

diff --git a/docs/bbs/file/type/PlayerData.md → docs/bbs/executable/PlayerLevelUpData.md b/docs/bbs/file/type/PlayerData.md → docs/bbs/executable/PlayerLevelUpData.md
@@ -1,6 +1,6 @@
-# PLAYER DATA
+# PLAYER LEVEL UP DATA
 
-This isn't a file, but a memory region in the executable.
+This isn't a file, but data specification that appears instantiated in memory.
 
 ## Stats
 
@@ -20,5 +20,3 @@ Level up Rewards consist of a triplet of uint32, one for each character in this
 | 0x1    | uint8 | Magic Increase
 | 0x2    | uint8 | Defense Increase
 | 0x3    | uint8 | Padding
-
-0x5B 0x74
diff --git a/docs/bbs/file/type/Weapon.md → docs/bbs/executable/Weapon.md b/docs/bbs/file/type/Weapon.md → docs/bbs/executable/Weapon.md
diff --git a/docs/bbs/file/type/CmdCharge.md b/docs/bbs/file/type/CmdCharge.md
@@ -4,7 +4,7 @@ CmdCharge stands for *Command Charge*.
 
 This file stores the list for all commands melds.
 
-The reason why it's called **CHARGE** is because that's how command melding is named in japanese.
+The reason why it's called **CHARGE** is because that's how command melding is named in japanese, Command Charge.
 
 This file is contained within `Menu/Camp.arc`
 

diff --git a/docs/bbs/file/type/bic.md b/docs/bbs/file/type/bic.md
@@ -4,9 +4,20 @@ BIC stands for *BGM Ice Collection* and it contains the list of songs used in th
 
 This file is a `.bic`, but contained in a `.bin`
 
+# Header
 
-## Header
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0     | uint32   | Version, always `0x41264126`
+| 0x4     | int32    | File Size
+| 0x8     | int32    | Item Count
+| 0xC     | uint32   | Dummy
+
+## BGM Data
 
 | Offset | Type  | Description
 |--------|-------|------------
-| 0x0     | char[4]   | 
+| 0x0    | int32  | BGM Resource Number
+| 0x4    | int32  | Tempo
+| 0x8    | int32  | Loop Start
+| 0xC    | int32  | Loop End
diff --git a/docs/bbs/file/type/cic.md b/docs/bbs/file/type/cic.md
@@ -0,0 +1,27 @@
+# CIC Format
+
+CIC stands for *Common Ice ?* and it controls several aspects of the ice cream minigame.
+
+# Data
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0     | uint32   | File identifier, always `0x41261002`
+| 0x4     | uint32   | Size
+| 0x8     | int32    | Base Points
+| 0xC     | float    | Stage Level 0
+| 0x10    | float    | Stage Level 1
+| 0x14    | float    | Stage Level 2
+| 0x18    | int32    | Stage Combo 0
+| 0x1C    | int32    | Stage Combo 1
+| 0x20    | int32    | Stage Combo 2
+| 0x24    | float    | Bad Timing
+| 0x28    | float    | Good Timing
+| 0x2C    | float    | Excellent Timing
+| 0x30    | int32    | Art 1
+| 0x34    | int32    | Art 2
+| 0x38    | int32    | Art 3
+| 0x3C    | int32    | Art 4
+| 0x40    | int32    | Ice Bonus
+| 0x44    | int32    | Ice Failure
+| 0x48    | int32    | Combo Points
diff --git a/docs/bbs/file/type/cmdShop.md b/docs/bbs/file/type/cmdShop.md
@@ -28,5 +28,5 @@ This data chunk repeats as many times as the field `Number of Items` specifies.
 
 | Offset | Type  | Description
 |--------|-------|------------
-| 0x0     | uint16   | Item Index
+| 0x0     | uint16   | Command Index
 | 0x2     | uint16   | Padding
diff --git a/docs/bbs/file/type/edp.md b/docs/bbs/file/type/edp.md
@@ -0,0 +1,64 @@
+# EDP Format
+
+EDP stands for *Experience Data Parameters* and it controls all of the changes made when enabling EXP 0 in game.
+
+# Header
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0     | string   | File identifier, always `@EDP`
+| 0x4     | uint32   | Version, `2`
+| 0x8     | uint32   | Enemy Data Count
+| 0xC     | uint32   | Boss Data Count
+
+# Attack Type Elemental
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0   | [AttackElement[152]](#attack-element) | List of attack elements.
+
+## Attack Element
+
+| Bit | Count | Description 
+|-----|-------|-------------
+|  0 | 4 | [Element 1](#attack-type)
+|  4 | 4 | [Element 2](#attack-type)
+
+## Attack Type
+
+| Value  | Name  | Description
+|--------|-------|------------
+| 0x0    | ATK_TYPE_LOW  | 
+| 0x1    | ATK_TYPE_MIDDLE  | 
+| 0x2    | ATK_TYPE_HIGH  | 
+| 0x3    | ATK_TYPE_MAX  | 
+
+
+# Cause Damage Pack Header
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0    | char[4]  | Code, always `@CDP`
+| 0x4    | uint8  | ID
+| 0x5    | uint8  | UseBoss
+| 0x6    | uint8[2]  | RESERVED
+| 0x8    | [HPRange](#cause-damage-pack-hp-range)  | HP Range
+| 0x10   | [ScalePack[3]](#cause-damage-pack-scale-pack)  | Damage Scaling
+
+
+# Cause Damage Pack HP Range
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0    | int32    | Minimum
+| 0x4    | int32    | Maximum
+
+# Cause Damage Pack Scale Pack
+
+This structures repeats for as many animations need their parameters set.
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0     | int32  | Divisor
+| 0x4     | int32  | Revision
+| 0x8     | int32  | Scale
diff --git a/docs/bbs/file/type/ice.md b/docs/bbs/file/type/ice.md
@@ -0,0 +1,21 @@
+# ICE Format
+
+ICE stands for *ICE-CREAM* and it controls how an ice cream minigame plays out.
+
+# Header
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0     | uint32   | Version, always `0x41264129`
+| 0x4     | int32    | File Size
+| 0x8     | int32    | Item Count
+| 0xC     | uint32   | Dummy
+
+# Measure
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0     | int32      | Kind
+| 0x4     | uint32[3]  | Marks
+| 0x10    | uint32     | Sound Color
+| 0x14    | uint32     | Combo
diff --git a/docs/bbs/file/type/itb.md b/docs/bbs/file/type/itb.md
@@ -30,17 +30,23 @@ This file can be found in the `item` folder or within `arc/system/common_xx.arc`
 | 0x1A    | uint8   | Item Count in `BD`
 | 0x1B    | uint8   | Item Count in `WM`
 
-## ITC Data
+## ITB Data
 
 | Offset | Type  | Description
 |--------|-------|------------
 | 0x0     | uint16   | Treasure Box ID
-| 0x2     | uint16   | Item ID
-| 0x4     | uint8   | [Item Kind](#Item-Kind)
+| 0x2     | uint16   | Reward ID
+| 0x4     | uint8   | [Reward Kind](#Reward-Kind)
 | 0x5     | uint8   | World ID
 | 0x6     | uint8   | Report ID
 | 0x7     | uint8   | Padding
 
+## Reward Kind
+| Value | Name  | Description
+|--------|-------|------------
+| 0     | COMMAND   | 
+| 1     | ITEM   | 
+
 ## Item Kind
 
 | Value | Name  | Description

diff --git a/docs/bbs/file/type/mbd.md b/docs/bbs/file/type/mbd.md
@@ -0,0 +1,53 @@
+# MBD Format
+
+MBD stands for *Mirage Bonus Data* and it contains the list rewards you can get from completing Mirage Arena challenges.
+
+
+# Header
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0     | char[4]   | Code, always `@MBD`
+| 0x4     | uint32    | Version, always `1`
+| 0x8     | uint32[2]    | RESERVED
+
+# Bonus Data
+
+| Offset | Type  | Description
+|--------|-------|------------
+| 0x0    | [BattleType](#battle-type)    | 
+| 0x4    | [ChallengeType](#challenge-type) | 
+| 0x8    | uint32            | Requirement value
+| 0xC    | uint32            | Reward multiplier (for medals)
+
+## Battle Type
+
+| Value | Name  | Description
+|--------|-------|------------
+| 0x0    | BATTLE_TYPE_JUDGE   | Day of Reckoning
+| 0x1    | BATTLE_TYPE_CURSE   | Wheels of Misfortune
+| 0x2    | BATTLE_TYPE_TREASURE   | Risky Riches
+| 0x3    | BATTLE_TYPE_RUN   | Weaver Fever
+| 0x4    | BATTLE_TYPE_PRISON   | Sinister Sentinel
+| 0x5    | BATTLE_TYPE_DAZZLE   | Dead Ringer
+| 0x6    | BATTLE_TYPE_TYRANT   | Combined Threat
+| 0x7    | BATTLE_TYPE_DESIRE   | Treasure Tussle
+| 0x8    | BATTLE_TYPE_CRIME   | Harsh Punishment
+| 0x9    | BATTLE_TYPE_BLIZZARD   | A Time to Chill
+| 0xA    | BATTLE_TYPE_MAGICIAN   | Copycat Crisis
+| 0xB    | BATTLE_TYPE_ARENA_OWNER   | Keepers of the Arena
+| 0xC    | BATTLE_TYPE_WHALE   | Monster of the Sea
+| 0xD    | BATTLE_TYPE_CONQUEROR   | Villains' Vendetta
+| 0xE    | BATTLE_TYPE_LIGHT_MASTER   | Light's Lessions
+| 0xF    | BATTLE_TYPE_DARKNESS   | Peering into Darkness
+| 0x10   | BATTLE_TYPE_END   | 
+
+## Challenge Type
+
+| Value | Name  | Description
+|--------|-------|------------
+| 0x0    | CHALLENGE_TYPE_CURE   | Heal X times or less.
+| 0x1    | CHALLENGE_TYPE_TIME_ATTACK   | Within time limit. (Time in seconds)
+| 0x2    | CHALLENGE_TYPE_GET_MUNNY   | Obtain X amount of munny.
+| 0x3    | CHALLENGE_TYPE_CHANGE_STYLE   | Perform X amount of style changes.
+| 0x4    | CHALLENGE_TYPE_SUCCESS_GUARD   | Block X amount of times.
diff --git a/docs/bbs/file/type/mission.md b/docs/bbs/file/type/mission.md
@@ -50,7 +50,7 @@ Here's the full list of files that use this format.
 | 0x4C    | uint8   | Navigation
 | 0x4D    | uint8   | Present 1
 | 0x4E    | uint8   | Present 2
-| 0x4F    | uint8   | General Path
+| 0x4F    | uint8   | [General Path](#General-Path)
 | 0x50    | uint16  | Present 1 Parameters
 | 0x52    | uint16  | Present 2 Parameters
 | 0x54    | uint8   | HP Recovery
@@ -60,7 +60,13 @@ Here's the full list of files that use this format.
 
 ### Bonus
 
-The type of bonus to receive. It is not possible to give two rewards of the same type.
+Bonuses are rewards you receive as the boss is defeated or the event is over.
+
+The type of bonus to receive.
+
+Bonuses cannot give you **debug commands or abilities/enchantments/d-links**. Any command style can be given at any time.
+
+**It is not possible to give two rewards of the same type.**
 
 | Value | Description
 |--------|-------
@@ -71,16 +77,34 @@ The type of bonus to receive. It is not possible to give two rewards of the same
 
 ### Present
 
-The type of present to receive. Presents cannot give you debug commands or abilities/enchantments.
+Presents are rewards you receive after the battle phase is over.
+
+This field controls the type of present to receive.
+
+Presents cannot give you **debug commands or abilities/enchantments**. Giving command styles out of order can also result in a crash.
+
+Trying to give items that don't belong to the specific character result in a crash.
+
+**It is possible to get two presents of the same type.**
 
 | Value | Description
 |--------|-------
 | 0     | None
 | 1     | Obtain Item
 | 2     | Obtain Command
 
+### General Path
+
+| Value | Description
+|--------|-------
+| 0     | GENERAL_PATH_START
+| 1     | GENERAL_PATH_END
+
+
 ### Mission Kind
 
+This is the "name" attributed to the mission. Serves as an identifier.
+
 | Value | Name  | Description
 |--------|-------|------------
 | -1    | MISSION_NONE   | 

diff --git a/docs/bbs/file/type/olo.md b/docs/bbs/file/type/olo.md
@@ -12,9 +12,9 @@ This file controls what objects and how they're spawned in levels within [Kingdo
 | 0x8     | uint32     | Number of Objects to spawn.
 | 0xC     | uint32     | Offset to the [Object Name](###Object-Name) section.
 | 0x10    | uint32     | Number of file path addresses.
-| 0x14    | uint32     | Offset to a list of [Path Name](###Path-Name) for **files**.
+| 0x14    | uint32     | Offset to a list of [Path Name](###Path-Name) for **Files**.
 | 0x18    | uint32     | Number of Script name
-| 0x1C    | uint32     | Offset to a list of [Path Name](###Path-Name) for **Scripts**.32
+| 0x1C    | uint32     | Offset to a list of [Path Name](###Path-Name) for **Scripts**.
 | 0x20    | uint32     | Number of Mission labels.
 | 0x24    | uint32     | Offset to the [Mission Name](###Mission-Name) definitions.
 | 0x28    | uint32     | Number of Triggers.