mousehunt-improved 0.97.1 → 0.98.0

package/docs/location-dashboard.md

@@ -1,89 +0,0 @@
-# [Location Dashboard](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-location-dashboard)
-
-Adds a "Dashboard" menu to the top menu bar that will show you the important details of each location.
-
-## Supported Locations
-
-- Bountiful Beanstalk
-  - Current room type
-  - Embellishments
-  - Noise
-  - Hunts remaining
-- Bristle Woods Rift
-  - Current room
-  - Loot progress
-  - Total Time Sand
-- Burroughs Rift
-  - Mist level
-- Fiery Warpath
-  - Current wave
-  - Current streak
-  - Mice remaining
-- Floating Islands
-  - Current island
-  - Current island tiles
-  - Hunts remaining
-- Foreword Farm
-  - Plants growing
-- Fort Rox
-  - Phase of night
-  - Wall HP
-- Furoma Rift
-  - Whether you are inside the pagoda
-  - Battery level
-  - Enerchi amount
-- Iceberg
-  - Phase
-  - Number of feet
-  - Number of hunts taken
-- Labyrinth
-  - Hallway
-  - Number of clues
-- Living Garden
-  - Twisted or normal state
-  - Current pouring progress
-- Lost City
-  - Curses
-- Mousoleum
-  - Whether you have a wall or not
-  - Wall HP
-- Moussu Picchu
-  - Storm level
-  - Rain level and percentage
-  - Wind level and percentage
-- Queso Geyser
-  - Eruption type
-  - Hunts remaining
-- Sand Dunes
-  - Whether or not you have a Stampede
-- School of Sorcery
-  - Current course power type
-  - Hunts remaining
-- Seasonal Garden
-  - Amplifier percentage
-- Sunken City
-  - Zone
-  - Depth
-  - Oxygen remaining
-- Table of Contents
-  - Current book type
-  - Current words written
-  - Hunts remaining
-- Toxic Spill
-  - Crude Pollutinum capacity
-  - Max Pollutinum capacity
-  - Refined Pollutinum
-- Valour Rift
-  - Floor number and name
-  - Hunts Remaining
-  - Speed stat level
-  - Sync stat level
-  - Siphon stat level
-- Whisker Woods Rift
-  - Rage levels
-- Zokor
-  - Current district
-  - Stealth remaining
-- Zugzwang's Tower
-  - Mystic progress
-  - Technic progress

package/docs/lucky-golden-shield-duration-and-reminder.md

@@ -1,8 +0,0 @@
-# [Lucky Golden Shield Duration & Reminder](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-lgs-reminder)
-
-Easily see how much time is left on your Lucky Golden Shield, right in your HUD.
-
-## Options
-
-- **Use new layout style**: Choose a different visual style for the timer display.
-- **Display time in days only**: See the remaining time in days instead of weeks or months for easier tracking.

package/docs/metric-units.md

@@ -1,3 +0,0 @@
-# [Metric Units](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-metric)
-
-Updates the display of mouse weights to use metric units instead of imperial units.

package/docs/paste-hunter-id.md

@@ -1,5 +0,0 @@
-# [Paste Hunter ID](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-paste-hunter-id)
-
-Copy a Hunter ID to your clipboard and then press 'Ctrl/Cmd+v' anywhere to go directly to that hunter's profile.
-
-Will navigate to the profile if the value in your clipboard is a number or if it's a url directly to a hunter's profile.

package/docs/prestige-base-stats.md

@@ -1,3 +0,0 @@
-# [Prestige Base Stats](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-prestige-base-stats)
-
-Shows the correct stats for the Prestige Base in the base selector.

package/docs/printing-press-paper-counter.md

@@ -1,3 +0,0 @@
-# [Printing Press Paper Counter](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-printing-press-paper-counter)
-
-Shows the number of Prolific Printing Papers on the Folklore Printing Press Base and Naughty List Printing Press Base in the trap selector and UI.

package/docs/quick-filters-and-sort.md

