Textractor/README.md

68 lines
3.0 KiB
Markdown
Raw Normal View History

2018-09-29 16:05:08 -04:00
# Textractor
2015-04-02 22:48:34 +09:00
2016-04-05 01:54:46 +09:00
2018-05-21 03:32:29 -04:00
## Overview
2016-12-15 22:30:45 +09:00
2018-09-29 16:05:08 -04:00
*Textractor* is an open-source x86/x64 text hooker for Windows.
2016-12-15 22:30:45 +09:00
2018-09-04 16:17:08 -04:00
![How it looks](https://media.discordapp.net/attachments/330538905072041994/486629608456847360/unknown.png?width=1083&height=353)
2018-09-04 16:15:04 -04:00
2018-05-21 03:32:29 -04:00
Basically, GUI text hooker based on [Stomp](http://www.hongfire.com/forum/showthread.php/438331-ITHVNR-ITH-with-the-VNR-engine)'s ITHVNR.
2016-12-15 22:30:45 +09:00
2018-05-21 03:32:29 -04:00
## Downloads
2018-09-29 16:05:08 -04:00
Releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases)
2016-12-15 23:14:30 +09:00
2018-08-05 19:10:55 -04:00
Previous releases of ITHVNR can be found [here](https://github.com/mireado/ITHVNR/releases).
2016-12-15 22:30:45 +09:00
## Features
- Open-source
2018-08-11 17:46:13 -04:00
- x64 supported (x64 version only works with x64 programs)
2018-08-18 15:11:51 -04:00
- Hook text using /H "hook" codes (most AGTH codes supported)
2018-08-16 19:56:33 -04:00
- Directly read text using /R "read" codes ([Guide](https://www.youtube.com/watch?v=AcEgjCoww5w))
2018-07-19 01:16:21 -04:00
- Auto hook many engines (including some not supported by VNR!)
2018-08-05 01:06:25 -04:00
- Extensions
2016-12-15 22:30:45 +09:00
2018-08-05 19:10:55 -04:00
## Extensions
2018-09-23 18:34:53 -04: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-05 19:10:55 -04:00
## Compiling
2018-09-29 16:05:08 -04:00
Before compiling *Textractor*, you should get Visual Studio with CMake and ATL support, as well as Qt version 5.11<br>
You should then be able to simply open the folder in Visual Studio, and build. Run Build/Textractor.exe
2018-08-05 19:10:55 -04:00
## Project Architecture
2018-09-02 19:45:18 -04: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>
Host writes to hostPipe, vnrhook writes to hookPipe (duh?)<br>
2018-08-05 19:10:55 -04: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>
Additional information about hooks is shared through a file view (a.k.a. section object) that is mapped to a reference to the Hook class.<br>
2018-09-02 19:45:18 -04: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-05 19:10:55 -04:00
## Contributing
2018-09-23 18:34:53 -04: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-05 19:10:55 -04: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 22:30:45 +09:00
## License
2018-05-20 21:21:37 -04:00
GPL v3
2016-12-15 22:30:45 +09:00
## Developers
2018-09-29 16:05:08 -04:00
- Textractor creation/updating by [Me](https://github.com/Artikash) and [DoumanAsh](https://github.com/DoumanAsh)
2018-09-02 19:45:18 -04: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-05 19:10:55 -04:00
- VNR engine making by [jichi](https://archive.is/prJwr)
2018-07-13 13:10:04 -04:00
- ITH updating by [Andys](https://github.com/AndyScull)
2018-09-02 19:45:18 -04:00
- ITH originally made by [kaosu](http://www.hongfire.com/forum/member/562651-kaosu)
2018-08-25 15:45:35 -04:00
- MinHook library made by [TsudaKageyu](https://github.com/TsudaKageyu)
2016-12-15 22:30:45 +09:00
## Special Thanks
- Everybody adding issues!