Skip to content

Commit

Permalink
Update version string and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Sirius902 committed Jul 15, 2022
1 parent 4bf346c commit fca495a
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 19 deletions.
40 changes: 22 additions & 18 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,40 @@

### Internal LuaBackend Hook [DLL]
- Download ``DBGHELP.zip`` from the Releases tab.
- Extract the contents of ``DBGHELP.zip`` to the directory Kingdom Hearts 1.5+2.5 is installed which should be `KH_1.5_2.5`.
- Place your scripts in a folder named `scripts/[gameid]` in the `KINGDOM HEARTS HD 1.5+2.5 ReMIX` folder in your Documents folder.
- For Kingdom Hearts Final Mix the default folder will be `scripts/kh1`.
- For Kingdom Hearts Re: Chain of Memories the default folder will be `scripts/recom`.
- For Kingdom Hearts II Final Mix the default folder will be `scripts/kh2`.
- For Kingdom Hearts Birth by Sleep Final Mix the default folder will be `scripts/bbs`.
- The installation is now finished. LuaBackend will be automatically started with the game and can be easily uninstalled
by simply removing the ``DBGHELP.dll``. To verify it is installed correctly, you can open the LuaBackend console using
the F2 key on the keyboard in game.
- For Kingdom Hearts 1.5+2.5
- Extract the contents of ``DBGHELP.zip`` to the directory Kingdom Hearts 1.5+2.5 is installed which is named `KH_1.5_2.5`.
- Place your scripts in a folder named `scripts/[gameid]` in the `KINGDOM HEARTS HD 1.5+2.5 ReMIX` folder in your Documents folder.
- For Kingdom Hearts Final Mix the default folder will be `scripts/kh1`.
- For Kingdom Hearts Re: Chain of Memories the default folder will be `scripts/recom`.
- For Kingdom Hearts II Final Mix the default folder will be `scripts/kh2`.
- For Kingdom Hearts Birth by Sleep Final Mix the default folder will be `scripts/bbs`.
- The installation is now finished. LuaBackend will be automatically started with the game and can be easily uninstalled
by removing the ``DBGHELP.dll``. To verify it is installed correctly, you can open the LuaBackend console using
the F2 key on the keyboard in game.
- For Kingdom Hearts 2.8
- The steps for 2.8 are the similar, but the game's install directory is named `KH_2.8` and the default script path
will be in the `KINGDOM HEARTS HD 2.8 Final Chapter Prologue` folder.
- For Kingdom Hearts Dream Drop Distance HD the default scripts folder will be `scripts/kh3d`.

### Custom script locations

A configuration file can be used to customize the script location(s).
The configuration file can be modified to customize the script location(s).

- Edit the file called `LuaBackend.toml` in the same folder as `DBGHELP.dll` (the game install folder).
- To edit the script paths, modify the `scripts` value.
- `path` is the game path for an entry.
- `relative`, when true, will append `path` to the `KINGDOM HEARTS HD 1.5+2.5 ReMIX` folder and will be an absolute path otherwise.
- This file can contain location(s) in which to look for scripts for each game.
- If _any_ valid locations are listed for a game, _only_ those location(s) are searched for scripts.
This allows you to completely override the default location if the default location is causing problems.
- If _no_ valid locations are listed for a game, the default location from above is searched for scripts.
- To edit the script paths, modify the `scripts` value, which is the list of script paths that will be used.
- `path` is the scripts path for an entry.
- `relative`, when true, make the `path` relative to the game's documents folder specified
by `game_docs` and will be an absolute path otherwise.

Sample file:
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"
[kh2]
scripts = [
Expand All @@ -42,4 +45,5 @@ scripts = [
base = 0x56454E
thread_struct = 0x89E9A0
exe = "KINGDOM HEARTS II FINAL MIX.exe"
game_docs = "KINGDOM HEARTS HD 1.5+2.5 ReMIX"
```
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Supports the PC Global and Japanese versions of:
* Kingdom Hearts Re: Chain of Memories
* Kingdom Hearts II Final Mix
* 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.
Expand Down
2 changes: 1 addition & 1 deletion src/lua_exec.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ int EntryLUA(int ProcessID, HANDLE ProcessH, std::uint64_t TargetAddress,

std::cout << "======================================"
<< "\n";
std::cout << "======= LuaBackendHook | v1.6.0 ======"
std::cout << "======= LuaBackendHook | v1.7.0 ======"
<< "\n";
std::cout << "====== Copyright 2021 - TopazTK ======"
<< "\n";
Expand Down

0 comments on commit fca495a

Please sign in to comment.