OpenKh

https://openkh.dev
Admin
OpenKh is a centralized documentation repository for discoveries about the internal workings of...
Tokens:109,381
Snippets:1,342
Trust Score:6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Complete Mod.yml Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

A comprehensive example of a mod.yml file, demonstrating asset inclusion and multi-language support.

```yaml
title: OpenKH mod template
originalAuthor: OpenKH open-source assets
description: An example of mod to use as a template
assets:
  - name: menu/us/title.2ld
    multi:
      - name: menu/jp/title.2ld
      - name: menu/uk/title.2ld
      - name: menu/it/title.2ld
      - name: menu/sp/title.2ld
      - name: menu/gr/title.2ld
      - name: menu/fr/title.2ld
      - name: menu/fm/title.2ld
    required: true
    method: binarc
    source:
      - name: titl
        type: imgz
        method: imgz
        source:
          - name: title/title1.png
            highdef: title/title1_hd.png
            index: 1
  - name: msg/jp/sys.bar
    method: binarc
    source:
      - name: sys
        type: list
        method: kh2msg
        source:
          - name: sys.yml
            language: jp
  - name: msg/us/sys.bar
    method: binarc
    source:
      - name: sys
        type: list
        method: kh2msg
        source:
          - name: sys.yml
            language: en
  - name: msg/it/sys.bar
    method: binarc
    source:
      - name: sys
        type: list
        method: kh2msg
        source:
          - name: sys.yml
            language: it

```

--------------------------------

### listpatch SHOP Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Example of a SHOP list binary patch file. Defines shop entry helpers, inventory entry helpers, product entry helpers, and valid product entry helpers.

```yaml
ShopEntryHelpers:
- CommandArgument: 104
  UnlockMenuFlag: 42
  NameID: 35513
  ShopKeeperEntityID: 1865
  PosX: 134
  PosY: 150
  PosZ: -591
  ExtraInventoryBitMask: 130
  SoundID: 1
  InventoryCount: 1
  ShopID: 0
  Unk19: 2
  InventoryStartIndex: 0
InventoryEntryHelpers:
- InventoryIndex: 0
  UnlockEventID: 65535
  ProductCount: 2
  ProductStartIndex: 0
ProductEntryHelpers:
- ProductIndex: 0
  ItemID: 67
- ProductIndex: 1
  ItemID: 296
ValidProductEntryHelpers:
- ProductIndex: 0
  ItemID: 67
- ProductIndex: 1
  ItemID: 296
```

--------------------------------

### listpatch CMD Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Example of a CMD (Command) list binary patch file. Defines various properties for a command, including ID, execution type, arguments, and flags.

```yaml
- Id: 1
  Execute: 3
  Argument: 3
  SubMenu: 1
  CmdIcon: 3
  MessageId: 33249
  Flags: Cursor, InBattleOnly
  Range: -1
  Dir: 0
  DirRange: -1
  Cost: 0
  CmdCamera: 0
  Priority: 100
  CmdReceiver: 0
  Time: 0
  Require: 0
  Mark: 1
  CmdAction: 0
  ReactionCount: 0
  DistRange: 0
  Score: 0
  DisableForm: 63552
  Group: 2
  Reserve: 0
```

--------------------------------

### listpatch ITEM Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Example of an ITEM list binary patch file. Includes sections for item stats and item definitions, such as type, rank, shop prices, and commands.

```yaml
Stats:
- Ability: 412
  AbilityPoints: 0
  Attack: 0
  DarkResistance: 100
  Defense: 0
  FireResistance: 100
  GeneralResistance: 100
  IceResistance: 100
  Id: 116
  LightningResistance: 100
  Magic: 7
  Unknown: 0
  Unknown08: 100
  Unknown0d: 100
Items:
- Id: 1
  Type: Consumable
  Flag0: 0
  Flag1: 40
  Rank: C
  StatEntry: 1
  Name: 33528
  Description: 33529
  ShopBuy: 40
  ShopSell: 10
  Command: 23
  Slot: 0
  Picture: 1
  Icon1: 9
  Icon2: 0
  InsertBefore: 7 #This will insert the item ID before the item ID you specify here. Defaults to 0, which will append to the item list instead. You can alternatively use InsertAfter.
```

