leonitousconforti/tinyburg

import "frida-il2cpp-bridge";

import { TinyTowerFridaAgent } from "../../src/agents/base-frida-agent.js";

/**
 * This agent showcases how to subscribe to information changes in the game. In
 * this case, it will alert if the music setting in the settings menu changes.
 *
 * While this could be achieved by polling the desired field very frequently,
 * there is a more elegant solution in my mind. Using frida MemoryAccessMonitor
 * we can watch regions of memory and be alerted when they are accessed or
 * modified. Then we can pass that alert through frida rpc channel to the
 * node.js side
 *
 * @extends TinyTowerFridaAgent<SubscribeToMusicStatusAgent1>
 */
export class SubscribeToMusicStatusAgent1 extends TinyTowerFridaAgent {
    /**
     * @param {(status: boolean) => void} onAccessCallback
     * @param {number} [loadDependenciesMaxRetries]
     * @param {number} [loadDependenciesWaitMs]
     */
    constructor(onAccessCallback, loadDependenciesMaxRetries, loadDependenciesWaitMs) {
        super(loadDependenciesMaxRetries, loadDependenciesWaitMs);
        this._notificationCallback = onAccessCallback;
    }

    loadDependencies() {
        const csharpAssembly = Il2Cpp.domain.assembly("Assembly-CSharp");
        const VPlayerClass = csharpAssembly.image.class("VPlayer");

        /** @type {Il2Cpp.Field<boolean>} */
        const musicEnabledField = VPlayerClass.field("musicEnabled");
        return { csharpAssembly, VPlayerClass, musicEnabledField };
    }

    retrieveData() {
        const memoryRange = { base: this.dependencies.musicEnabledField.handle, size: 1 };
        const callbacks = {
            onAccess: () => this._notificationCallback(this.dependencies.musicEnabledField.value),
        };
        MemoryAccessMonitor.enable(memoryRange, callbacks);
    }
}

/**
 * Defines the public interface of this agent, i.e what methods and properties
 * will be available over the frida rpc channel. In this case, only a main
 * function is exposed, which will create a new instance of the agent and start
 * it. The start method takes care of everything from retrying dependency
 * loading to calling the retrieve data method.
 *
 * @type {import("./shared.js").ISubscribeToMusicStatusAgent1Exports}
 */
const rpcExports = {
    main: async (notificationCallback) => {
        await new SubscribeToMusicStatusAgent1(notificationCallback).start();
    },
};

rpc.exports = rpcExports;