Textractor_test/README.md

61 lines
3.0 KiB
Markdown
Raw Normal View History

2018-09-30 04:05:08 +08:00
# Textractor
2015-04-02 21:48:34 +08:00
[日本語](https://github.com/Artikash/Textractor/blob/master/README_JP.md)
2018-05-21 15:32:29 +08:00
## Overview
2016-12-15 21:30:45 +08:00
2018-09-30 05:42:44 +08:00
**Textractor** (a.k.a. NextHooker) is an open-source x86/x64 text hooker for Windows/Wine based off of [ITHVNR](http://www.hongfire.com/forum/showthread.php/438331-ITHVNR-ITH-with-the-VNR-engine).
2016-12-15 21:30:45 +08:00
2018-09-05 04:17:08 +08:00
![How it looks](https://media.discordapp.net/attachments/330538905072041994/486629608456847360/unknown.png?width=1083&height=353)
2018-09-05 04:15:04 +08:00
2018-05-21 15:32:29 +08:00
## Downloads
2018-09-30 04:07:08 +08:00
Releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases).
2016-12-15 22:14:30 +08:00
2018-08-06 07:10:55 +08:00
Previous releases of ITHVNR can be found [here](https://github.com/mireado/ITHVNR/releases).
2016-12-15 21:30:45 +08:00
## Features
2018-09-30 05:42:44 +08:00
- Highly extensible
2018-08-12 05:46:13 +08:00
- x64 supported (x64 version only works with x64 programs)
2018-08-19 03:11:51 +08:00
- Hook text using /H "hook" codes (most AGTH codes supported)
2018-08-17 07:56:33 +08:00
- Directly read text using /R "read" codes ([Guide](https://www.youtube.com/watch?v=AcEgjCoww5w))
2018-09-30 05:42:44 +08:00
- Auto hook many game engines (including some not supported by VNR!)
2016-12-15 21:30:45 +08:00
2018-08-06 07:10:55 +08:00
## Extensions
2018-09-24 06:34:53 +08:00
See my [Example Extension project](https://github.com/Artikash/ExampleExtension) to see how to build an extension.<br>
See the extensions folder and my [Extensions project](https://github.com/Artikash/Extensions) for examples of what extensions can do.
2018-08-06 07:10:55 +08:00
## Compiling
2018-09-30 04:05:08 +08:00
Before compiling *Textractor*, you should get Visual Studio with CMake and ATL support, as well as Qt version 5.11<br>
2018-09-30 04:07:08 +08:00
You should then be able to simply open the folder in Visual Studio, and build. Run Build/Textractor.exe.
2018-08-06 07:10:55 +08:00
## Project Architecture
2018-09-03 07:45:18 +08:00
The host (see GUI/host folder) injects vnrhook.dll (created from the vnrhook folder) into the target process and connects to it via 2 pipe files.<br>
2018-09-30 04:07:08 +08:00
Host writes to hostPipe, vnrhook writes to hookPipe.<br>
2018-08-06 07:10:55 +08:00
vnrhook waits for the pipe to be connected, then injects a few instructions into any text outputting functions (e.g. TextOut, GetGlyphOutline) that cause their input to be sent through the pipe.<br>
2018-09-30 04:07:08 +08:00
Additional information about hooks is shared through a file view (a.k.a. section object) that is mapped to a reference to the TextHook class.<br>
2018-09-03 07:45:18 +08:00
The text that the host receives through the pipe is then processed a little before being dispatched back to the GUI and displayed.
2018-08-06 07:10:55 +08:00
## Contributing
2018-09-24 06:34:53 +08:00
All contributions are appreciated! Please email (no, I'm not busy!) me at akashmozumdar@gmail.com if you have any questions about the codebase.<br>
2018-08-06 07:10:55 +08:00
You should use the standard process of making a pull request (fork, branch, commit changes, make PR from your branch to my master).
2016-12-15 21:30:45 +08:00
## Developers
2018-09-30 04:05:08 +08:00
- Textractor creation/updating by [Me](https://github.com/Artikash) and [DoumanAsh](https://github.com/DoumanAsh)
2018-09-03 07:45:18 +08:00
- ITHVNR updating by [mireado](https://github.com/mireado) and [Eguni](https://github.com/Eguni)
- ITHVNR new GUI & VNR engine migration by [Stomp](http://www.hongfire.com/forum/member/325894-stomp)
2018-08-06 07:10:55 +08:00
- VNR engine making by [jichi](https://archive.is/prJwr)
2018-07-14 01:10:04 +08:00
- ITH updating by [Andys](https://github.com/AndyScull)
2018-09-03 07:45:18 +08:00
- ITH originally made by [kaosu](http://www.hongfire.com/forum/member/562651-kaosu)
2018-08-26 03:45:35 +08:00
- MinHook library made by [TsudaKageyu](https://github.com/TsudaKageyu)
2016-12-15 21:30:45 +08:00
## Special Thanks
- Everybody adding issues!