mousehunt-improved 0.97.1

package/src/modules/debug/index.js

@@ -0,0 +1,172 @@
+import {
+  getCurrentDialog,
+  getCurrentLocation,
+  getCurrentPage,
+  getCurrentSubtab,
+  getCurrentTab,
+  getFlags,
+  getSetting,
+  onActivation,
+  onDeactivation,
+  onDialogHide,
+  onDialogShow,
+  onEvent,
+  onNavigation,
+  onRequest,
+  onTravel
+} from '@utils';
+import settings from './settings';
+
+/**
+ * Log a message to the console with a prefix.
+ *
+ * @param {string} message The message to log.
+ * @param {any[]}  args    Additional arguments to log.
+ */
+const debug = (message, ...args) => {
+  const textMessages = [];
+  const objectMessages = [];
+
+  for (const arg of args) {
+    if (typeof arg === 'string') {
+      textMessages.push(arg);
+    } else {
+      objectMessages.push(arg);
+    }
+  }
+
+  // eslint-disable-next-line no-console
+  console.log(
+    `%cMH Improved:%c ${message}`,
+    'color: #ff3434; font-weight: 900; font-size: 1.1em',
+    'color: inherit; font-weight: inherit; font-size: inherit',
+    ...textMessages,
+    ...objectMessages
+  );
+};
+
+/**
+ * Main function.
+ */
+const main = () => {
+  // If debug is not enabled, return.
+  if (! getSetting('debug', false)) {
+    return;
+  }
+
+  // To enable, either add `debug-all` or one of the following: debug-dialog, debug-navigation, debug-request, debug-events.
+  if (getSetting('debug.dialog', false)) {
+    let currentDialog = null;
+    onDialogHide(() => {
+      debug(`Dialog hidden: ${currentDialog}`);
+    });
+
+    onDialogShow('all', () => {
+      currentDialog = getCurrentDialog();
+      debug(`Dialog shown: ${currentDialog}`);
+    });
+  }
+
+  if (getSetting('debug.navigation', false)) {
+    onNavigation(() => {
+      debug('onNavigation', {
+        page: getCurrentPage(),
+        tab: getCurrentTab(),
+        subtab: getCurrentSubtab(),
+      });
+    });
+
+    onTravel(null, () => {
+      debug('onTravel', getCurrentLocation());
+    });
+  }
+
+  if (getSetting('debug.request', false)) {
+    onRequest('*', (response) => {
+      debug('onRequest', response);
+    });
+  }
+
+  const debugAllEvents = getSetting('debug.all-events', false);
+  const debugEvents = getSetting('debug.events', false);
+
+  if (debugEvents || debugAllEvents) {
+    let events = [
+      'camp_page_arm_item',
+      'camp_page_toggle_blueprint',
+      'camp_page_update_item_array',
+      'camp_quest_hud_view_initialize',
+      'checkout_cart_update',
+      'info_arrow_hide',
+      'info_arrow_show',
+      'spring_hunt_claim_hidden_egg',
+      'tournament_status_change',
+      'treasure_map_update_favourite_friends',
+      'treasure_map_update_sent_requests',
+      'treasure_map_update',
+      'user_interaction_update',
+      'user_inventory_update',
+      'user_inventory_use_convertible',
+      'user_recipe_update',
+      'user_relationship',
+      'user_trap_update',
+    ];
+
+    let hasSingleEvent = false;
+    const ignoredEvents = [];
+
+    // If getFlags() contains debug-events-<event-name>, also log that event.
+    for (const flag in getFlags()) {
+      if (flag.startsWith('debug-events-only-')) {
+        const event = flag.replace('debug-events-only-', '');
+        hasSingleEvent = event;
+      } else if (flag.startsWith('debug-events-')) {
+        const event = flag.replace('debug-events-', '');
+        events.push(event);
+      } else if (flag.startsWith('debug-events-no-')) {
+        const event = flag.replace('debug-events-no-', '');
+        ignoredEvents.push(event);
+      }
+    }
+
+    if (ignoredEvents.length > 0) {
+      events = events.filter((event) => ! ignoredEvents.includes(event));
+    }
+
+    if (hasSingleEvent) {
+      events = [hasSingleEvent];
+    }
+
+    events.forEach((event) => {
+      onEvent(event, (...data) => {
+        debug(`onEvent: ${event}`, data);
+      });
+    });
+  }
+};
+
+/**
+ * Start the module.
+ */
+const init = () => {
+  main();
+
+  onActivation('dev', main);
+  onDeactivation('dev', () => {
+    window.location.reload();
+  });
+};
+
+/**
+ * Initialize the module.
+ */
+export default {
+  id: 'debug',
+  name: 'Debug',
+  type: 'advanced',
+  description: 'Various <a href="https://github.com/MHCommunity/mousehunt-improved/blob/main/docs/debug.md" target="_blank" rel="noreferrer">debugging</a> tools for developers and advanced users.',
+  default: false,
+  order: 900,
+  load: init,
+  settings
+};