--------------------------------

### Asset Modification Example (synthpatch)

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Example of modifying assets using the 'synthpatch' method, specifically for KH2 Mixdata.bar.

```yaml
- name: menu/us/mixdata.bar
  method: binarc
  source:
  - name: reci
    method: synthpatch
    type: Synthesis
    source:
      - name: ReciList.yml
        type: recipe

```

--------------------------------

### areadatascript Text Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Defines program modifications for KH2 spawnscripts in a text format. This example shows settings for Program 0x7C, including party, background music, and area settings.

```plaintext
Program 0x7C
Party DEFAULT
Bgm Default Default
AreaSettings 0 -1
	SetJump Type 2 World HB Area 0 Entrance 0 LocalSet 151 FadeType 1
	SetPartyMenu 0
```

--------------------------------

### recipe Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Defines a 'recipe' for synthesis, including item IDs, amounts, and upgrade paths.

```yaml
- Id: 1
  Unlock: 0
  Rank: 5
  Item: 100
  UpgradedItem: 101
  Ingredient1: 200
  Ingredient1Amount: 1
  Ingredient2: 201
  Ingredient2Amount: 2
  Ingredient3: 202
  Ingredient3Amount: 3
  Ingredient4: 203
  Ingredient4Amount: 4
  Ingredient5: 204
  Ingredient5Amount: 5
  Ingredient6: 205
  Ingredient6Amount: 6

```

--------------------------------

### listpatch SKLT Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Example of a SKLT (Skeleton) list binary patch file. Specifies bone IDs for a character.

```yaml
- CharacterId: 1
  Bone1: 178
  Bone2: 86
```

--------------------------------

### localset Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Defines 'localset' parameters, including ProgramId and MapNumber.

```yaml
- ProgramId: 999
  MapNumber: 25

```

--------------------------------

### soundinfo Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Configuration for 'soundinfo', specifying various audio parameters like Reverb and WAV files.

```yaml
- Index: 0	#Specify an index to modify; otherwise if the index doesn't exist it will be created.
  Reverb: -1
  Rate: 1
  EnvironmentWAV: 99
  EnvironmentSEB: 99
  EnvironmentNUMBER: 99
  FootstepWAV: 99
  FootstepSORA: 99
  FootstepDONALD: 99
  FootstepGOOFY: 99
  FootstepWORLDFRIEND: 99
  FootstepOTHER: 99

```

--------------------------------

### place Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Defines 'place' data, linking an Index to a MessageId and padding.

```yaml
- 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

```

--------------------------------

### TEXA Metadata Placement Example

Source: https://openkh.dev/kh2/file/raw-texture.html

Visual representation of how TEXA metadata is placed within a file structure.

```text
14:93C0h: 5F 44 4D 59 00 00 00 00 54 45 58 41 50 12 00 00  _DMY....TEXAP... 
14:93D0h: <--   TEXA header                              
14:93E0h:                                                
14:93F0h:                     --> <--   Slot table       
...
14:95F0h:                     --> <--   A --> <--   F      // A is anim table (4 bytes)
14:9600h:                                                  // F is frame table (30 bytes)
14:9610h:         --> 00 00 00 00 00 00 00 00 00 00 00 00
14:9620h: <--   Sprite image data                        
...
14:A610h:                                             -->
14:A620h: 5F 44 4D 59 00 00 00 00 54 45 58 41 50 12 00 00  _DMY....TEXAP... 
```

--------------------------------

### btlv Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Represents the 'btlv' data structure, likely related to world progression or flags.

```yaml
- Id: 0
  ProgressFlag: 0x1099
  WorldZZ: 1
  WorldOfDarkness: 1
  TwilightTown: 1
  DestinyIslands: 1
  HollowBastion: 1
  BeastCastle: 1
  OlympusColiseum: 1
  Agrabah: 1
  LandOfDragons: 1
  HundredAcreWoods: 1
  PrideLands: 1
  Atlantica: 1
  DisneyCastle: 1
  TimelessRiver: 1
  HalloweenTown: 1
  PortRoyal: 1
  SpaceParanoids: 1
  TheWorldThatNeverWas: 1
  Padding: []

```

