Textractor_test/README.md

# Textractor

[日本語](https://github.com/Artikash/Textractor/blob/master/README_JP.md) [Español](https://github.com/Artikash/Textractor/blob/master/README_ES.md)

## [Tutorial Video](https://youtu.be/eecEOacF6mw)

## Overview

**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>

![How it looks](https://media.discordapp.net/attachments/330538905072041994/486629608456847360/unknown.png?width=1083&height=353)

## Downloads

Releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases).

Previous releases of ITHVNR can be found [here](https://github.com/mireado/ITHVNR/releases).

## Features

- 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

## 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 (no, I'm not busy!) 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: just translate the strings in include/text.h as well as this README.

## Compiling

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.

## Project Architecture

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.<br>
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 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.

## Developers

If you're on this list and want your link changed let me know.
- Textractor made by [Me](https://github.com/Artikash) and [DoumanAsh](https://github.com/DoumanAsh)
- Spanish translation by [scese250](https://github.com/scese250)
- Turkish translation by niisokusu
- 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)
- ITH originally made by [kaosu](http://www.hongfire.com/forum/member/562651-kaosu)
- Locale Emulator library made by [xupefei](https://github.com/xupefei)
- MinHook library made by [TsudaKageyu](https://github.com/TsudaKageyu)

## Special Thanks

- Everybody adding issues!
rename 2018-09-30 04:05:08 +08:00			`# Textractor`
Update README.md 2015-04-02 21:48:34 +08:00
Readme Spanish (#77) Translate readme to spanish and link it from homepage 2019-01-22 04:46:57 +08:00			`[日本語](https://github.com/Artikash/Textractor/blob/master/README_JP.md) [Español](https://github.com/Artikash/Textractor/blob/master/README_ES.md)`
Add japanese readme (#35) * Create README_JP.md * add readme jp link 2018-10-03 01:35:44 +08:00
Update README.md 2019-01-15 17:43:26 +08:00			`## [Tutorial Video](https://youtu.be/eecEOacF6mw)`

update readme 2018-05-21 15:32:29 +08:00			`## Overview`
update README 2016-12-15 21:30:45 +08:00
final tiny adjustments for official release 2019-01-15 17:32:00 +08: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>`
update README 2016-12-15 21:30:45 +08:00
Update README.md 2018-09-05 04:17:08 +08:00			`![How it looks](https://media.discordapp.net/attachments/330538905072041994/486629608456847360/unknown.png?width=1083&height=353)`
Update README.md 2018-09-05 04:15:04 +08:00
update readme. removing 64 bit from downloads 2018-10-23 02:30:32 +08:00			`## Downloads`
update readmes 2018-10-22 04:31:19 +08:00
update readme for new project architecture 2018-11-04 13:41:39 +08:00			`Releases of Textractor can be found [here](https://github.com/Artikash/Textractor/releases).`
update README 2016-12-15 22:14:30 +08:00
Update README.md 2018-08-06 07:10:55 +08:00			`Previous releases of ITHVNR can be found [here](https://github.com/mireado/ITHVNR/releases).`
update README 2016-12-15 21:30:45 +08:00
			`## Features`

update readme 2018-09-30 05:42:44 +08:00			`- Highly extensible`
			`- Auto hook many game engines (including some not supported by VNR!)`
update readme. removing 64 bit from downloads 2018-10-23 02:30:32 +08:00			`- Hook text using /H "hook" codes (most AGTH codes supported)`
final tiny adjustments for official release 2019-01-15 17:32:00 +08:00			`- Directly extract text using /R "read" codes`
update README 2016-12-15 21:30:45 +08:00
Update README.md 2018-08-06 07:10:55 +08:00			`## Extensions`

update readme 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>`
update readme for new project architecture 2018-11-04 13:41:39 +08:00			`See the extensions folder for examples of what extensions can do.`
Update README.md 2018-08-06 07:10:55 +08:00
update readme. removing 64 bit from downloads 2018-10-23 02:30:32 +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>`
translation request 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>`
			`Contributing a translation is easy: just translate the strings in include/text.h as well as this README.`
update readme. removing 64 bit from downloads 2018-10-23 02:30:32 +08:00
Update README.md 2018-08-06 07:10:55 +08:00			`## Compiling`

update readmes 2018-10-22 04:31:19 +08: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.`
Update README.md 2018-08-06 07:10:55 +08:00
			`## Project Architecture`

Update README.md 2018-09-03 07:45:18 +08: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>`
update readme 2018-09-30 04:07:08 +08:00			`Host writes to hostPipe, vnrhook writes to hookPipe.<br>`
Update README.md 2018-08-06 07:10:55 +08: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>`
update readme 2018-09-30 04:07:08 +08: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>`
update readme for new project architecture 2018-11-04 13:41:39 +08: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-06 07:10:55 +08:00
update README 2016-12-15 21:30:45 +08:00			`## Developers`

credit turkish translation 2018-12-18 13:13:40 +08:00			`If you're on this list and want your link changed let me know.`
update dev/contributor list 2019-01-12 06:15:10 +08:00			`- Textractor made by [Me](https://github.com/Artikash) and [DoumanAsh](https://github.com/DoumanAsh)`
Readme Spanish (#77) Translate readme to spanish and link it from homepage 2019-01-22 04:46:57 +08:00			`- Spanish translation by [scese250](https://github.com/scese250)`
credit turkish translation 2018-12-18 13:13:40 +08:00			`- Turkish translation by niisokusu`
update dev/contributor list 2019-01-12 06:15:10 +08: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)`
Update README.md 2018-09-03 07:45:18 +08:00			`- ITH originally made by [kaosu](http://www.hongfire.com/forum/member/562651-kaosu)`
update dev/contributor list 2019-01-12 06:15:10 +08:00			`- Locale Emulator library made by [xupefei](https://github.com/xupefei)`
update readme 2018-08-26 03:45:35 +08:00			`- MinHook library made by [TsudaKageyu](https://github.com/TsudaKageyu)`
update README 2016-12-15 21:30:45 +08:00
			`## Special Thanks`

			`- Everybody adding issues!`