Textractor/README.md

78 lines
4.2 KiB
Markdown
Raw Normal View History

2018-09-29 16:05:08 -04:00
# Textractor
2015-04-02 22:48:34 +09:00
2019-02-01 11:01:45 -05:00
[Español](https://github.com/Artikash/Textractor/blob/master/README_ES.md)<br>
[简体中文](https://github.com/Artikash/Textractor/blob/master/README_SC.md)<br>
[日本語](https://github.com/Artikash/Textractor/blob/master/README_JP.md)
2019-01-15 04:43:26 -05:00
## [Tutorial Video](https://youtu.be/eecEOacF6mw)
2019-02-15 13:08:22 -05:00
[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=akashmozumdar%40gmail.com&item_name=Textractor%20development&currency_code=USD)
2018-05-21 03:32:29 -04:00
## Overview
2016-12-15 22:30:45 +09: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).<br>
2016-12-15 22:30:45 +09:00
2019-01-28 07:05:29 -05:00
![How it looks](https://media.discordapp.net/attachments/330538905072041994/539414661796200448/unknown.png?width=1072&height=398)
2018-09-04 16:15:04 -04:00
## Downloads
2018-10-21 16:31:19 -04:00
2019-02-13 21:33:57 -05:00
Releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases).<br>
Previous releases of ITHVNR can be found [here](https://github.com/mireado/ITHVNR/releases).<br>
If you get a dll missing error, you probably need to (re)install the [Microsoft Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads).
2016-12-15 22:30:45 +09:00
## Features
2018-09-29 17:42:44 -04:00
- Highly extensible
- Auto hook many game engines (including some not supported by VNR!)
- Hook text using /H "hook" codes (most AGTH codes supported)
- Directly extract text using /R "read" codes
2016-12-15 22:30:45 +09:00
2019-02-13 21:33:57 -05:00
## Support
Please let me know of any bugs, games that Textractor has trouble hooking, feature requests, or other suggestions.<br>
If you have trouble hooking a game please email me a place where I can freely download it, or gift it to me on [Steam](https://steamcommunity.com/profiles/76561198097566313/).
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 for examples of what extensions can do.
2018-08-05 19:10:55 -04:00
## Contributing
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-12-19 16:07:46 -05:00
You should use the standard process of making a pull request (fork, branch, commit changes, make PR from your branch to my master).<br>
2019-02-01 16:56:10 -05:00
Contributing a translation is easy: just translate the strings in text.cpp as well as this README.
2018-08-05 19:10:55 -04:00
## Compiling
2018-10-21 16:31:19 -04:00
Before compiling *Textractor*, you should get Visual Studio with CMake 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 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>
2018-09-29 16:07:08 -04:00
Host writes to hostPipe, vnrhook writes to hookPipe.<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>
2018-09-29 16:07:08 -04: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>
The text that the host receives through the pipe is then processed a little before being dispatched back to the GUI.<br>
Finally, the GUI dispatches the text to extensions before displaying it.
2018-08-05 19:10:55 -04:00
2016-12-15 22:30:45 +09:00
## Developers
2018-12-18 00:13:40 -05:00
If you're on this list and want your link changed let me know.
2019-01-11 17:15:10 -05:00
- Textractor made by [Me](https://github.com/Artikash) and [DoumanAsh](https://github.com/DoumanAsh)
- Spanish translation by [scese250](https://github.com/scese250)
2018-12-18 00:13:40 -05:00
- Turkish translation by niisokusu
- Simplified Chinese translation by [tinyAdapter](https://github.com/tinyAdapter)
2019-01-11 17:15:10 -05:00
- ITHVNR updated by [mireado](https://github.com/mireado) and [Eguni](https://github.com/Eguni)
- ITHVNR originally made by [Stomp](http://www.hongfire.com/forum/member/325894-stomp)
- VNR engine made by [jichi](https://archive.is/prJwr)
- ITH updated 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)
2019-01-11 17:15:10 -05:00
- Locale Emulator library made by [xupefei](https://github.com/xupefei)
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!