Add license and readme files.

Signed-off-by: aixxe <me@aixxe.net>
This commit is contained in:
aixxe
2016-12-20 21:12:28 +00:00
parent 3ea355bf38
commit 712963fc37
2 changed files with 310 additions and 0 deletions

30
README.md Normal file
View File

@@ -0,0 +1,30 @@
# cstrike-basehook-linux
Internal project base for Counter-Strike: Source on Linux. Includes full OpenGL ImGui rendering and input handling, a minimal Source SDK implementation, virtual hooking class and various other features for quick prototyping.
### Features
* Retrieves interfaces directly from the *s_pInterfaceRegs* linked list.
* ImGui drawing and input handling via *ILauncherMgr* virtual hooks.
* *IBaseClientDLL::CreateMove* hook with *CUserCmd* checksum validation.
* *CInput* and *CGlobalVars* pointers retrieved from IBaseClientDLL virtuals.
* Can easily be unloaded, modified and reloaded without restarting the game.
### Requirements
You will need **cmake**, a relatively up-to-date C++ compiler and 32-bit **SDL2** headers.
If you are on a 64-bit system you may need to enable 32-bit repositories.
```
pacman -S cmake base-devel lib32-sdl2
```
### Usage
After you have cloned or extracted an archive of the repository you can use `cmake .` to create a Makefile and `make` to build the shared library. When finished, load the output file into the game while it is running. Using [gdb](https://aixxe.net/2016/09/shared-library-injection) is recommended.
Press <kbd>INSERT</kbd> to toggle the configuration window.
### Credits
Special thanks to [luk1337](https://github.com/luk1337) for the ImGui SDL2 input fix.