How zyrox-client/zyrox-gimkit-client works
1. What this repo is
- Zyrox client is a client-side Gimkit mod/userscript. It runs inside the browser on gimkit.com and augments the game UI and game behavior.
- There is no application server in this repository; the whole architecture is browser-injected code plus optional extension packaging.
2. Primary runtime entrypoint
- The main product is zyrox-base.js, described in the README as the main userscript file.
- That file is the core runtime that loads into the Gimkit page and coordinates the client features.
3. Browser-extension packaging boundary
- extension/zyrox-client/ is the extension-form version of the same client.
- manifest.json declares the extension, while content.js and inject.js form the usual split between:
- a content script running in the extension sandbox, and
- an injected page-context script that can interact with the site’s own JS/DOM more directly.
- This boundary matters because many game hooks require page-context access that a content script alone cannot provide.
4. Page integration flow
- The client’s control flow is: browser loads Gimkit page → extension/userscript injects client code → client attaches to page DOM, game state, and network traffic → modules react and render overlays or automation.
- The repo is therefore centered on runtime interception and augmentation, not on a traditional front-end app lifecycle.
5. Game-state and packet layer
- packetsniffer/packetsniffer.js is a dedicated debug/inspection tool.
- The README says it decodes traffic for both blueboat and colyseus modes, so packet decoding is a key lower-level boundary in the architecture.
- This layer is likely the main source of authoritative game events consumed by higher-level modules.
6. Feature/module layer
- The tests/ directory contains many standalone scripts such as esp.js, hide-popup.js, classic-autoanswer.js, classic-upgrade-hud.js, and ability-test.js.
- Despite the name, these appear to be example/reference feature modules and scenario-specific client behaviors rather than an automated test suite.
- The module set suggests the client is organized around feature plug-ins for different Gimkit modes and utilities.
7. UI overlay and HUD augmentation
- Several example scripts imply an overlay/UI subsystem: classic-upgrade-hud.js, esp.js, hide-popup.js, and drawit-dump.js.
- These features likely sit on top of the game UI, adding information displays, suppressing disruptive UI, and rendering assistive visuals.
8. Automation and game-mode specialization
- Scripts like classic-autoanswer.js and ability-test.js indicate mode-specific automation built on top of game state and packet data.
- The repo is not generic UI tooling; it is tailored to specific Gimkit game modes and mechanics.
9. External dependencies and distribution
- The client is distributed through GreasyFork as a userscript and through Firefox Add-ons / Edge Add-ons as an extension.
- The README also links to a GitHub Pages install site and the Gimkit target site itself, which are relevant external touchpoints for deployment and use.
10. Assets and non-code support files
- images/ contains branding assets used by the README and likely the extension/client UI.
- LICENSE and PRIVACY POLICY define the legal boundary of the project; they are important for the public distribution model but not part of runtime behavior.
11. How to diagram it
- A good architecture diagram would show:
- Gimkit web app as the external host,
- userscript/extension wrapper as the injection boundary,
- core Zyrox client as the feature orchestrator,
- packet sniffing / game-state decoding as the lower-level input source,
- module features as consumers of that state,
- and HUD/overlay/automation as the outward-facing effects in the page.
Main entry points: tests Feature scripts · README.md Docs · zyrox-base.js Userscript shell · manifest.json Manifest
Components 16
Runtime
Injected browser client and extension packaging
- Userscript shell · Top-level browser-injected client entrypoint
zyrox-base.js - Manifest · Defines the extension packaging and permissions
extension/zyrox-client/manifest.json - Content script · Sandboxed extension-side runtime that injects into the page
extension/zyrox-client/content.js - Page injector · Moves code into Gimkit page context for direct hooks
extension/zyrox-client/inject.js - Zyrox core · Coordinates page integration, modules, and runtime behavior
zyrox-base.js
Game Input
Packet decoding and event capture
- Packet sniffer · Decodes blueboat and colyseus traffic into game events
packetsniffer/packetsniffer.js - Game state · Derived match state consumed by features
Feature Modules
Example and mode-specific client behaviors
- Feature scripts · Mode-specific scripts and client behaviors under tests/
tests - ESP · Enemy/item visibility overlay behavior
tests/esp.js - Autoanswer · Classic mode answering automation
tests/classic-autoanswer.js - HUD upgrade · Augments the in-game HUD and status display
tests/classic-upgrade-hud.js - Hide popup · Suppresses disruptive game popups
tests/hide-popup.js - Ability test · Specialized gameplay automation and interaction logic
tests/ability-test.js
Support
Docs, assets, and legal files
Other components
- Gimkit page · Browser host application where Zyrox is injected
Connections 22
- Gimkit page → Userscript shell: loads · The browser loads the injected userscript on Gimkit
- Gimkit page → Manifest: installs · Extension packaging targets the Gimkit page
- Manifest → Content script: declares · Manifest wires the content script into the page
- Content script → Page injector: injects · Bridges from extension sandbox into page context
- Page injector → Zyrox core: boots · Injected page-context code starts the main client
- Userscript shell → Zyrox core: starts · Userscript entrypoint initializes the core runtime
- Zyrox core → Packet sniffer: reads events · Core logic consumes decoded traffic and game signals
- Packet sniffer → Game state: derives · Protocol data is converted into higher-level match state
- Game state → Feature scripts: feeds · Shared state is consumed by feature plug-ins
- Feature scripts → ESP: includes · Representative overlay feature
- Feature scripts → Autoanswer: includes · Representative automation feature
- Feature scripts → HUD upgrade: includes · Representative HUD feature
- Feature scripts → Hide popup: includes · Representative suppression feature
- Feature scripts → Ability test: includes · Representative mode-specialized feature
- ESP → Gimkit page: renders on · Overlay effects appear in the live game page
- HUD upgrade → Gimkit page: updates UI · HUD augmentations are rendered in the browser page
- Hide popup → Gimkit page: suppresses · Client removes or hides intrusive page UI
- Autoanswer → Gimkit page: automates · Automation interacts with the live game experience
- Ability test → Gimkit page: interacts · Mode-specific logic drives game actions in-page
- Docs → Userscript shell: documents · README describes the main userscript entrypoint
- Docs → Manifest: documents · README also covers extension installation and use
- Images → Docs: illustrates · Images support branding and documentation