add license and update readme

This commit is contained in:
Akash Mozumdar 2018-05-20 21:21:37 -04:00
parent 50d7cdf8fb
commit 2ba72fcbfe
2 changed files with 18 additions and 13 deletions

View File

@ -1,14 +1,10 @@
# ITHVNR # ITHVNR
## Compiling
Before compiling *ITHVNR*, You should get CMake, [Windows Driver Kit 7.1](http://www.microsoft.com/en-us/download/details.aspx?id=11800), and Visual Studio.
## Downloads ## Downloads
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).
~~mireado build server can be found [here](http://mireado.blog.me).~~
## Overview ## Overview
@ -16,28 +12,37 @@ Releases of *ITHVNR* can be found [here](https://github.com/mireado/ITHVNR/relea
Basically, ITHVNR base on [Stomp](http://www.hongfire.com/forum/showthread.php/438331-ITHVNR-ITH-with-the-VNR-engine)'s version. Basically, ITHVNR base on [Stomp](http://www.hongfire.com/forum/showthread.php/438331-ITHVNR-ITH-with-the-VNR-engine)'s version.
## Activity Graph
[![Throughput Graph](https://graphs.waffle.io/mireado/ITHVNR/throughput.svg)](https://waffle.io/mireado/ITHVNR/metrics/throughput)
## Features ## Features
- Open-source - Open-source
- Hook text - Hook text (AGTH hook codes supported)
- Extensions (WIP)
## License ## License
GPL v3
## Developers ## Developers
- Copyright (C) 2010-2012 [kaosu](qiupf2000@gmail.com) - Copyright (C) 2010-2012 [kaosu](qiupf2000@gmail.com)
- Copyright (C) 2015 [zorkzero](zorkzero@hotmail.com)
- VNR engine making by [jichi](http://sakuradite.com/topic) - VNR engine making by [jichi](http://sakuradite.com/topic)
- ITH updating by [Andys](http://www.hongfire.com/forum/member/126633-andys) - ITH updating by [Andys](http://www.hongfire.com/forum/member/126633-andys)
- ITHVNR new GUI & VNR engine migration by [Stomp](http://www.hongfire.com/forum/member/325894-stomp) - ITHVNR new GUI & VNR engine migration by [Stomp](http://www.hongfire.com/forum/member/325894-stomp)
- ITHVNR updating by [mireado](http://blog.naver.com/mireado) and [Eguni](https://github.com/Eguni)
- Korean GUI by [IJEMIN](https://github.com/IJEMIN)
## Special Thanks ## Special Thanks
- Everybody adding issues! - Everybody adding issues!
- [IJEMIN](https://github.com/IJEMIN)
- [Eguni](https://github.com/Eguni) ## Compiling
Before compiling *ITHVNR*, You should get CMake, [Windows Driver Kit 7.1](http://www.microsoft.com/en-us/download/details.aspx?id=11800), and Visual Studio.
## Project Architecture
The GUI links to vnrhost.dll (created from the texthook folder) which injects vnrhook.dll (created from the vnrhook folder) and connects to it via 2 pipe files.<br>
vnrhost writes to hostPipe, vnrhook writes to hookPipe (duh?)<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 section object that is mapped to a reference to the Hook class.<br>
The text that vnrhost receives through the pipe is then processed a little before being dispatched back to the GUI and displayed.