--------------------------------

### listpatch ARIF Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Example of an ARIF (Area Information) list binary patch file. Defines area properties such as flags, reverb, sound effects, BGM, voice, navigation map item, command, and reserved fields.

```yaml
End of Sea: #End of Sea. Names are taken from worlds.md
  2:
    Flags: IsKnownArea, IndoorArea, Monochrome #Other acceptable flags are NoShadow and HasGlow.
    Reverb: 10
    SoundEffectBank1: 20
    SoundEffectBank2: 30
    Bgms:
      - BgmField: 2000
        BgmBattle: 2000
      - BgmField: 600
        BgmBattle: 600
      - BgmField: 1200
        BgmBattle: 1200
      - BgmField: 1200
        BgmBattle: 1200
      - BgmField: 1000
        BgmBattle: 1000
      - BgmField: 1000
        BgmBattle: 1000
      - BgmField: 1500
        BgmBattle: 1500
      - BgmField: 1500
        BgmBattle: 1500
    Voice: 40
    NavigationMapItem: 50
    Command: 60
    Reserved: []
```

--------------------------------

### Disable First Start Tutorial (SQL)

Source: https://openkh.dev/mom/database.html

Use this SQL query to modify the GameSceneFlowTable to bypass the initial tutorial and proceed directly to the main menu.

```sql
UPDATE GameSceneFlowTable
SET NextGameSceneID = 10000034
WHERE GameSceneID=10000005 AND NextGameSceneID=10000077;
```

--------------------------------

### Example Mod File Structure

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

A representation of the required folder structure for a mod, mirroring the game's internal file paths.

```text
├───menu
│   └───us
│       └───title.2ld
│
└───remastered
 └───msg
 │   └───us
 │       └───fontimage.bar
 └───obj
     └───P_EX100.a.us
         └─── ~8.dds
```

--------------------------------

### GET /Game/Character/obj

Source: https://openkh.dev/kh3/pawns.html

Retrieves a list of all available objects and their descriptions.

```APIDOC
## GET /Game/Character/obj

### Description
Retrieves a list of all available objects and their descriptions.

### Method
GET

### Endpoint
/Game/Character/obj

### Parameters
This endpoint does not accept any parameters.

### Response
#### Success Response (200)
- **objects** (array) - A list of object details.
  - **id** (string) - The unique identifier for the object.
  - **description** (string) - A description of the object.

#### Response Example
```json
{
  "objects": [
    {
      "id": "o_at001",
      "description": "?"
    },
    {
      "id": "o_bx202",
      "description": "Baymax chip (Tadashi)"
    }
  ]
}
```
```

--------------------------------

### GET /commands

Source: https://openkh.dev/ddd/dictionary/items

Retrieves the list of available commands and their corresponding IDs.

```APIDOC
## GET /commands

### Description
Returns a list of all command IDs and their associated descriptions, including action, combat, item, and spirit commands.

### Method
GET

### Endpoint
/commands

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the command.
- **description** (string) - The name or description of the command.

#### Response Example
[
  {"id": 1, "description": "Jump"},
  {"id": 2, "description": "High Jump"},
  {"id": 119, "description": "Potion"}
]
```

--------------------------------

### libretto Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Configuration for 'libretto' messages, including text IDs and types.

```yaml
- TalkMessageId: 752 #Id to update. This is used as "ReactionCommand" in ARDs.
  Type: 3 #Specify the type of Message. 1, 2, and 3 seem functionally identical, while 0 does nothing.
  Contents: #Contents to update. Will insert additional Contents as necessary. When no additional are detected, terminates with 0.
    - CodeType: 0x0001 #CodeType. Most worlds use a value of 1, while the World Map uses 0x100 to 0x113.
      Unknown: 0x0001 #Unknown what this is used for. 
      TextId: 0x3DEB #TextID in that worlds .bar file in the msg folder to reference.
    - CodeType: 0x0001
      Unknown: 0x0001
      TextId: 0x183C

```

--------------------------------

### jigsaw Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Structure for 'jigsaw' puzzle data, including picture, part, text, world, and room information.