@@ -1,8 +0,0 @@
-# [Quick Filters and Sort](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-quick-filters-and-sort)
-
-Quickly filter and sort your trap, base, charm, and cheese selectors for faster setup changes.
-
-## Features
-
-- Adds one-click filters to the Trap and Base selectors to show only specific power types.
-- Adds one-click sorting to the Trap, Base, Charm, and Cheese selectors by Power, Power Bonus, Luck, Attraction Bonus, name, or quantity owned (for cheese and charms).

package/docs/quick-send-supplies.md

@@ -1,8 +0,0 @@
-# [Quick Send Supplies](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-quick-send-supplies)
-
-Send supplies to friends faster with a quick-access menu and favorite items.
-
-## Features
-
-- Hover over any Send Supplies button (including those in Hover Profiles) to quickly pick an item, enter a quantity, and send it instantly
-- Set up to four favorite items to always appear in the quick send menu for even faster access

package/docs/replace-favicon.md

@@ -1,3 +0,0 @@
-# [Replace Favicon](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-replace-favicon)
-
-Replaces the favicon with a more fitting one.

package/docs/scoreboard-search-on-profiles.md

@@ -1,3 +0,0 @@
-# [Scoreboard Search on Profiles](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-profile-scoreboard-search)
-
-Quickly search scoreboards for any user directly from their profile page.

package/docs/shield-goes-to-camp.md

@@ -1,3 +0,0 @@
-# [Shield Goes to Camp](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-shield-goes-to-camp)
-
-On any page that isn't the Camp page, clicking the shield will take you to the Camp page, otherwise it will take your to your Hunter Profile.

package/docs/show-adventure-book.md

@@ -1,7 +0,0 @@
-# [Show Adventure Book](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-show-adventure-book)
-
-Add an Adventure Book button to the Kingdom dropdown menu.
-
-## Features
-
-- Adds an `Adventure Book` menu item under the Kingdom menu to open the Adventure Book popup.

package/docs/show-auras.md

@@ -1,13 +0,0 @@
-# [Show Auras](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-show-auras)
-
-See all your active auras and their expiry times right below your trap stats.
-
-## Features
-
-- Displays all active auras with their remaining duration
-- Shows aura icons and names for easy identification
-
-## Options
-
-- **Show Auras as a List**: Displays auras in a vertical list format.
-- **Show auras as icons**: Only displays the aura icons without text.

package/docs/ssdb-toothlet-counter.md

@@ -1,3 +0,0 @@
-# [SSDB Toothlet Counter](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-ssdb-teeth-counter)
-
-Shows the number of Ful'mina's Charged Toothlets on the Denture Base and Signature Series Denture Base in the trap selector and UI.

package/docs/taller-windows.md

@@ -1,3 +0,0 @@
-# [Taller Windows](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-taller-windows)
-
-See more content at once with taller popup and dialog windows.

package/docs/tem-crowns.md

@@ -1,3 +0,0 @@
-# [TEM Crowns](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-tem-crowns)
-
-Adds catch stats and crown icons to each mouse in the Trap Effectiveness Meter.

package/docs/trap-selector-special-effects.md

@@ -1,8 +0,0 @@
-# [Trap Selector Special Effects](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-trap-selector-special-effects)
-
-Easily spot items in the trap selector that have special effects.
-
-## Features
-
-- Adds a visual indicator to items in the trap selector that have unique or special effects.
-- Helps you quickly identify and choose items with bonuses or special properties.

package/docs/ultimate-checkmark.md

@@ -1,9 +0,0 @@
-# [Ultimate Checkmark](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-ultimate-checkmark-show)
-
-Adds more things to be collected on the items view of your Hunter profile.
-
-## Features
-
-- Adds new categories to the items view of your Hunter profile, so you can see your progress on more collectibles.
-- Categories are Airships, Currency, Equipment, Plankrun Pages, and Treasure Chests. You can disable any of these categories if you don't want to see them.
-- Makes it easier to see what you've collected and what you still need.

package/docs/unique-loot-count.md

@@ -1,7 +0,0 @@
-# [Unique Loot Count](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-unique-loot-count)
-
-See how many unique loot items you've collected in your progress logs.
-
-## Features
-
-- Displays a count of unique loot items in a progress log.

package/docs/wisdom-in-stat-bar.md

