overlay-toolkit 0.12.0 → 0.13.1

package/dist/helper.d.ts

@@ -0,0 +1,2 @@
+export declare function bufferToHex(buffer: BufferSource): string;
+export declare function hexToBuffer(str: string): Uint8Array;

package/dist/main.d.ts

@@ -2,6 +2,7 @@ import { OverlayToolkit } from './otk';
 export { OverlayToolkit, type GameVersion } from './otk';
 export type { OverlayHID, OverlayHIDDevice, OverlayHIDConnectionEvent, OverlayHIDInputEvent } from './hid';
 export type * from './packet';
+export * from './memory';
 export * from './ffxiv';
 declare let overlayToolkit: OverlayToolkit;
 export default overlayToolkit;

package/dist/memory.d.ts

@@ -0,0 +1,49 @@
+interface SigScanData {
+    base: number;
+    addr: number;
+    bytes: string;
+    mask: boolean[];
+}
+interface MemoryReadData {
+    addr: number;
+    len: number;
+    bytes: string;
+    value?: number;
+}
+export declare class MemoryScanResult {
+    addr: number;
+    base: number;
+    bytes: Uint8Array;
+    mask: boolean[];
+    get valid(): boolean;
+    constructor(scan: SigScanData);
+    private getNthRange;
+    /**
+     * get nth masked (??) data
+     * @param index
+     * @returns data slice
+     */
+    getNthMasked(index: number): Uint8Array | null;
+    /**
+     * get nth masked (??) data in DataView
+     * @param index
+     * @returns dataview
+     */
+    getDataView(index: number): DataView | null;
+    /**
+     * get relative pointer to another object, usually LEA, call, ...
+     * @param index
+     * @returns
+     */
+    getRelativePointer(index: number): number;
+}
+export declare class MemoryReadResult {
+    addr: number;
+    length: number;
+    bytes: Uint8Array;
+    value?: number;
+    get valid(): boolean;
+    constructor(data: MemoryReadData);
+    get dataView(): DataView;
+}
+export {};

package/dist/otk.d.ts

@@ -2,6 +2,7 @@ import { OverlayHID } from './hid';
 import { OverlayCallMessage, OverlayPluginAPI } from './overlay';
 import { FileSystem } from './file_system';
 import { PacketFilter, PacketHandler } from './packet';
+import { MemoryReadResult, MemoryScanResult } from './memory';
 export interface DispatchMessage {
     type: string;
 }
@@ -9,6 +10,16 @@ export interface GameVersion {
     version: string;
     lang: number;
 }
+export interface PluginVersion {
+    /**
+     * plugin version
+     */
+    version: string;
+    /**
+     * tools that plugin provided
+     */
+    tools?: string[];
+}
 export declare class OverlayToolkit {
     /**
      * HID interface
@@ -54,15 +65,35 @@ export declare class OverlayToolkit {
      */
     GetGameVersion(): Promise<GameVersion>;
     /**
-     * Plugin version
-     * @returns get plugin version
+     * Get plugin version
+     * @returns the plugin version
      */
     GetPluginVersion(): Promise<string>;
+    /**
+     * Get plugin version and tool list
+     * @returns the plugin info
+     */
+    GetPluginInfo(): Promise<PluginVersion>;
     /**
      * Open URL in default browser
      * @param url URL to open
      */
     OpenBrowser(url: string): Promise<void>;
+    /**
+     * Search memory sig in program TEXT section
+     * @param sig sig to scan. e.g. "e8 ?? ?? ?? ??"
+     * @param startAddr optional. address to start search, absolute address
+     * @param offset optional. address to start search, relative to text begin
+     * @returns
+     */
+    MemoryScanSig(sig: string, offset: number, startAddr?: number): Promise<MemoryScanResult>;
+    /**
+     * Read memory with address and length
+     * @param addr address to read
+     * @param length length to read. 0x10000 maximum
+     * @returns
+     */
+    MemoryRead(addr: number, length: number): Promise<MemoryReadResult>;
     /**
      * Call start overlay events
      *