```yaml
- Picture: 2
  Part: 4
  Text: 1500
  World: 2
  Room: 1
  JigsawIdWorld: 99
  Unk07: 0
  Unk08: 0

```

--------------------------------

### MapGen Debug Output Example

Source: https://openkh.dev/tool/CLI.AnbMaker

This output shows the detailed steps MapGen takes during the conversion process, including model loading, mesh processing, material handling, and file writing.

```text
DEBUG ymlFile is "H:\\Proj\\khkh_xldM\\newMap\\terrain\\mapdef.yml"
DEBUG baseDir is "H:\\Proj\\khkh_xldM\\newMap\\terrain"
DEBUG Loading 3D model file "H:\\Proj\\khkh_xldM\\newMap\\terrain\\terrain.fbx" using Assimp.
DEBUG Starting triangle strip conversion for 1 meshes.
DEBUG Mesh: Plane (256 faces, 1,024 vertices)
DEBUG Output: 289 vertices, 36 triangle strips.
DEBUG The conversion has done.
DEBUG Starting mesh splitter and vif packets builder.
DEBUG Output: 10 vif packets.
DEBUG The builder has done.
DEBUG Starting vifPacketRenderingGroup builder.
DEBUG Output: 1 groups.
DEBUG Going to load material "geo".
DEBUG Load image from "H:\\Proj\\khkh_xldM\\newMap\\terrain\\images\\geo.imd"
DEBUG Building map file structure.
DEBUG Writing to "H:\\Proj\\khkh_xldM\\newMap\\terrain\\terrain.map".
DEBUG Done
```

--------------------------------

### objentry Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Defines the 'objentry' data structure, likely for game objects or entities.

```yaml
4:
  ObjectId: 4
  ObjectType: ZAKO
  SubType: 0
  DrawPriority: 0
  WeaponJoint: 0
  ModelName: M_EX520
  AnimationName: M_EX520.mset
  Flag: 8
  TargetType: 1
  Padding: 0
  NeoStatus: 1006
  NeoMoveset: 0
  Weight: 100
  SpawnLimiter: 8
  Page: 1
  ShadowSize: 1
  CommandMenuOption: Default
  SpawnObject1: 0
  SpawnObject2: 0
  SpawnObject3: 0
  SpawnObject4: 0

```

--------------------------------

### Configure MapVisibility Bitmasks

Source: https://openkh.dev/kh2/file/type/areadata.html

Examples of setting the 64-bit mask to toggle map meshes and collisions based on group values.

```text
MapVisibility 0x00000001 0x00000000
```

```text
MapVisibility 0x00000003 0x00000000
```

--------------------------------

### VIF Packet Assembly Example

Source: https://openkh.dev/kh2/file/type/mdlx.html

A sample VIF packet structure demonstrating model headers, UV definitions, vertex indices, flags, and vertex definitions. This code is intended for assembly with the dsp-as tool.