@@ -1,12 +0,0 @@
-# [Wisdom in Stat Bar](https://www.mousehuntgame.com/preferences.php?tab=mousehunt-improved-settings#mousehunt-improved-settings-feature-wisdom-in-stat-bar)
-
-See your [wisdom](https://mhwiki.hitgrab.com/wiki/index.php/Wisdom) value directly in the stat bar for quick reference.
-
-## Features
-
-- Adds your current wisdom to the stat bar so you can always see it at a glance.
-- Makes it easier to track your progress toward new titles and bonuses.
-
-## Options
-
-- **Update automatically**: If enabled, your wisdom value updates automatically; otherwise, it updates when you click the stat bar.

package/jsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es2024",
-    "module": "es6",
-    "allowSyntheticDefaultImports": true,
-    "lib": ["DOM", "ESNext"],
-    "paths": {
-      "@/*": ["./src/modules/*"],
-      "@utils/*": ["./src/utils/"],
-      "@utils/shared/*": ["./src/utils/shared/*"],
-      "@utils": ["./src/utils/index.js"],
-      "@data/*": ["./src/data/*"]
-    }
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}

package/scripts/build-extension.mjs

@@ -1,119 +0,0 @@
-import * as esbuild from 'esbuild';
-import copyPlugin from '@sprout2000/esbuild-copy-plugin'; // eslint-disable-line import/default
-import fs from 'node:fs';
-import path from 'node:path';
-
-import {
-  CSSMinifyTextPlugin,
-  ImportGlobPlugin,
-  JSONMinifyPlugin,
-  minifyAllJsonFiles,
-  parseArgs
-} from './shared.mjs';
-
-const argv = await parseArgs(process.argv);
-
-/**
- * Main build function.
- *
- * @param {string}  platform The platform to build for.
- * @param {boolean} watch    Whether to watch for changes.
- *
- * @return {Promise<void>} Esbuild build result.
- */
-const buildExtension = async (platform, watch = false) => {
-  fs.mkdirSync(path.join(process.cwd(), `dist/${platform}`), { recursive: true });
-
-  // Copy manifest.json and inject the version number.
-  const manifest = JSON.parse(fs.readFileSync(
-    path.join(process.cwd(), 'src/extension/manifest.json'), 'utf8'
-  ));
-
-  fs.writeFileSync(
-    path.join(process.cwd(), `dist/${platform}/manifest.json`),
-    JSON.stringify({
-      ...manifest,
-      version: process.env.npm_package_version,
-    }, null, 2)
-  );
-
-  minifyAllJsonFiles();
-
-  const opts = {
-    entryPoints: ['src/index.js'],
-    platform: 'browser',
-    format: 'iife',
-    globalName: 'mhui',
-    bundle: true,
-    minify: true,
-    metafile: true,
-    sourcemap: true,
-    target: [
-      'es6',
-      'chrome58',
-      'firefox57'
-    ],
-    alias: {
-      '@data': path.resolve(process.cwd(), 'dist/data'),
-    },
-    dropLabels: ['excludeFromExtension'],
-    outfile: `dist/${platform}/main.js`,
-    plugins: [
-      ImportGlobPlugin,
-      CSSMinifyTextPlugin,
-      JSONMinifyPlugin,
-      copyPlugin.copyPlugin({ // eslint-disable-line import/no-named-as-default-member
-        src: 'src/extension',
-        dest: `dist/${platform}`,
-        /**
-         * Don't copy the screenshots dir or any dotfiles.
-         * We don't copy the manifest because we're copying a modified version of it above.
-         *
-         * @param {string} file The file to filter.
-         *
-         * @return {boolean} Whether to filter the file.
-         */
-        filter: (file) => {
-          return (
-            ! file.startsWith('src/extension/screenshots') &&
-            ! file.startsWith('src/extension/.') &&
-            ! file.startsWith('src/extension/manifest') &&
-            ! file.startsWith('src/extension/content.js')
-          );
-        }
-      }),
-    ],
-    banner: {
-      js: [
-        `const mhImprovedVersion = '${process.env.npm_package_version}';`,
-        `const mhImprovedPlatform = '${platform}';`,
-      ].join('\n'),
-    }
-  };
-
-  if (watch) {
-    console.log(' Watching for changes...'); // eslint-disable-line no-console
-    opts.logLevel = 'info';
-    const ctx = await esbuild.context(opts);
-    return await ctx.watch();
-  }
-
-  await esbuild.build({
-    entryPoints: ['src/extension/content.js'],
-    platform: 'browser',
-    bundle: true,
-    minify: false,
-    sourcemap: true,
-    target: [
-      'es6',
-      'chrome58',
-      'firefox57'
-    ],
-    outfile: `dist/${platform}/content.js`,
-  });
-
-  const result = await esbuild.build(opts);
-  fs.writeFileSync(`dist/metafile-${platform}.json`, JSON.stringify(result.metafile, null, 2));
-};
-
-await buildExtension(argv.platform, argv.watch, argv.release);

