Textractor_test/README.md

56 lines
3.2 KiB
Markdown
Raw Normal View History

2018-09-30 04:05:08 +08:00
# Textractor
2015-04-02 21:48:34 +08:00
2019-02-26 17:04:40 +08:00
![How it looks](screenshot.png)
2020-02-29 16:42:39 +08:00
[English](README.md) ● [Español](README_ES.md) ● [简体中文](README_SC.md) ● [Русский](README_RU.md) ● [한국어](README_KR.md) ● [ภาษาไทย](README_TH.md) ● [Italiano](README_IT.md) ● [日本語](README_JP.md) ● [Bahasa](README_ID.md) ● [Português](README_PT.md)
2019-02-26 17:04:40 +08:00
**Textractor** (a.k.a. NextHooker) is an open-source x86/x64 video game text hooker for Windows/Wine based off of [ITHVNR](http://www.hongfire.com/forum/showthread.php/438331-ITHVNR-ITH-with-the-VNR-engine).<br>
2019-06-06 04:58:45 +08:00
Watch the [tutorial video](https://tinyurl.com/textractor-tutorial) for a quick rundown on using it.
2019-01-15 17:43:26 +08:00
2019-02-16 02:08:22 +08: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)
2019-02-26 17:04:40 +08:00
## Download
2018-10-22 04:31:19 +08:00
2019-02-14 10:33:57 +08:00
Releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases).<br>
2019-02-26 17:04:40 +08:00
The last release of ITHVNR can be found [here](https://drive.google.com/open?id=13aHF4uIXWn-3YML_k2YCDWhtGgn5-tnO).<br>
2019-07-29 13:50:04 +08:00
Try running vcredist if you get an error when starting Textractor.
2016-12-15 21:30:45 +08:00
## Features
2019-06-01 07:29:17 +08:00
- Highly extensible and customizable
2018-09-30 05:42:44 +08:00
- 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 21:30:45 +08:00
2019-02-14 10:33:57 +08: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-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 for examples of what extensions can do.
2018-08-06 07:10:55 +08: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-20 05:07:46 +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).<br>
2019-02-02 05:56:10 +08:00
Contributing a translation is easy: just translate the strings in text.cpp as well as this README.
2018-08-06 07:10:55 +08:00
## Compiling
2020-02-27 20:33:22 +08:00
Before compiling *Textractor*, you should get Visual Studio with CMake support, as well as Qt version 5.13<br>
2018-10-22 04:31:19 +08:00
You should then be able to simply open the folder in Visual Studio, and build. Run Textractor.exe.
2018-08-06 07:10:55 +08:00
## Project Architecture
2019-03-13 23:54:19 +08:00
The host (see GUI/host folder) injects texthook.dll (created from the texthook folder) into the target process and connects to it via 2 pipe files.<br>
Host writes to hostPipe, texthook writes to hookPipe.<br>
texthook 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>
2019-05-28 02:16:29 +08:00
Additional information about hooks is exchanged via shared memory.<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-06 07:10:55 +08:00
2019-10-04 04:02:02 +08:00
## [Developers](CREDITS.md)