package/src/modules/debug/settings/index.js

@@ -0,0 +1,53 @@
+/**
+ * Add settings for the module.
+ *
+ * @return {Array} The settings for the module.
+ */
+export default async () => {
+  return [
+    {
+      id: 'debug.utils-data',
+      title: 'Log data caching activity'
+    },
+    {
+      id: 'debug.events',
+      title: 'Log events'
+    },
+    {
+      id: 'debug.all-events',
+      title: 'Log all events'
+    },
+    {
+      id: 'debug.dialog',
+      title: 'Log IDs of opening and closing dialogs/popups'
+    },
+    {
+      id: 'debug.all',
+      title: 'Log module debug messages'
+    },
+    {
+      id: 'debug.module-loading',
+      title: 'Log module loading'
+    },
+    {
+      id: 'debug.navigation',
+      title: 'Log page, tab, and subtab navigation'
+    },
+    {
+      id: 'debug.request',
+      title: 'Log remote requests and responses'
+    },
+    {
+      id: 'debug.sentry',
+      title: 'Set Sentry to debug mode'
+    },
+    {
+      id: 'debug.hover-popups',
+      title: 'Prevent hover popups from closing'
+    },
+    {
+      id: 'debug.disable-cache',
+      title: 'Disable caching of data and settings',
+    }
+  ];
+};

package/src/modules/delayed-menus/index.js

@@ -0,0 +1,19 @@
+import { addStyles } from '@utils';
+
+import styles from './styles.css';
+
+/**
+ * Initialize the module.
+ */
+const init = () => {
+  addStyles(styles, 'delayed-menus');
+};
+
+export default {
+  id: 'delayed-menus',
+  name: 'Delayed Menus',
+  type: 'feature',
+  default: false,
+  description: 'Add a short delay to the menu dropdowns to prevent accidental clicks.',
+  load: init,
+};

package/src/modules/delayed-menus/styles.css

@@ -0,0 +1,4 @@
+.mousehuntHud-menu ul li ul {
+  transform-origin: top;
+  animation: mh-improved-in-scale-y 0.15s 0.25s 1 backwards cubic-bezier(0.4, 0, 1, 1);
+}

package/src/modules/delayed-tooltips/index.js

@@ -0,0 +1,36 @@
+import { addStyles } from '@utils';
+
+import styles from './styles.css';
+
+/**
+ * Initialize the module.
+ */
+const init = () => {
+  addStyles(styles, 'delayed-tooltips');
+
+  // While the shift key is pressed, add 'no-delayed-tooltips' to the body, which will have the effect of disabling the delayed tooltips.
+  document.addEventListener('keydown', (e) => {
+    if (e.shiftKey) {
+      document.body.classList.add('no-delayed-tooltips');
+    }
+  });
+
+  // When the shift key is released, remove 'no-delayed-tooltips' from the body, which will have the effect of re-enabling the delayed tooltips.
+  document.addEventListener('keyup', (e) => {
+    if (! e.shiftKey) {
+      document.body.classList.remove('no-delayed-tooltips');
+    }
+  });
+};
+
+/**
+ * Initialize the module.
+ */
+export default {
+  id: 'delayed-tooltips',
+  name: 'Delayed Tooltips',
+  type: 'feature',
+  default: false,
+  description: 'Delay the display of tooltips when you mouse over something. Hold down the shift key to display tooltips immediately.',
+  load: init,
+};