```Assembly
.align 0
;test.dae_mp1_pkt1.obj
;Automatically generated by kh2vif
;DO NOT EDIT IF YOU DON'T KNOW WHAT YOU ARE DOING

stcycl 01, 01; We write code to memory without skips/overwrite

unpack[r] V4_32, 0, * ;Model Part Header
.int 1, 0, 0, 0 ;type 1 Model
.int 36, 4, 54, 56; Number of u+v+flag+index, their offset, offset of vertex affiliation header, offset of mat definition(end)
.int 0, 0, 0, 0; Nobody care about vertices merging and colors
.int 14, 40, 0, 5; Number of vertices, their offset, reserved and number of array attribution
.EndUnpack

stcycl 01, 01; We write code to memory without skips/overwrite

unpack[r] V2_16, 4, *; UV definition
.short 2048, 0
.short 1024, 1024
.short 1024, 0
.short 1024, 3071
.short 2048, 2048
.short 2048, 3071
.short 3071, 2048
.short 2048, 1024
.short 3071, 1024
.short 2048, 2048
.short 1024, 1024
.short 2048, 1024
.short 1024, 1024
.short 0, 2048
.short 0, 1024
.short 2048, 4095
.short 1024, 3071
.short 2048, 3071
.short 2048, 0
.short 2048, 1024
.short 1024, 1024
.short 1024, 3071
.short 1024, 2048
.short 2048, 2048
.short 3071, 2048
.short 2048, 2048
.short 2048, 1024
.short 2048, 2048
.short 1024, 2048
.short 1024, 1024
.short 1024, 1024
.short 1024, 2048
.short 0, 2048
.short 2048, 4095
.short 1024, 4095
.short 1024, 3071
.EndUnpack

stmask 0xcfcfcfcf; Sets mask register(3303, check EEUSER_E)
stcycl 01, 01; We write code to memory without skips/overwrite

unpack[mru] S_8, 4, *; Vertex indices
.byte 0
.byte 1
.byte 2
.byte 9
.byte 8
.byte 11
.byte 12
.byte 3
.byte 4
.byte 8
.byte 1
.byte 3
.byte 1
.byte 10
.byte 5
.byte 6
.byte 9
.byte 11
.byte 0
.byte 3
.byte 1
.byte 9
.byte 13
.byte 8
.byte 12
.byte 8
.byte 3
.byte 8
.byte 13
.byte 1
.byte 1
.byte 13
.byte 10
.byte 6
.byte 7
.byte 9
.EndUnpack

stmask 0x3f3f3f3f; Sets mask register(3330, check EEUSER_E)
stcycl 01, 01; We write code to memory without skips/overwrite

unpack[mru] S_8, 4, *; Flags
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.byte 0x10; stock
.byte 0x10; stock
.byte 0x20; draw triangle
.EndUnpack

stcol 0x3f800000, 0x3f800000, 0x3f800000, 0x3f800000; We set garbage data to 1(float) so even if nothing is referenced game doesn't go crazy
stmask 0x80808080; Sets mask register(0002, check EEUSER_E)
stcycl 01, 01; We write code to memory without skips/overwrite

unpack[mr] V3_32, 40, *; Vertex definition
.float 1.000000, 1.000000, 0.000000
.float -1.000000, -1.000000, 0.000000
.float -1.000000, 1.000000, 0.000000
.float 1.000000, -1.000000, 0.000000
.float 1.000000, 1.000000, 0.000000
.float -1.000000, 1.000000, 0.000000
.float 1.000000, 1.000000, 0.000000
.float -1.000000, 1.000000, 0.000000
.float 0.999999, -1.000001, 2.000000
.float -1.000000, 1.000000, 2.000000
.float -1.000000, 1.000000, 2.000000
.float 1.000000, 1.000000, 2.000000
.float 1.000000, 1.000000, 2.000000
.float -1.000000, -1.000000, 2.000000
.EndUnpack

stcycl 01, 01; We write code to memory without skips/overwrite

unpack[r] V4_32, 54 ,*; Vertex affiliation header
.int 8, 1, 2, 2
.int 1, 0, 0, 0
.EndUnpack
vifnop
vifnop; We wait for data to be kicked in
```

--------------------------------

### kh2msg YAML Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Provides text replacements for KH2 messages using a YAML file. Each entry maps an ID to translated text for different languages.

```yaml
- id: 0x432e
  en: OpenKH is awesome!
  it: OpenKH è incredibile!
  sp: ¡OpenKH es increíble!
  gr: OpenKH ist großartig!
  fr: OpenKH est incroyable!
  jp: OPENKHすばらしい!
```

--------------------------------

### level Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Defines 'level' parameters for Moogle levels, including title text ID, stat, and experience.

```yaml
- Title: 48338 #TextID to use for Moogle Level "Title", pulls from Sys.Bar.
  Stat: 48740
  Enable: -1
  Padding: 0
  Exp: 0

```

--------------------------------

### Convert FBX to Map File

Source: https://openkh.dev/tool/CLI.AnbMaker

Example command to convert a terrain.fbx model file into a .map file. The tool will automatically generate a mapdef.yml if one does not exist.

```bash
OpenKh.Command.MapGen.exe terrain.fbx
```

--------------------------------

