Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sirius902 committed Jun 23, 2024
1 parent 4189006 commit 2cfc885
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 14 deletions.
14 changes: 7 additions & 7 deletions DOCUMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ List of types available: Byte, Short, Int, Long, Float, String, Boolean

Example:
```lua
local _tempInt = ReadInt(0xDEADB00) -- Read an integer from address BaseAddress+0xDEADB00
local _tempByte = ReadByte(0xB007555) -- Read a byte from address BaseAddress+0xB007555
local _tempInt = ReadInt(0xDEADB00) -- Read an integer from address GameModule+0xDEADB00
local _tempByte = ReadByte(0xB007555) -- Read a byte from address GameModule+0xB007555
```

### Write\[XXXX\](Address, Value, Absolute = false)
Expand All @@ -39,8 +39,8 @@ List of types available: Byte, Short, Int, Long, Float, String, Boolean

Example:
```lua
WriteShort(0xDEADB00, 0xFFFF) -- Write 0xFFFF to BaseAddress+0xDEADB00
WriteBoolean(0xB007555, true) -- Write true to BaseAddress+0xB007555
WriteShort(0xDEADB00, 0xFFFF) -- Write 0xFFFF to GameModule+0xDEADB00
WriteBoolean(0xB007555, true) -- Write true to GameModule+0xB007555
```

### Read\[XXXX\]A(Address) / ReadStringA(Address, Length)
Expand Down Expand Up @@ -78,7 +78,7 @@ If **Absolute** is true, the address is taken as written and base address is not

Example:
```lua
local _tempArray = ReadArray(0xBEEFDED, 0x10) -- Reads 16 bytes starting at BaseAddress+0xBEEFDED
local _tempArray = ReadArray(0xBEEFDED, 0x10) -- Reads 16 bytes starting at GameModule+0xBEEFDED
```

### WriteArray(Address, Array, Absolute = false)
Expand All @@ -89,7 +89,7 @@ If **Absolute** is true, the address is taken as written and base address is not
Example:
```lua
local _tempArray = { 0xFE, 0xA5, 0x70 }
WriteArray(0x6660420, _tempArray) -- Writes _tempArray to memory, starting at BaseAddress+0x6660420
WriteArray(0x6660420, _tempArray) -- Writes _tempArray to memory, starting at GameModule+0x6660420
```

### ReadArrayA(Address, Length)
Expand Down Expand Up @@ -122,7 +122,7 @@ If **Absolute** is true, the address is taken as written and base address is not

Example:
```lua
local _tempPointer = GetPointer(0xBEEFDAD, 0x15) -- Reads the value at BaseAddress+0xBEEFDAD and adds 0x15 to it.
local _tempPointer = GetPointer(0xBEEFDAD, 0x15) -- Reads the value at GameModule+0xBEEFDAD and adds 0x15 to it.
```

### GetPointerA(Address, Offset)
Expand Down
4 changes: 0 additions & 4 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ Sample configuration:
```
[kh1]
scripts = [{ path = "D:\\kh1-scripts", relative = false }]
base = 0x3A0606
thread_struct = 0x22B7280
exe = "KINGDOM HEARTS FINAL MIX.exe"
game_docs = "KINGDOM HEARTS HD 1.5+2.5 ReMIX"
Expand All @@ -42,8 +40,6 @@ scripts = [
{ path = "scripts\\kh2", relative = true },
{ path = "C:\\Users\\johndoe\\bin\\KH\\PC\\openkh\\mod\\luascript", relative = false },
]
base = 0x56454E
thread_struct = 0x89E9A0
exe = "KINGDOM HEARTS II FINAL MIX.exe"
game_docs = "KINGDOM HEARTS HD 1.5+2.5 ReMIX"
```
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,6 @@ Supports the PC Global and Japanese versions of:
- Kingdom Hearts Birth by Sleep Final Mix
- Kingdom Hearts Dream Drop Distance HD

**Note**: Scripts seem to work fine on Japanese KH2 with the Global version offset already in the config file,
though it is recognized as the Global version at the moment.

Installation instructions are in [INSTALL.md](INSTALL.md).

## Why is the dll file named DBGHELP?
Expand Down

0 comments on commit 2cfc885

Please sign in to comment.