package/src/modules/delayed-tooltips/styles.css

@@ -0,0 +1,12 @@
+.mousehuntTooltipParent > .mousehuntTooltip {
+  will-change: transform;
+}
+
+.mousehuntTooltipParent:hover > .mousehuntTooltip {
+  animation: mh-improved-in-scale 0.35s 1 forwards cubic-bezier(0.4, 0, 1, 1) 0s;
+}
+
+.PageHunterProfile .userInteractionButtonsView-button .mousehuntTooltip,
+.no-delayed-tooltips .mousehuntTooltip {
+  animation: none !important;
+}

package/src/modules/emotes/emotes.json

@@ -0,0 +1,107 @@
+{
+  "confused_cat": "https://i.mouse.rip/emotes/confused_cat.png",
+  "facepalm": "https://i.mouse.rip/emotes/facepalm.png",
+  "jerry": "https://i.mouse.rip/emotes/jerry.png",
+  "jerrypog": "https://i.mouse.rip/emotes/jerrypog.png",
+  "kek": "https://i.mouse.rip/emotes/kek.png",
+  "kekd": "https://i.mouse.rip/emotes/kekd.png",
+  "kekl": "https://i.mouse.rip/emotes/kekl.png",
+  "kekwait": "https://i.mouse.rip/emotes/kekwait.png",
+  "mhwiki": "https://i.mouse.rip/emotes/mhwiki.png",
+  "notlikeduck": "https://i.mouse.rip/emotes/notlikeduck.png",
+  "ohnoes": "https://i.mouse.rip/emotes/ohnoes.png",
+  "peepoheart": "https://i.mouse.rip/emotes/peepoheart.png",
+  "pikaoh": "https://i.mouse.rip/emotes/pikaoh.png",
+  "pog": "https://i.mouse.rip/emotes/pog.png",
+  "redcard": "https://i.mouse.rip/emotes/redcard.png",
+  "rip": "https://i.mouse.rip/emotes/rip.png",
+  "sadcat": "https://i.mouse.rip/emotes/sadcat.png",
+  "squirtlepizza": "https://i.mouse.rip/emotes/squirtlepizza.png",
+  "thumbsupcar": "https://i.mouse.rip/emotes/thumbsupcar.png",
+  "tom": "https://i.mouse.rip/emotes/tom.png",
+  "ty": "https://i.mouse.rip/emotes/ty.png",
+  "woohoo": "https://i.mouse.rip/emotes/woohoo.png",
+  "wesmart": "https://i.mouse.rip/emotes/wesmart.png",
+  "yes": "https://i.mouse.rip/emotes/yes.png",
+  "yelling_woman": "https://i.mouse.rip/emotes/yelling_woman.png",
+  "swagdoge": "https://i.mouse.rip/emotes/swagdoge.png",
+  "rlc": "https://i.mouse.rip/emotes/rlc.png",
+  "plusone": "https://i.mouse.rip/emotes/plusone.png",
+  "offtopic": "https://i.mouse.rip/emotes/offtopic.png",
+  "nani": "https://i.mouse.rip/emotes/nani.png",
+  "oof": "https://i.mouse.rip/emotes/oof.png",
+  "pikaSad": "https://i.mouse.rip/emotes/pikaSad.png",
+  "jacobFace": "https://i.mouse.rip/emotes/jacobFace.png",
+  "checkthepins": "https://i.mouse.rip/emotes/checkthepins.png",
+  "checkthenews": "https://i.mouse.rip/emotes/checkthenews.png",
+  "fakenews": "https://i.mouse.rip/emotes/fakenews.png",
+  "dlu": "https://i.mouse.rip/emotes/dlu.png",
+  "dhu": "https://i.mouse.rip/emotes/dhu.png",
+  "cre": "https://i.mouse.rip/emotes/cre.png",
+  "beermouse": "https://i.mouse.rip/emotes/beermouse.png",
+  "auraBirthday": "https://i.mouse.rip/emotes/auraBirthday.png",
+  "auraChrome": "https://i.mouse.rip/emotes/auraChrome.png",
+  "auraCursed": "https://i.mouse.rip/emotes/auraCursed.png",
+  "auraLightning": "https://i.mouse.rip/emotes/auraLightning.png",
+  "auraSlayer": "https://i.mouse.rip/emotes/auraSlayer.png",
+  "auraWinter": "https://i.mouse.rip/emotes/auraWinter.png",
+  "crownBronze": "https://i.mouse.rip/emotes/crownBronze.png",
+  "crownDiamond": "https://i.mouse.rip/emotes/crownDiamond.png",
+  "crownGold": "https://i.mouse.rip/emotes/crownGold.png",
+  "crownPlatinum": "https://i.mouse.rip/emotes/crownPlatinum.png",
+  "crownSilver": "https://i.mouse.rip/emotes/crownSilver.png",
+  "fta": "https://i.mouse.rip/emotes/fta.png",
+  "ftc": "https://i.mouse.rip/emotes/ftc.png",
+  "mod": "https://i.mouse.rip/emotes/mod.png",
+  "powerTypeArcane": "https://i.mouse.rip/emotes/powerTypeArcane.png",
+  "powerTypeDraconic": "https://i.mouse.rip/emotes/powerTypeDraconic.png",
+  "powerTypeForgotten": "https://i.mouse.rip/emotes/powerTypeForgotten.png",
+  "powerTypeHydro": "https://i.mouse.rip/emotes/powerTypeHydro.png",
+  "powerTypeLaw": "https://i.mouse.rip/emotes/powerTypeLaw.png",
+  "powerTypePhysical": "https://i.mouse.rip/emotes/powerTypePhysical.png",
+  "powerTypeRift": "https://i.mouse.rip/emotes/powerTypeRift.png",
+  "powerTypeShadow": "https://i.mouse.rip/emotes/powerTypeShadow.png",
+  "powerTypeTactical": "https://i.mouse.rip/emotes/powerTypeTactical.png",
+  "profileFriend": "https://i.mouse.rip/emotes/profileFriend.png",
+  "profileFriendAdd": "https://i.mouse.rip/emotes/profileFriendAdd.png",
+  "profileFriendDelete": "https://i.mouse.rip/emotes/profileFriendDelete.png",
+  "profileFriendPending": "https://i.mouse.rip/emotes/profileFriendPending.png",
+  "profileGift": "https://i.mouse.rip/emotes/profileGift.png",
+  "profileMap": "https://i.mouse.rip/emotes/profileMap.png",
+  "profileMapAdd": "https://i.mouse.rip/emotes/profileMapAdd.png",
+  "profileMapInvite": "https://i.mouse.rip/emotes/profileMapInvite.png",
+  "profileSupples": "https://i.mouse.rip/emotes/profileSupples.png",
+  "profileTicket": "https://i.mouse.rip/emotes/profileTicket.png",
+  "question": "https://i.mouse.rip/emotes/question.png",
+  "rankApprentice": "https://i.mouse.rip/emotes/rankApprentice.png",
+  "rankArchduke": "https://i.mouse.rip/emotes/rankArchduke.png",
+  "rankBaron": "https://i.mouse.rip/emotes/rankBaron.png",
+  "rankCount": "https://i.mouse.rip/emotes/rankC.png",
+  "rankDuke": "https://i.mouse.rip/emotes/rankDuke.png",
+  "rankElder": "https://i.mouse.rip/emotes/rankElder.png",
+  "rankFabled": "https://i.mouse.rip/emotes/rankFabled.png",
+  "rankGrandduke": "https://i.mouse.rip/emotes/rankGrandduke.png",
+  "rankGrandmaster": "https://i.mouse.rip/emotes/rankGrandmaster.png",
+  "rankHero": "https://i.mouse.rip/emotes/rankHero.png",
+  "rankInitiate": "https://i.mouse.rip/emotes/rankInitiate.png",
+  "rankJourney": "https://i.mouse.rip/emotes/rankJourney.png",
+  "rankKnight": "https://i.mouse.rip/emotes/rankKnight.png",
+  "rankLegendary": "https://i.mouse.rip/emotes/rankLegendary.png",
+  "rankLordLady": "https://i.mouse.rip/emotes/rankLordLady.png",
+  "rankMaster": "https://i.mouse.rip/emotes/rankMaster.png",
+  "rankNovice": "https://i.mouse.rip/emotes/rankNovice.png",
+  "rankRecruit": "https://i.mouse.rip/emotes/rankRecruit.png",
+  "rankSage": "https://i.mouse.rip/emotes/rankSage.png",
+  "rankViceroy": "https://i.mouse.rip/emotes/rankViceroy.png",
+  "statAttraction": "https://i.mouse.rip/emotes/statAttraction.png",
+  "statCheese": "https://i.mouse.rip/emotes/statCheese.png",
+  "statLuck": "https://i.mouse.rip/emotes/statLuck.png",
+  "statPower": "https://i.mouse.rip/emotes/statPower.png",
+  "statPowerBonus": "https://i.mouse.rip/emotes/statPowerBonus.png",
+  "trophyBronze": "https://i.mouse.rip/emotes/trophyBronze.png",
+  "trophyChallenger": "https://i.mouse.rip/emotes/trophyChallenger.png",
+  "trophyCompetitor": "https://i.mouse.rip/emotes/trophyCompetitor.png",
+  "trophyGold": "https://i.mouse.rip/emotes/trophyGold.png",
+  "trophyParticipant": "https://i.mouse.rip/emotes/trophyParticipant.png",
+  "trophySilver": "https://i.mouse.rip/emotes/trophySilver.png"
+}

