Textractor/README.md

# Textractor

![How it looks](screenshot.png)

[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>
Watch the [tutorial video](docs/TUTORIAL.md) for a quick rundown on using it.

## Download

Official stable releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases).<br>
The last release of ITHVNR can be found [here](https://drive.google.com/open?id=13aHF4uIXWn-3YML_k2YCDWhtGgn5-tnO).<br>
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.

## Features

- Highly extensible and customizable
- Auto hook many game engines (including some not supported by VNR!)
- Hook text using /H "hook" codes (most AGTH codes supported)
- Automatically search for possible hook codes

## 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/).

## Extensions

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. 

## Contributing

All contributions are appreciated! Please email me at akashmozumdar@gmail.com if you have any questions about the codebase.<br>
You should use the standard process of making a pull request (fork, branch, commit changes, make PR from your branch to my master).<br>
Contributing a translation is easy: [text.cpp](./text.cpp) contains all of the text strings that you need to translate. Translations of this README or the tutorial video transcript are also welcome.

## Compiling
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.

## Project Architecture

The host injects texthook into the target process and connects to it via 2 pipe files.
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>
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.

## [Developers](docs/CREDITS.md)
rename 2018-09-29 16:05:08 -04:00			`# Textractor`
Update README.md 2015-04-02 22:48:34 +09:00
Update README.md 2019-02-26 04:04:40 -05:00			`![How it looks](screenshot.png)`

reorganize and update docs 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)`
Add japanese readme (#35) * Create README_JP.md * add readme jp link 2018-10-02 13:35:44 -04:00
rearrange build for less confusion and to build CLI faster 2021-11-13 13:38:32 -07:00			`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>`
reorganize and update docs 2022-01-31 01:16:53 -07:00			`Watch the [tutorial video](docs/TUTORIAL.md) for a quick rundown on using it.`
Update README.md 2019-01-15 04:43:26 -05:00
Update README.md 2019-02-26 04:04:40 -05:00			`## Download`
update readmes 2018-10-21 16:31:19 -04:00
update docs 2021-01-31 08:02:10 -07:00			`Official stable releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases).<br>`
Update README.md 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>`
reorganize and update docs 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.`
update README 2016-12-15 22:30:45 +09:00
			`## Features`

Update README.md 2019-05-31 19:29:17 -04:00			`- Highly extensible and customizable`
update readme 2018-09-29 17:42:44 -04:00			`- Auto hook many game engines (including some not supported by VNR!)`
update readme. removing 64 bit from downloads 2018-10-22 14:30:32 -04:00			`- Hook text using /H "hook" codes (most AGTH codes supported)`
update docs 2021-01-31 08:02:10 -07:00			`- Automatically search for possible hook codes`
update README 2016-12-15 22:30:45 +09:00
update readme 2019-02-13 21:33:57 -05:00			`## Support`

rearrange build for less confusion and to build CLI faster 2021-11-13 13:38:32 -07:00			`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/).`
update readme 2019-02-13 21:33:57 -05:00
Update README.md 2018-08-05 19:10:55 -04:00			`## Extensions`

update readme 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>`
update readme for new project architecture 2018-11-04 01:41:39 -04:00			`See the extensions folder for examples of what extensions can do.`
Update README.md 2018-08-05 19:10:55 -04:00
update readme. removing 64 bit from downloads 2018-10-22 14:30:32 -04:00			`## Contributing`

update docs 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>`
translation request 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>`
Update Chinese (Simplified) translation and add a link to text.cpp in the README.md 2023-03-07 15:16:09 +09:00			`Contributing a translation is easy: [text.cpp](./text.cpp) contains all of the text strings that you need to translate. Translations of this README or the tutorial video transcript are also welcome.`
update readme. removing 64 bit from downloads 2018-10-22 14:30:32 -04:00
Update README.md 2018-08-05 19:10:55 -04:00			`## Compiling`
update docs 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.`
Update README.md 2018-08-05 19:10:55 -04:00
			`## Project Architecture`

rearrange build for less confusion and to build CLI faster 2021-11-13 13:38:32 -07:00			`The host injects texthook into the target process and connects to it via 2 pipe files.`
rename 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>`
clearer readme 2019-05-27 14:16:29 -04:00			`Additional information about hooks is exchanged via shared memory.<br>`
update readme for new project architecture 2018-11-04 01:41:39 -04:00			`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.`
Update README.md 2018-08-05 19:10:55 -04:00
reorganize and update docs 2022-01-31 01:16:53 -07:00			`## [Developers](docs/CREDITS.md)`