Textractor/README.md

53 lines
3.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-26 04:04:40 -05:00
![How it looks](screenshot.png)
2022-01-31 01:16:53 -07:00
[English](README.md) ● [Español](README_ES.md) ● [简体中文](README_SC.md) ● [Русский](README_RU.md) ● [한국어](README_KR.md) ● [ภาษาไทย](README_TH.md) ● [Français](README_FR.md) ● [Italiano](README_IT.md) ● [日本語](README_JP.md) ● [Bahasa Indonesia](README_ID.md) ● [Português](README_PT.md)
**Textractor** (a.k.a. NextHooker) is an open-source x86/x64 video game text hooker for Windows 7+ (and Wine) based off of [ITHVNR](https://web.archive.org/web/20160202084144/http://www.hongfire.com/forum/showthread.php/438331-ITHVNR-ITH-with-the-VNR-engine).<br>
2022-01-31 01:16:53 -07:00
Watch the [tutorial video](docs/TUTORIAL.md) for a quick rundown on using it.
2019-01-15 04:43:26 -05:00
2019-02-26 04:04:40 -05:00
## Download
2018-10-21 16:31:19 -04:00
2021-01-31 08:02:10 -07:00
Official stable releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases).<br>
2019-02-26 04:04:40 -05:00
The last release of ITHVNR can be found [here](https://drive.google.com/open?id=13aHF4uIXWn-3YML_k2YCDWhtGgn5-tnO).<br>
2022-01-31 01:16:53 -07:00
Experimental builds of Textractor (with debug info) from the latest source can be found [here](https://ci.appveyor.com/project/Artikash/textractor/history) in the 'Artifacts' section of each job.
2016-12-15 22:30:45 +09:00
## Features
2019-05-31 19:29:17 -04:00
- Highly extensible and customizable
2018-09-29 17:42:44 -04:00
- Auto hook many game engines (including some not supported by VNR!)
- Hook text using /H "hook" codes (most AGTH codes supported)
2021-01-31 08:02:10 -07:00
- Automatically search for possible hook codes
2016-12-15 22:30:45 +09:00
2019-02-13 21:33:57 -05:00
## Support
Let me know of any bugs, games that Textractor has trouble hooking, feature requests, or other suggestions by posting an issue.<br>
If you have trouble hooking a game, please show me a way to freely download it or gift it to me on [Steam](https://steamcommunity.com/profiles/76561198097566313/).
2019-02-13 21:33:57 -05: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 for examples of what extensions can do.
2018-08-05 19:10:55 -04:00
## Contributing
2021-11-08 06:21:17 -07:00
All contributions are appreciated! Please email 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>
2021-03-12 07:55:53 -07:00
Contributing a translation is easy: just translate the strings in text.cpp as well as this README and the subtitles of the tutorial video.
2018-08-05 19:10:55 -04:00
## Compiling
2021-11-07 06:18:42 -07:00
Before compiling Textractor, you need Qt version 5.13 and Visual Studio with CMake support.
Clone Textractor's source and initialize submodules with `git clone https://github.com/Artikash/Textractor.git` and `git submodule update --init`.
You should then be able to just open the source folder in Visual Studio and build.
2018-08-05 19:10:55 -04:00
## Project Architecture
The host injects texthook into the target process and connects to it via 2 pipe files.
2019-03-13 11:54:19 -04:00
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-27 14:16:29 -04: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-05 19:10:55 -04:00
2022-01-31 01:16:53 -07:00
## [Developers](docs/CREDITS.md)