package/src/modules/emotes/index.js

@@ -0,0 +1,53 @@
+import { addStyles, onNavigation, onRender } from '@utils';
+
+import emotes from './emotes.json';
+
+/**
+ * Replace emotes with images in the text.
+ *
+ * @param {string} text The text to replace emotes in.
+ *
+ * @return {string} The text with emotes replaced with images.
+ */
+const replaceInText = (text) => {
+  const regex = new RegExp(`:(${Object.keys(emotes).join('|')}):`, 'g');
+  text = text.replace(regex, (match, emote) => {
+    return `<img class="emote" src="${emotes[emote]}" alt=":${emote}:" title=":${emote}:" width="20" height="20">`;
+  });
+
+  return text;
+};
+
+/**
+ * Initialize the module.
+ */
+const init = () => {
+  addStyles('.emote { vertical-align: bottom; }', 'emotes');
+
+  onRender({
+    group: 'MessageBoardView',
+    layout: 'layout',
+    after: true,
+    callback: (data, results) => {
+      return replaceInText(results);
+    }
+  });
+
+  onNavigation(() => {
+    const messages = document.querySelectorAll('.messageBoardView-message-body');
+    messages.forEach((message) => {
+      message.innerHTML = replaceInText(message.innerHTML);
+    });
+  }, {
+    page: 'hunterprofile',
+  });
+};
+
+export default {
+  id: 'emotes',
+  name: 'Emotes',
+  type: 'feature',
+  default: true,
+  description: 'Replace Discord-style emotes on corkboards (e.g., :jerry:) with actual images in map and profile corkboard messages. <a href="https://github.com/MHCommunity/mousehunt-improved/blob/main/docs/emotes.md" target="_blank" rel="noreferrer">View the list of supported emotes</a>',
+  load: init,
+};

