Skip to content

tinyAdapter/node-textractor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

node-textractor

Textractor wrapper for Node.js.

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

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

{
  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

About

Textractor wrapper for Node.js. Extracts text from video games and visual novels.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •