Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tinyadapter/node-textractor
Textractor wrapper for Node.js. Extracts text from video games and visual novels.
https://github.com/tinyadapter/node-textractor
Last synced: about 10 hours ago
JSON representation
Textractor wrapper for Node.js. Extracts text from video games and visual novels.
- Host: GitHub
- URL: https://github.com/tinyadapter/node-textractor
- Owner: tinyAdapter
- License: mit
- Created: 2019-02-01T06:52:54.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T20:45:59.000Z (about 1 year ago)
- Last Synced: 2024-11-16T05:49:09.438Z (4 days ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/textractor-wrapper
- Size: 27.3 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-textractor
Textractor wrapper for Node.js.
[Textractor](https://github.com/Artikash/Textractor) (a.k.a. NextHooker) is an open-source x86/x64 text hooker for Windows/Wine based off of ITHVNR.
## Requirements
- Textractor v4.3.0 and above
## Example
```js
const Textractor = require("textractor").Textractor;
let t = new Textractor("X:/path/to/TextractorCLI.exe");
t.on("output", output => {
console.log(`[${output.handle}]: ${output.text}`);
});
t.start();
t.attach(PID);
```
## API
### Textractor(path: string)
The constructor.
#### Params
- `path` - Path to TextractorCLI.exe
### start(): void
Start Textractor process.
### attach(pid: number): void
Attach text hooker to a specific process.
#### Params
- `pid` - Process ID
#### Throws
- _RangeError_ if pid is invalid
- _ReferenceError_ if Textractor process is not started
### detach(pid: number): void
Detach text hooker to a specific process.
#### Params
- `pid` - Process ID
#### Throws
- _ReferenceError_ if the process has not been attached
### hook(pid: number, code: string): void
Inject a hook into a specific process.
Supports **/H** hook code and **/R** read code.
#### Params
- `pid` - Process ID
#### Throws
- _ReferenceError_ if Textractor process is not started
- _ReferenceError_ if the process has not been attached
- _SyntaxError_ if code is invalid
### on(event: "output", listener: (output: TextOutputObject) => void): this
Specify callback function when text outputs.
#### Params
- `event` - Must be "output"
- `listener` - The callback function
#### TextOutputObject
```ts
{
handle: number; // hook index
pid: number; // process ID
addr: number; // hook address
ctx: number; // hook context
ctx2: number; // hook context 2
name: string; // hook name
code: string; // hook code
text: string; // output text
}
```
### exec(command: string): void
Execute a command manually.
#### Params
- `command` - The command to execute
#### Throws
- _ReferenceError_ if Textractor process is not started
### stop(): void
Stop Textractor process.
## License
MIT