From 584817744bb9b2cc7d5ac711154e4713c76362f7 Mon Sep 17 00:00:00 2001 From: Akash Mozumdar Date: Sun, 5 Aug 2018 19:10:55 -0400 Subject: [PATCH] Update README.md --- README.md | 53 +++++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 406a5ef..cd8b401 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,11 @@ Basically, GUI text hooker based on [Stomp](http://www.hongfire.com/forum/showthread.php/438331-ITHVNR-ITH-with-the-VNR-engine)'s ITHVNR. -## Extensions - -See my [Example Extension project](https://github.com/Artikash/ExampleExtension) to see how to build an extension. - -To use an extension, simply rename the extension dll file to ```{NUMBER}_{NAME}_nexthooker_extension.dll``` and copy into the NextHooker folder. - -Extensions are called in order by the number they are prefixed with. - ## Downloads -Releases of *NextHooker* can be found [here](https://github.com/Artikash/NextHooker/releases) +Releases of NextHooker can be found [here](https://github.com/Artikash/NextHooker/releases) -Previous releases of *ITHVNR* can be found [here](https://github.com/mireado/ITHVNR/releases). +Previous releases of ITHVNR can be found [here](https://github.com/mireado/ITHVNR/releases). ## Features @@ -31,27 +23,14 @@ Previous releases of *ITHVNR* can be found [here](https://github.com/mireado/ITH - Auto hook many engines (including some not supported by VNR!) - Extensions -## License +## Extensions -GPL v3 - -## Developers - -- Copyright (C) 2010-2012 [kaosu](http://www.hongfire.com/forum/member/562651-kaosu) -- VNR engine making by [jichi](http://sakuradite.com/topic) -- ITH updating by [Andys](https://github.com/AndyScull) -- ITHVNR new GUI & VNR engine migration by [Stomp](http://www.hongfire.com/forum/member/325894-stomp) -- ITHVNR updating by [mireado](https://github.com/mireado) and [Eguni](https://github.com/Eguni) -- NextHooker creation/updating by [Me](https://github.com/Artikash) and [DoumanAsh](https://github.com/DoumanAsh) - -## Special Thanks - -- Everybody adding issues! +See my [Example Extension project](https://github.com/Artikash/ExampleExtension) to see how to build an extension. ## Compiling Before compiling *NextHooker*, you should get Visual Studio with CMake and ATL support, as well as Qt version 5.11
-Use Visual Studio to compile all the CMake projects, then use Qt Creator to compile/run the GUI. +You should then be able to simply open the folder in Visual Studio, and build. Run Build/NextHooker.exe ## Project Architecture @@ -60,3 +39,25 @@ vnrhost writes to hostPipe, vnrhook writes to hookPipe (duh?)
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.
Additional information about hooks is shared through a file view (a.k.a. section object) that is mapped to a reference to the Hook class.
The text that vnrhost receives through the pipe is then processed a little before being dispatched back to the GUI and displayed. + +## Contributing + +All contributions are appreciated! Please email (akashmozumdar@gmail.com) me if you have any questions about the codebase, I know it's messy and undercommented. And no, I'm not busy!
+You should use the standard process of making a pull request (fork, branch, commit changes, make PR from your branch to my master). + +## License + +GPL v3 + +## Developers + +- Copyright (C) 2010-2012 [kaosu](http://www.hongfire.com/forum/member/562651-kaosu) +- VNR engine making by [jichi](https://archive.is/prJwr) +- ITH updating by [Andys](https://github.com/AndyScull) +- ITHVNR new GUI & VNR engine migration by [Stomp](http://www.hongfire.com/forum/member/325894-stomp) +- ITHVNR updating by [mireado](https://github.com/mireado) and [Eguni](https://github.com/Eguni) +- NextHooker creation/updating by [Me](https://github.com/Artikash) and [DoumanAsh](https://github.com/DoumanAsh) + +## Special Thanks + +- Everybody adding issues!