### listpatch Asset Configuration for Fmlv and Atkp

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Configure the `listpatch` tool to modify KH2 list binaries. This example shows patching FmlvList.yml and AtkpList.yml within a 00battle.bin asset.

```yaml
- name: 00battle.bin
  method: binarc
  source:
  - name: fmlv
    method: listpatch
    type: List
    source:
      - name: FmlvList.yml
        type: fmlv
  - name: atkp
    method: listpatch
    type: List
    source:
      - name: AtkpList.yml
        type: atkp
```

--------------------------------

### MapDef.yml Material Definition Example

Source: https://openkh.dev/tool/CLI.AnbMaker

Defines supplemental information for materials in the 3D model. It uses pattern matching to apply settings, with the first match taking precedence.

```yaml
# Declare supplemental info per material of any associated meshes in 3D model data
materials:
# Pattern matching to hit a material. It ignores case.
# Accept like: `*clip`, `*old*`, `material???`
# It respects only first matched material. If there are 2 or more hits, later ones will be ignored.
- name: '*'
  fromFile: 'floor.imd'

# This never reach.
- name: 'ceil'
  fromFile: 'ceil.imd'
```

--------------------------------

### listpatch TRSR Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Example of a TRSR (Treasure) list binary patch file. It specifies an ItemId for a given entry.

```yaml
2:
  ItemId: 347
```

--------------------------------

### bbsarc Asset Patching Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Example of using 'bbsarc' method to patch files within a BBS .arc container without copying the entire archive.

```yaml
- name: arc/map/SW10.arc
  method: bbsarc
  source:
  - name: sw_10.pvd
    method: copy
    source:
    - name: sw_10.pvd

```

--------------------------------

### Display MapGen Help Information

Source: https://openkh.dev/tool/CLI.AnbMaker

Run this command to view the usage instructions and available options for the MapGen tool.

```bash
OpenKh.Command.MapGen.exe -h
```

--------------------------------

### Run the OpenKH Game Engine

Source: https://openkh.dev/engine

Commands to launch the engine on different operating systems.

```shell
OpenKh.Game.exe
```

```shell
dotnet OpenKh.Game.dll
```

--------------------------------

### Secret Node Examples

Source: https://openkh.dev/ddd/file/lboard.html

Nodes related to secret board functionality.

```hex
13 07 00 04 00 00 00 01 0A 00 00 00 00 00 00 00
52 07 00 05 00 00 00 01 0A 00 00 00 00 00 00 00
41 07 00 04 00 00 00 01 0A 00 00 00 00 00 00 00
04 17 03 00 00 00 00 01 32 00 02 06 00 00 00 00
```

--------------------------------

### GitHub Mod Repository Identifier

Source: https://openkh.dev/tool/GUI.ModsManager

The format required for installing mods directly from a GitHub repository.

```text
Truthkey/BBSUM_Mod
```

--------------------------------

### Party and Audio Settings

Source: https://openkh.dev/kh2/file/type/areadata.html

Commands for managing party composition and background music.

```APIDOC
## Party

### Description
Set how the party member needs to be structured. According to `dbg/member.bin`, those are the only allowed values as a parameter:
Value | Name | Description  
---|---|---
0 | NO_FRIEND | Allow only Sora.
1 | DEFAULT | Allow Donald and Goofy.
2 | W_FRIEND | Allow Donald, Goofy and world guest.
3 | W_FRIEND_IN | Same as `W_FRIEND` but forces the world guest to be in at the beginning.
4 | W_FRIEND_FIX | Same as `W_FRIEND_IN`, but you can not swap the world guest.
5 | W_FRIEND_ONLY | Allow only with Sora and the world guest.
6 | DONALD_ONLY | Only allow Sora and Donald.

### Method
Not specified (likely a script command)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **party_composition** (integer) - The code representing the desired party structure.

### Request Example
```
Party(2) // Allow Donald, Goofy and world guest
```

### Response
N/A

## Bgm

### Description
Set the map’s background musics. The single 4-byte parameter can be read as two 2-byte integers, which represents the field and battle music ID that can be found in `bgm/music_xxx`. They overrides the default field and battle music used in the current map.

### Method
Not specified (likely a script command)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **field_music_id** (integer) - The ID for the field background music.
- **battle_music_id** (integer) - The ID for the battle background music.

### Request Example
```
Bgm(10, 25) // Field music ID 10, Battle music ID 25
```

### Response
N/A
```

