Add README.md

This commit is contained in:
Kawe Mazidjatari 2021-04-13 05:03:47 -07:00
parent 3322864d93
commit db261d9de7

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# apex
APEX Legends / R5 Local Engine Server research
* detours-based Visual Studio project for hooking the game engine
## r5dev
to use the vs project / engine hooking, here are some basic instructions
1. build the solution
* or get the binaries from the `v0.1-alpha.zip` on the releases page of this repo
2. copy `r5dev.dll` and `r5launcher.exe` to the apex game folder
3. copy the unpacked version of `r5apex.exe` over the original in your game folder
4. run `r5launcher.exe`
the game will pop a debug terminal, that will forward your commands directly to the in-game source console backend. SQVM prints are also enabled, and the hooks will attempt to load game vscripts out of `platform\` relative from the game executable before falling back to the in-memory VPK structures.
In the future we should probably look over the source engine GameDLL/Engine interfaces (IVEngineServer, IVEngineClient) etc.