package/scripts/build-userscript.mjs

@@ -1,73 +0,0 @@
-import * as esbuild from 'esbuild';
-import fs from 'node:fs';
-import path from 'node:path';
-
-import { CSSMinifyTextPlugin, ImportGlobPlugin, JSONMinifyPlugin, minifyAllJsonFiles } from './shared.mjs';
-
-await minifyAllJsonFiles();
-
-await esbuild.build({
-  entryPoints: ['src/index.js'],
-  platform: 'browser',
-  format: 'iife',
-  globalName: 'mhui',
-  bundle: true,
-  minify: false,
-  minifySyntax: true,
-  sourcemap: false,
-  sourcesContent: false,
-  target: [
-    'es6',
-    'chrome58',
-    'firefox57'
-  ],
-  plugins: [
-    ImportGlobPlugin,
-    CSSMinifyTextPlugin,
-    JSONMinifyPlugin
-  ],
-  outfile: 'dist/mousehunt-improved.user.js',
-  alias: {
-    '@data': path.resolve(process.cwd(), 'dist/data'),
-  },
-  dropLabels: ['excludeFromUserscript'],
-  banner: {
-    js: [
-      '// ==UserScript==',
-      '// @name        🐭️ MouseHunt Improved',
-      '// @description Improve your MouseHunt experience. Please only use this when the extension is not available.',
-      `// @version     ${process.env.npm_package_version}`,
-      '// @license     MIT',
-      '// @author      bradp',
-      '// @namespace   bradp',
-      '// @match       https://www.mousehuntgame.com/*',
-      '// @icon        https://i.mouse.rip/mh-improved/icon-64.png',
-      '// @run-at      document-end',
-      '// @grant       none',
-      '// ==/UserScript==',
-      `const mhImprovedVersion = '${process.env.npm_package_version}';`,
-      'const mhImprovedPlatform = \'userscript\';',
-    ].join('\n'),
-  }
-});
-
-const file = fs.readFileSync(path.resolve(process.cwd(), 'dist/mousehunt-improved.user.js'), 'utf8');
-
-// Remove any comment lines that start with `// node_modules` or `// src` (they may start with a space or tab).
-let cleaned = file
-  .replaceAll(/\s*\/\/\s*(node_modules|src).*/g, '')
-  .replaceAll(/^\s+/gm, '');
-
-// remove any lines that start with '// ' except for the banner
-cleaned = cleaned
-  .split('\n')
-  .filter((line, index) => {
-    if (index < 12) {
-      return true;
-    } // keep the banner
-    return ! line.trim().startsWith('//');
-  })
-  .join('\n');
-
-// write the cleaned file back to disk
-fs.writeFileSync(path.resolve(process.cwd(), 'dist/mousehunt-improved.user.js'), cleaned);

package/scripts/build.mjs

