ScrapHacks/ScrapHacks/README.md

## Features

- read and write memory
- change DirectX state
- Draw DirectX overlay (still need to make a useful overlay)
- Dump various data structures to the console
- Assemble and execute code on the fly
- Can be controlled via keyboard shortcuts (TODO: allow defining own shortcuts for commands)

## Prerequisites

- Visual Studio  2017/2019 (others might work)
- CMake
- Python 3.6 or newer

## Building

Open VS 32-bit command prompt (`vcvars32.bat`) and run the following two commands

```batch
cmake -G"NMake Makefiles" -B build
cmake --build build --target install
```

This will find the Games's installation folder, verify that the version you have is compatible with ScrapHacks and drop the compiled `.pyd` file into the correct folder to be imported

## Getting started

- open the ingame console (Ctrl+^)
- type `import ScrapHack`
- type `$help`

## Notes

(this has only been tested with a (cracked/unpacked/de-obfuscated) `Scrap.exe` v1.0 with a SHA1 checksum of `d2dde960e8eca69d60c2e39a439088b75f0c89fa` , other version will crash if the memory offsets don't match)
Lots of changes (expand to read more) - Update NOTES with new findings - Add Cutter link to README - Add ASMJIT, ASMTK and Zydis to CMake - Make DX8 setting cofigurable via ScrapHacks REPL - Add scaffolding for build hook trampolines using asmjit - Add on the fly assembling of code to REPL - Clean up command structure - Add memory RWX to REPL - Add stack dumping to REPL - Add Gamevar dumping to REPL - Add hook check to overlay commands (don't work if DX8 not hooked) - Allow nested command definitions for cleaner REPL - AllocConsole() as early as possible - shuffle some code around for cleanup - Add GameVar, PakEntry and HashIndex structures 2020-01-03 02:22:09 +00:00			`## Features`

			`- read and write memory`
			`- change DirectX state`
			`- Draw DirectX overlay (still need to make a useful overlay)`
			`- Dump various data structures to the console`
			`- Assemble and execute code on the fly`
			`- Can be controlled via keyboard shortcuts (TODO: allow defining own shortcuts for commands)`

Update README.md,add prerequisites, build and install in one command 2019-09-02 15:06:01 +00:00			`## Prerequisites`

			`- Visual Studio 2017/2019 (others might work)`
			`- CMake`
code cleanup, expand REPL, Automatically generate D3D8-VMT header file from include file, made ScrapHacks importable as python module 2019-12-03 23:28:14 +00:00			`- Python 3.6 or newer`
Update README.md,add prerequisites, build and install in one command 2019-09-02 15:06:01 +00:00
			`## Building`

Update CMakeLists.txt and README.md 2019-12-04 00:21:51 +00:00			Open VS 32-bit command prompt (`vcvars32.bat`) and run the following two commands
Update README.md 2019-02-23 21:44:33 +00:00
Switch build system to CMake 2019-09-01 20:45:07 +00:00			```batch
Update CMakeLists.txt and README.md 2019-12-04 00:21:51 +00:00			`cmake -G"NMake Makefiles" -B build`
			`cmake --build build --target install`
Code cleanup 2019-02-28 16:50:52 +00:00			```
Switch build system to CMake 2019-09-01 20:45:07 +00:00
Lots of changes (expand to read more) - Update NOTES with new findings - Add Cutter link to README - Add ASMJIT, ASMTK and Zydis to CMake - Make DX8 setting cofigurable via ScrapHacks REPL - Add scaffolding for build hook trampolines using asmjit - Add on the fly assembling of code to REPL - Clean up command structure - Add memory RWX to REPL - Add stack dumping to REPL - Add Gamevar dumping to REPL - Add hook check to overlay commands (don't work if DX8 not hooked) - Allow nested command definitions for cleaner REPL - AllocConsole() as early as possible - shuffle some code around for cleanup - Add GameVar, PakEntry and HashIndex structures 2020-01-03 02:22:09 +00:00			This will find the Games's installation folder, verify that the version you have is compatible with ScrapHacks and drop the compiled `.pyd` file into the correct folder to be imported
Added note about checksum of executable file 2019-09-01 20:54:47 +00:00
Lots of changes (expand to read more) - Update NOTES with new findings - Add Cutter link to README - Add ASMJIT, ASMTK and Zydis to CMake - Make DX8 setting cofigurable via ScrapHacks REPL - Add scaffolding for build hook trampolines using asmjit - Add on the fly assembling of code to REPL - Clean up command structure - Add memory RWX to REPL - Add stack dumping to REPL - Add Gamevar dumping to REPL - Add hook check to overlay commands (don't work if DX8 not hooked) - Allow nested command definitions for cleaner REPL - AllocConsole() as early as possible - shuffle some code around for cleanup - Add GameVar, PakEntry and HashIndex structures 2020-01-03 02:22:09 +00:00			`## Getting started`
Add TODO to README 2019-11-20 19:48:15 +00:00
code cleanup, expand REPL, Automatically generate D3D8-VMT header file from include file, made ScrapHacks importable as python module 2019-12-03 23:28:14 +00:00			`- open the ingame console (Ctrl+^)`
			- type `import ScrapHack`
Update CMakeLists.txt and README.md 2019-12-04 00:21:51 +00:00			- type `$help`
code cleanup, expand REPL, Automatically generate D3D8-VMT header file from include file, made ScrapHacks importable as python module 2019-12-03 23:28:14 +00:00
			`## Notes`

Update 'ScrapHacks/README.md' 2019-12-04 10:59:49 +00:00			(this has only been tested with a (cracked/unpacked/de-obfuscated) `Scrap.exe` v1.0 with a SHA1 checksum of `d2dde960e8eca69d60c2e39a439088b75f0c89fa` , other version will crash if the memory offsets don't match)
Add TODO to README 2019-11-20 19:48:15 +00:00