👋Introduction

Gimhook v0.0.1

A desktop app and modloader for Gimkit.

How do I install Gimhook?

Check out the installation section for information on installing depending on your OS.

How do I make a mod?

While it is technically possible to write a Gimhook mod manually, the recommended way to do it is via the work-in-progress Gimhook SDK.

Read the SDK documentation for more information.

Is this allowed on Gimkit?

The simplified answer is yes, as long as you don't use it to cheat or otherwise do anything potentially problematic.

Special thanks to Josh Feinsilber and Jeff Osborn for answering this question!

How does this work?

In modern JavaScript, there are modules that can be defined and later imported.

Here's an example of a CommonJS module which we'll give the filename add.js:

module.exports = (a, b) => {return a + b};

..and here's an example of a module that uses it:

const add = require('./add');

console.log(add(2, 2)); // 4

However, modern web apps don't just use modules directly in the browser - They use a bundler to implement require() and bundle all of the dependencies they need into a single JavaScript file.

Gimhook works by hooking onto the parcel's implementation of require() (which Gimkit uses) and intercepting the imported modules to replace them with something else, allowing Gimkit to turn modules into global variables and inject modifications into the Gimkit web client.

Think of it as replacing the add function with something entirely different when it tries to use it. ;)

Also, keep in mind that this is all done client-side, so it doesn't touch anything on Gimkit's servers. Your mods only are only on your client unless you share them and someone else installs it on their client.

As for the desktop app part... that's just done with Electron.