--------------------------------

### HELLO_OPT_GAME_PARAM Structure

Source: https://openkh.dev/bbs/network/NetworkDef.html

Structure for game parameters used in HELLO options.

```APIDOC
## HELLO_OPT_GAME_PARAM Structure

### Description
Contains game-specific options and parameters for connection requests.

### Fields
- **nGameMode** (byte) - Offset 0x0, Length 1
- **nEventRule** (byte) - Offset 0x1, Length 1
- **nDataMode** (byte) - Offset 0x2, Length 1
- **nTimeLimit** (byte) - Offset 0x3, Length 1
- **nMemberMax** (byte) - Offset 0x4, Length 1
- **nField** (byte) - Offset 0x5, Length 1
- **nTarget** (byte) - Offset 0x6, Length 1
- **nRank** (byte) - Offset 0x7, Length 1
```

--------------------------------

### BDD Settings and Components

Source: https://openkh.dev/bbs/file/type/bdd.html

Details the configuration settings, route, panel, and command structures within the BDD file.

```APIDOC
## BDD Settings
- **0x0** (int32) - Start BP
- **0x4** (uint8) - Padding
- **0x5** (uint8) - Max Commands
- **0x6** (uint16) - Turn Check
- **0x8-0x1C** (int32) - Padding

## BDD Route
- **0x0** (int16) - Panel IDX

## BDD Panel
- **0x0** (uint8) - Type
- **0x1** (uint8) - Area
- **0x2** (int16) - Padding
- **0x4** (uint32) - Price
- **0x8** (int16[4]) - Item
- **0x10** (uint8[4]) - Per

## BDD Commands
- **0x0** (uint16) - BDD Command Flag

### BDD Command Bitfield
- **0** (4 bits) - Level
- **4** (12 bits) - Item
```

--------------------------------

### Unknown 4 Byte Node Examples

Source: https://openkh.dev/ddd/file/lboard.html

Nodes containing nonzero values in the Unknown 4 field.

```hex
04 17 03 00 00 00 00 01 32 00 02 06 00 00 00 00
36 17 03 00 00 00 00 01 96 00 02 07 00 00 00 00
36 17 03 00 02 00 00 03 5E 01 00 02 00 00 00 00
27 17 03 00 00 00 00 02 FA 00 00 01 00 00 00 00
63 17 03 01 01 00 00 03 FA 00 06 02 00 00 00 00
```

--------------------------------

### Unknown 2 Byte Node Examples

Source: https://openkh.dev/ddd/file/lboard.html

Nodes containing nonzero values in the Unknown 2 field.

```hex
10 04 00 05 00 01 00 00 0A 00 0C 00 00 00 00 00
33 16 00 51 00 02 02 00 01 00 00 00 00 00 00 00
21 04 00 05 00 01 00 00 0A 00 01 00 00 00 00 00
23 04 00 00 00 02 00 00 96 00 00 00 00 00 00 00
33 03 00 12 00 01 00 00 64 00 0A 00 00 00 00 00
```

--------------------------------

### 12soundinfo.bar File Structure

Source: https://openkh.dev/kh2/file/type/12soundinfo.html

Documentation of the binary structure for the 12soundinfo.bar file format.

```APIDOC
## 12soundinfo.bar File Structure

### Description
This file defines environmental sound effects and footstep audio containers for maps in Kingdom Hearts II.

### Structure
- **Sound Info Entry Count** (1) - Number of entries
- **Sound Info Entries** (Count) - Array of sound info data

### Sound Info Entry Fields
- **Reverb** (uint16) - Offset 0
- **3DRate** (uint16) - Offset 2
- **WAV for Environment** (uint16) - Offset 4
- **SEB for Environment** (uint16) - Offset 6
- **NUMBER for Environment** (uint16) - Offset 8
- **SPOT for Environment** (uint16) - Offset 10
- **WAV for Footstep** (uint16) - Offset 12
- **SORA Footstep Sound Container** (uint16) - Offset 14
- **DONALD Footstep Sound Container** (uint16) - Offset 16
- **GOOFY Footstep Sound Container** (uint16) - Offset 18
- **WORLD_FRIEND Footstep Sound Container** (uint16) - Offset 20
- **OTHER Footstep Sound Container** (uint16) - Offset 22
```