package/src/modules/emotes/styles.css

@@ -0,0 +1,3 @@
+.uniqueLootCount {
+  margin-left: 5px;
+}

package/src/modules/error-reporting/index.js

@@ -0,0 +1,12 @@
+/**
+ * Set up as a module so that it can be toggled on and off.
+ */
+export default {
+  id: 'error-reporting',
+  name: 'Error Reporting',
+  type: 'advanced',
+  description: 'Send anonymous error reports to the developers.',
+  default: true,
+  order: 1000,
+  load: () => {},
+};

package/src/modules/experiments/index.js

@@ -0,0 +1,134 @@
+import { getSetting, onEvent } from '@utils';
+
+import * as imported from './modules/*/index.js'; // eslint-disable-line import/no-unresolved
+const modules = imported;
+const loadedExperimentModules = new Set();
+
+/**
+ * Load a single experiment module.
+ *
+ * @param {Object} module The experiment module to load.
+ */
+const loadExperimentModule = (module) => {
+  if (! module.load || loadedExperimentModules.has(module.id)) {
+    return;
+  }
+
+  if (module.showIf && ! module.showIf()) {
+    return;
+  }
+
+  module.load();
+  loadedExperimentModules.add(module.id);
+};
+
+/**
+ * Load the experiments.
+ */
+const init = () => {
+  const onlySettings = [
+    {
+      id: 'better-maps.draggable-highlight',
+      name: 'Better Maps: Draggable highlight',
+      description: 'Allows you to drag and reposition the sticky highlight',
+      load: () => {}
+    },
+    {
+      id: 'better-marketplace.show-chart-images',
+      name: 'Better Marketplace: Price history charts',
+      description: 'Show sales price history charts on category pages.',
+      load: () => {}
+    },
+    {
+      id: 'better-marketplace.quick-sell',
+      name: 'Better Marketplace: Quick sell',
+      description: 'Add a quick sell input and button to marketplace item views for faster selling.',
+      load: () => {}
+    },
+    {
+      id: 'better-inventory.add-trap-sorting',
+      name: 'Better Inventory: Add trap sorting',
+      description: 'Add sorting options for traps in the inventory.',
+      load: () => {}
+    }
+  ];
+
+  onlySettings.forEach((module) => {
+    modules.push(module);
+  });
+
+  // Sort by name, but put all the ones that have a ":" in the name before the ones that don't.
+  modules.sort((a, b) => {
+    const aHasColon = a.name.includes(':');
+    const bHasColon = b.name.includes(':');
+
+    if (aHasColon && ! bHasColon) {
+      return -1;
+    }
+
+    if (! aHasColon && bHasColon) {
+      return 1;
+    }
+
+    if (a.name < b.name) {
+      return -1;
+    }
+
+    if (a.name > b.name) {
+      return 1;
+    }
+
+    return 0;
+  });
+
+  // Not every experiment has a load function, because most of them are used by
+  // checking for the setting in their respective modules. These ones aren't contained
+  // in a module, so they need to be loaded here.
+  modules.forEach((module) => {
+    if (getSetting(module.id, false)) {
+      loadExperimentModule(module);
+    }
+  });
+
+  onEvent('mh-improved-settings-changed', ({ key, value }) => {
+    if (! value) {
+      return;
+    }
+
+    const module = modules.find((item) => item.id === key);
+    if (module) {
+      loadExperimentModule(module);
+    }
+  });
+};
+
+/**
+ * Initialize the module.
+ */
+export default {
+  id: 'experiments',
+  name: 'Experiments / Beta Features',
+  description: '',
+  type: 'beta',
+  order: -1,
+  alwaysLoad: true,
+  load: init,
+  settings: async () => {
+    const moduleSettings = [];
+    const availableModules = modules.filter((module) => ! module.showIf || module.showIf());
+
+    for (const module of availableModules) {
+      const settings = module.settings ? await module.settings() : null;
+
+      moduleSettings.push({
+        id: module.id || module.name,
+        title: module.name || module.id,
+        description: module.description || '',
+        default: module.default || false,
+        children: settings || [],
+      });
+    }
+
+    return moduleSettings;
+  },
+};