@@ -1,106 +0,0 @@
-import { $ } from 'bun'; // eslint-disable-line import/no-unresolved, unicorn/prefer-node-protocol
-import archiver from 'archiver';
-import chalk from 'chalk';
-import fs from 'node:fs';
-import path from 'node:path';
-
-import packageJson from '../package.json' with { type: 'json' };
-
-const check = chalk.green('✔');
-const dot = chalk.gray('●');
-
-const buildArchive = async () => {
-  console.log(`${dot} Building archive...`); // eslint-disable-line no-console
-  await $`mkdir -p dist`;
-  await $`git archive --format zip --output dist/archive.zip HEAD`;
-  console.log(`${check} Archive built`); // eslint-disable-line no-console
-};
-
-const fetchExternalFiles = async (skipExternalFiles = false) => {
-  if (! skipExternalFiles) {
-    console.log(`${dot} Fetching external CSS...`); // eslint-disable-line no-console
-  }
-
-  await $`bun run scripts/fetch-external-files.mjs ${skipExternalFiles ? '--skip-external-files' : ''}`;
-
-  if (! skipExternalFiles) {
-    console.log(`${check} External CSS fetched`); // eslint-disable-line no-console
-  }
-};
-
-const buildExtension = async (platform) => {
-  await fetchExternalFiles(true);
-  console.log(`${dot} Building extension for ${platform} ...`); // eslint-disable-line no-console
-  await $`bun run scripts/build-extension.mjs --platform=${platform}`;
-  console.log(`${check} Extension for ${platform} built`); // eslint-disable-line no-console
-};
-
-const buildUserscript = async () => {
-  console.log(`${dot} Building userscript...`); // eslint-disable-line no-console
-  await $`bun run scripts/build-userscript.mjs --platform=userscript`;
-  console.log(`${check} Userscript built`); // eslint-disable-line no-console
-};
-
-const buildZip = async (platform) => {
-  const output = fs.createWriteStream(path.join(process.cwd(), `dist/mousehunt-improved-${platform}.zip`));
-  const archive = archiver('zip', {
-    zlib: { level: 9 }
-  });
-
-  archive.on('error', function (err) {
-    throw err;
-  });
-
-  archive.pipe(output);
-
-  archive.directory(path.join(process.cwd(), `dist/${platform}/`), false);
-
-  await archive.finalize();
-};
-
-const buildZips = async () => {
-  console.log(`${dot} Zipping extensions...`); // eslint-disable-line no-console
-
-  await buildZip('chrome');
-  await buildZip('firefox');
-
-  console.log(`${check} Extensions zipped`); // eslint-disable-line no-console
-};
-
-const type = process.argv[2];
-
-console.log(chalk.bold(`Building MouseHunt Improved v${packageJson.version} (${type || 'all'})`)); // eslint-disable-line no-console
-
-if (type === 'archive') {
-  await buildArchive();
-  process.exit(0); // eslint-disable-line unicorn/no-process-exit
-} else if (type === 'css') {
-  await fetchExternalFiles();
-} if (type === 'extension') {
-  await Promise.all([
-    buildExtension('chrome'),
-    buildExtension('firefox'),
-  ]);
-} else if (type === 'chrome') {
-  await buildExtension('chrome');
-} else if (type === 'firefox') {
-  await buildExtension('firefox');
-} else if (type === 'userscript') {
-  await buildUserscript();
-} else if (type === 'zips') {
-  await buildZips();
-  process.exit(0); // eslint-disable-line unicorn/no-process-exit
-} else {
-  await fetchExternalFiles(process.argv.includes('--skip-external-files'));
-
-  await Promise.all([
-    buildArchive(),
-    buildExtension('chrome'),
-    buildExtension('firefox'),
-    buildUserscript(),
-  ]);
-
-  await buildZips();
-}
-
-console.log(chalk.bold.green(`Built MouseHunt Improved v${packageJson.version}`)); // eslint-disable-line no-console

package/scripts/fetch-external-files.mjs

@@ -1,26 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-
-const cssFilesToFetch = [
-  'dark-mode-mice-images.css',
-  'great-winter-hunt-global.css',
-  'journal-icons.css',
-  'upscaled-images.css',
-  'upscaled-journal-theme-images.css',
-  'upscaled-mice-images.css',
-];
-
-const onlyIfMissing = process.argv.includes('--skip-external-files');
-
-fs.mkdirSync(path.join(process.cwd(), 'src/extension/static/data'), { recursive: true });
-
-for (const file of cssFilesToFetch) {
-  if (onlyIfMissing && fs.existsSync(path.join(process.cwd(), 'src/extension/static', file))) {
-    continue;
-  }
-
-  const res = await fetch(`https://api.mouse.rip/${file}?cache=${Date.now() + Math.random()}`);
-  const text = await res.text();
-
-  fs.writeFileSync(path.join(process.cwd(), 'src/extension/static', file), text);
-}