--------------------------------

### condition Source Example

Source: https://openkh.dev/tool/GUI.ModsManager/creatingMods.html

Specifies 'condition' requirements for rewards or unlocks, including item collection and material types.

```yaml
- TextId: 151
  RewardId: 0
  Type: 5
  MaterialType: 100
  MaterialRank: 101
  ItemCollect: 200
  Count: 1
  ShopUnlock: 201

```

--------------------------------

### Stack Manipulation Instructions

Source: https://openkh.dev/kh2/file/ai/kh2ai.html

Instructions for managing the stack.

```APIDOC
## PUSH.CA

### Description
Pushes the last cached stack value to the stack.

### Method
PUSH.CA

### Endpoint
N/A

### Parameters
N/A

### Request Example
```json
{
  "example": "PUSH.CA"
}
```

### Response
#### Success Response (200)
N/A

#### Response Example
```json
{
  "example": "N/A"
}
```
```

```APIDOC
## PUSH.C

### Description
Pops the latest value from the stack and pushes it back twice.

### Method
PUSH.C

### Endpoint
N/A

### Parameters
N/A

### Request Example
```json
{
  "example": "PUSH.C"
}
```

### Response
#### Success Response (200)
N/A

#### Response Example
```json
{
  "example": "N/A"
}
```
```

--------------------------------

### MapDef.yml ApplyMatrix Property Example

Source: https://openkh.dev/tool/CLI.AnbMaker

Applies a transformation matrix to each input vertex position. Useful for maps exported from KH1.

```yaml
# Apply matrix for each input vertex position.
# Default is null and assume identity matrix.
applyMatrix: [
    1, 0, 0, 0, 
    0,-1, 0, 0, 
    0, 0,-1, 0, 
    0, 0, 0, 1
]

# This matrix is useful for maps exported from KH1.
```

--------------------------------

### MapDef.yml Scale Property Example

Source: https://openkh.dev/tool/CLI.AnbMaker

Applies a uniform scale to all mesh vertices. This setting is ignored if `applyMatrix` is also defined.

```yaml
# Apply xyz uniform scale to every mesh vertex. Skipped if applyMatrix exists.
scale: 1
```

--------------------------------

### Red Secret Node Examples

Source: https://openkh.dev/ddd/file/lboard.html

Nodes from lboard.bin where the Unknown 1 byte is nonzero, affecting the color of secret node question marks.

```hex
04 17 03 00 00 00 00 01 32 00 02 06 00 00 00 00
36 17 03 00 00 00 00 01 96 00 02 07 00 00 00 00
36 17 03 00 02 00 00 03 5E 01 00 02 00 00 00 00
27 17 03 00 00 00 00 02 FA 00 00 01 00 00 00 00
```

--------------------------------

### Stack Operations API

Source: https://openkh.dev/kh2/file/ai/kh2ai.html

Documentation for stack-based instructions including PUSH and POP variants.

```APIDOC
## PUSH.V ri

### Description
Pushes a value to the stack.

### Parameters
- **ri** (value) - Required - The value to push.

## PUSH.L la

### Description
Pushes a relocated label (address pointer) to the stack.

### Parameters
- **la** (label) - Required - The label to relocate and push.

### Programming Notes
The relocation formula is 0x10 + (l >> 1).

## POP.A rn, ri

### Description
Pops the last value from the stack to the address (rn+ri).

### Parameters
- **rn** (register) - Required - Base register.
- **ri** (index) - Required - Index value.
```

--------------------------------

### Data Memory (bd) String Declaration

Source: https://openkh.dev/kh2/file/ai

Example of declaring a static C-style string in data memory, which is accessed with a pointer that is always doubled by 2.

```c
static char text[] = "hello";

void main() {
    puts(text);
}

```
Tokens:
Raw