Skip to content

m-h-c-t/mh-helper-extension

Repository files navigation

MouseHunt Helper Extension

CI Lint & Test Publish Extension CodeQL

Introduction

This browser extension collects crowdsourced hunt info for MouseHunt, a popular browser game from HitGrab Inc. Collected data is inserted into a database that can be queried to gain insight about various game mechanics and interactions. It provides vital statistics for various community tools, such as catch rate estimators, map solvers, convertible trackers, spreadsheets, and more.

Features

  • Collects hunt data (e.g. trap setup, mouse, location), map contents, crowns, and convertibles (e.g. treasure chests)
  • Only collects data from active hunts, not passive friend hunts or trap checks
  • Only collects game-related data (no names or personal information)
  • Does not modify anything in-game to provide an unfair advantage
  • Comes bundled with tsitu's Auto-Loader bookmarklet

Developers

Requirements: Node v22 or newer installed.
Run the following commands to install dependencies and start developing.

npm install
npm run dev

Scripts

  • npm run dev - builds the extension and watches for changes; loads the extension in a temporary browser profile
  • npm run build - build the extension (defaults to chrome)
  • npm run build:watch - build the the extension and rebuild on subsequent changes
  • npm run start - loads the extension into a temporary browser profile

All of these commands can be affixed with :firefox if you want to do the same for the firefox browser.

The necessary files to run, test and debug this extension are included in the dist\<browser> folder after building.
Please keep the version in src/manifest.json at 0.0.0 to avoid getting banned.

Screenshots

Credits

Special thanks to all who have contributed with advice, bug reports, or code! See this page for all the people who helped so far. ko-fi

About

A Chrome / Firefox browser extension that helps collect data for HitGrab's MouseHunt game

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Contributors 18