mousehunt-improved 0.97.1

package/src/modules/better-travel/modules/reminders/index.js

@@ -0,0 +1,169 @@
+import { getCurrentLocation, getFlag, showHornMessage } from '@utils';
+
+/**
+ * Allow the user to disable reminder for specific items.
+ *
+ * @param {string} item The item to disable the reminder for.
+ *
+ * @return {boolean} True if the reminder was disabled.
+ */
+const hasDisabledReminder = (item) => {
+  return getFlag(`better-travel-no-reminder-${item}`);
+};
+
+/**
+ * Add reminders to the horn when traveling.
+ */
+const addReminders = () => {
+  const reminderOpts = {
+    title: 'Travel Reminder',
+    dismiss: 6000,
+    classname: 'travel-reminder',
+  };
+
+  switch (getCurrentLocation()) {
+  case 'rift_valour':
+    if (hasDisabledReminder('champions-fire')) {
+      break;
+    }
+
+    if (user.quests?.QuestRiftValour?.is_fuel_enabled) {
+      reminderOpts.text = 'Champion\'s Fire is active.';
+      reminderOpts.image = 'https://www.mousehuntgame.com/images/items/stats/transparent_thumb/6622efd1db7028b30f48b15771138720.png';
+      reminderOpts.button = 'Deactivate';
+      /**
+       * Toggle the fuel.
+       */
+      reminderOpts.action = () => {
+        const button = document.querySelector('.valourRiftHUD-fuelContainer-armButton');
+        if (button) {
+          button.click();
+        }
+      };
+    }
+    break;
+  case 'queso_river':
+  case 'queso_plains':
+  case 'queso_quarry':
+  case 'queso_geyser':
+    if (hasDisabledReminder('wild-tonic')) {
+      break;
+    }
+
+    if (
+      user.quests?.QuestQuesoCanyon?.is_wild_tonic_active ||
+      user.quests?.QuestQuesoGeyser?.is_wild_tonic_enabled
+    ) {
+      reminderOpts.text = 'Wild Tonic is active.';
+      reminderOpts.image = 'https://www.mousehuntgame.com/images/items/stats/transparent_thumb/b6b9f97a1ee3692fdff0b5a206adf7e1.png';
+      reminderOpts.button = 'Deactivate';
+      /**
+       * Toggle the fuel.
+       */
+      reminderOpts.action = () => {
+        const button = document.querySelector('.quesoHUD-wildTonic-button');
+        if (button) {
+          button.click();
+        }
+      };
+    }
+    break;
+  case 'floating_islands':
+    if (hasDisabledReminder('bottled-wind')) {
+      break;
+    }
+
+    if ('launch_pad_island' === user.quests?.QuestFloatingIslands?.hunting_site_atts?.island_power_type) {
+      break;
+    }
+
+    if (
+      ! user.quests?.QuestFloatingIslands?.hunting_site_atts?.is_fuel_enabled && // BW not active.
+      ! (
+        user.quests?.QuestFloatingIslands?.hunting_site_atts?.is_vault_island && // is SP.
+        user.quests?.QuestFloatingIslands?.hunting_site_atts?.island_mod_panels[2]?.is_complete // Is on the 4th tile.
+      )
+    ) {
+      reminderOpts.text = 'Bottled Wind is <strong>not</strong> active.';
+      reminderOpts.image = 'https://www.mousehuntgame.com/images/ui/hud/floating_islands/items/bottled_wind_stat_item.png';
+      reminderOpts.button = 'Activate';
+      /**
+       * Toggle the fuel.
+       */
+      reminderOpts.action = () => {
+        const button = document.querySelector('.floatingIslandsHUD-fuel-button');
+        if (button) {
+          button.click();
+        }
+      };
+    }
+    break;
+  case 'bountiful_beanstalk':
+  case 'foreword_farm':
+  case 'prologue_pond':
+  case 'table_of_contents':
+  case 'school_of_sorcerey':
+  case 'draconic_depths':
+  case 'afterword_acres':
+  case 'epilogue_falls':
+    if (hasDisabledReminder('condensed-creativity')) {
+      break;
+    }
+
+    if (
+      user.quests?.QuestBountifulBeanstalk?.is_fuel_enabled ||
+      user.quests?.QuestProloguePond?.is_fuel_enabled ||
+      user.quests?.QuestForewordFarm?.is_fuel_enabled ||
+      user.quests?.QuestTableOfContents?.is_fuel_enabled ||
+      user.quests?.QuestSchoolOfSorcery?.is_fuel_enabled ||
+      user.quests?.QuestDraconicDepths?.is_fuel_enabled ||
+      user.quests?.QuestAfterwordAcres?.is_fuel_enabled ||
+      user.quests?.QuestEpilogueFalls?.is_fuel_enabled
+    ) {
+      reminderOpts.text = 'Condensed Creativity is active.';
+      reminderOpts.button = 'Deactivate';
+    } else {
+      reminderOpts.text = 'Condensed Creativity is <strong>not</strong> active.';
+      reminderOpts.button = 'Activate';
+    }
+
+    reminderOpts.image = 'https://www.mousehuntgame.com/images/items/stats/transparent_thumb/4f5d55c1eff77474c7363f0e52d03e49.png';
+    reminderOpts.action = hg.views.HeadsUpDisplayFolkloreForestRegionView.toggleFuel;
+    break;
+  case 'winter_hunt_grove':
+  case 'winter_hunt_workshop':
+  case 'winter_hunt_fortress':
+    if (hasDisabledReminder('festive-spirit')) {
+      break;
+    }
+
+    if (
+      user.quests?.QuestCinnamonTreeGrove?.is_fuel_enabled ||
+      user.quests?.QuestGolemWorkshop?.is_fuel_enabled ||
+      user.quests?.QuestIceFortress?.is_fuel_enabled
+    ) {
+      reminderOpts.text = 'Festive Spirit is active.';
+      reminderOpts.button = 'Deactivate';
+    } else if ('winter_hunt_forest' === getCurrentLocation()) {
+      reminderOpts.text = 'Festive Spirit is <strong>not</strong> active.';
+      reminderOpts.button = 'Activate';
+    }
+
+    reminderOpts.image = 'https://www.mousehuntgame.com/images/items/stats/large/cda292833fce3b65b7a6a38c000e8620.png';
+    /**
+     * Toggle the fuel.
+     */
+    reminderOpts.action = () => {
+      const toggle = document.querySelector('.headsUpDisplayWinterHuntRegionView__fuelButton');
+      if (toggle) {
+        toggle.click();
+      }
+    };
+  }
+
+  if (reminderOpts.text) {
+    showHornMessage(reminderOpts);
+  }
+};
+
+export default addReminders;

package/src/modules/better-travel/modules/travel-window/index.js

@@ -0,0 +1,380 @@
+import {
+  addStyles,
+  addSubmenuItem,
+  createPopup,
+  debug,
+  getCurrentLocation,
+  getData,
+  getSetting,
+  isUserTitleAtLeast,
+  onDialogHide,
+  onEvent,
+  travelTo
+} from '@utils';
+
+import { getTravelSetting, saveTravelSetting } from '../../utils';
+
+import styles from './styles.css';
+
+/**
+ * Get the hidden locations.
+ *
+ * @return {string[]} The hidden locations.
+ */
+const getHiddenLocations = () => {
+  return getTravelSetting('travel-window-hidden-locations', []);
+};
+
+/**
+ * Toggle hiding a location.
+ *
+ * @param {string} location The location to toggle.
+ */
+const toggleLocation = (location) => {
+  if (isLocationHidden(location)) {
+    unhideLocation(location);
+  } else {
+    hideLocation(location);
+  }
+};
+
+/**
+ * Hide a location.
+ *
+ * @param {string} location The location to hide.
+ */
+const hideLocation = (location) => {
+  const hiddenLocations = getHiddenLocations();
+  if (hiddenLocations.includes(location)) {
+    return;
+  }
+
+  hiddenLocations.push(location);
+  saveTravelSetting('travel-window-hidden-locations', hiddenLocations);
+};
+
+/**
+ * Unhide a location.
+ *
+ * @param {string} location The location to unhide.
+ */
+const unhideLocation = (location) => {
+  const hiddenLocations = getHiddenLocations();
+  if (! hiddenLocations.includes(location)) {
+    return;
+  }
+
+  hiddenLocations.splice(hiddenLocations.indexOf(location), 1);
+  saveTravelSetting('travel-window-hidden-locations', hiddenLocations);
+};
+
+/**
+ * Check if a location is hidden.
+ *
+ * @param {string} location The location to check.
+ *
+ * @return {boolean} True if the location is hidden.
+ */
+const isLocationHidden = (location) => {
+  const hiddenLocations = getHiddenLocations();
+  return hiddenLocations.includes(location);
+};
+
+/**
+ * Open the travel window.
+ */
+const openTravelWindow = async () => {
+  debug('Opening travel window');
+  const regions = [
+    { type: 'gnawnia', name: 'Gnawnia' },
+    { type: 'valour', name: 'Valour' },
+    { type: 'whisker_woods', name: 'Whisker Woods' },
+    { type: 'burroughs', name: 'Burroughs' },
+    { type: 'furoma', name: 'Furoma' },
+    { type: 'bristle_woods', name: 'Bristle Woods' },
+    { type: 'tribal_isles', name: 'Tribal Isles' },
+    { type: 'varmint_valley', name: 'Varmint Valley' },
+    { type: 'desert', name: 'Sandtail Desert' },
+    { type: 'rodentia', name: 'Rodentia' },
+    { type: 'queso_canyon', name: 'Queso Canyon' },
+    { type: 'zokor_zone', name: 'Hollow Heights' },
+    { type: 'folklore_forest', name: 'Folklore Forest' },
+    { type: 'riftopia', name: 'Rift Plane' },
+  ];
+
+  environments = await getData('environments');
+  const eventEnvironments = await getData('environments-events');
+  environments = [...environments, ...eventEnvironments];
+  const environmentById = new Map(environments.map((environment) => [environment.id, environment]));
+
+  const currentEnvironment = environments.find((e) => e.id === getCurrentLocation());
+  const locationsToRemove = ['acolyte_realm'];
+
+  environments = environments.map((env) => {
+    if (! isUserTitleAtLeast(env.title)) {
+      locationsToRemove.push(env.id);
+    }
+
+    return env;
+  });
+
+  environments = environments.filter((env) => ! locationsToRemove.includes(env.id));
+
+  // Wrapper start.
+  let content = '<div class="mh-improved-travel-window greatWinterHuntGolemDestinationView"><div class="greatWinterHuntGolemDestinationView__content">';
+
+  content += `<div class="mh-improved-travel-window-search-input-wrapper">
+    <label for="mh-improved-travel-window-search-input" class="mh-improved-travel-window-search-label">Search:</label>
+      <input type="text" id="mh-improved-travel-window-search-input" class="mh-improved-travel-window-search-input" placeholder="Search locations">
+    </label>
+    <div class="mh-improved-travel-window-sort">
+      <button class="mousehuntActionButton mh-improved-travel-window-sort-name small" data-sorted-by-name="false">
+        <span>Sort by Name</span>
+      </button>
+    </div>
+  </div>`;
+
+  const hasTitles = false;
+
+  // Locations.
+  content += '<div class="greatWinterHuntGolemDestinationView__environmentsContainer"><div class="greatWinterHuntGolemDestinationView__environmentsScroller"><div class="greatWinterHuntGolemDestinationView__regionList">';
+
+  if (! hasTitles) {
+    content += `<div class="greatWinterHuntGolemDestinationView__regionGroup" data-region-type="all">
+      <div class="greatWinterHuntGolemDestinationView__regionEnvironments">`;
+  }
+
+  for (const region of regions) {
+    if (hasTitles) {
+      content += `<div class="greatWinterHuntGolemDestinationView__regionGroup" data-region-type="${region.type}">
+        <div class="greatWinterHuntGolemDestinationView__regionName">${region.name}</div>
+        <div class="greatWinterHuntGolemDestinationView__regionEnvironments">`;
+    }
+
+    const regionEnvironments = environments.filter((e) => e.region === region.type);
+    regionEnvironments.forEach((environment) => {
+      let envButtonClass = 'greatWinterHuntGolemDestinationView__environment';
+      if (currentEnvironment && currentEnvironment.id && currentEnvironment.id === environment.id) {
+        envButtonClass += ' greatWinterHuntGolemDestinationView__environment--active';
+      }
+
+      if (isLocationHidden(environment.id)) {
+        envButtonClass += ' mh-improved-travel-window-hidden';
+      }
+
+      if (environment.type === getCurrentLocation()) {
+        envButtonClass += ' greatWinterHuntGolemDestinationView__environment--current';
+      }
+
+      content += `<a class="${envButtonClass}" data-environment-type="${environment.id}" order="${environment.order}">
+        <div class="greatWinterHuntGolemDestinationView__environmentName">
+            <span>${environment.name}</span>
+        </div>
+        <div class="greatWinterHuntGolemDestinationView__environmentImage" style="background-image:url(${environment.headerImage});" data-environment-type="${environment.id}"></div>
+      </a>`;
+    });
+
+    if (hasTitles) {
+      content += '</div></div>';
+    }
+  }
+
+  if (! hasTitles) {
+    content += '</div></div>';
+  }
+
+  content += '</div></div></div>';
+
+  // wrapper end.
+  content += '</div>';
+
+  content += `<div class="mh-improved-travel-window-footer">
+    <div class="mh-improved-travel-window-edit mousehuntActionButton">
+      <span>Edit</span>
+    </div>
+    <div class="mh-improved-travel-window-description">
+      Click on a location to toggle the visibility.
+    </div>
+  </div>`;
+
+  content += '</div>';
+
+  const popup = createPopup({
+    id: 'mh-improved-travel-window',
+    title: '',
+    content,
+    className: 'mh-improved-travel-window-popup jsDialogFixed',
+    show: false,
+  });
+
+  popup.setOffsetHeight(0);
+  popup.setPersistentOffsetHeight(0);
+  popup.setIsModal(false);
+  popup.show();
+
+  const travelWindow = document.querySelector('.mh-improved-travel-window');
+  if (! travelWindow) {
+    return;
+  }
+
+  const editButton = document.querySelector('.mh-improved-travel-window-edit');
+  if (! editButton) {
+    return;
+  }
+
+  const editButtonSpan = editButton.querySelector('span');
+  if (! editButtonSpan) {
+    return;
+  }
+
+  const environmentButtons = document.querySelectorAll('.greatWinterHuntGolemDestinationView__environment');
+  if (! environmentButtons) {
+    return;
+  }
+
+  const sortNameButton = document.querySelector('.mh-improved-travel-window-sort-name');
+  const sortNameButtonText = document.querySelector('.mh-improved-travel-window-sort-name span');
+  if (sortNameButton && sortNameButtonText) {
+    sortNameButton.addEventListener('click', () => {
+      const isSortedByName = sortNameButton.getAttribute('data-sorted-by-name') === 'true';
+      if (isSortedByName) {
+        debug('Already sorted by name, toggling back to default order');
+        sortNameButton.setAttribute('data-sorted-by-name', 'false');
+        sortNameButtonText.textContent = 'Sort by Name';
+
+        // Sort by original order
+        const sortedButtons = [...environmentButtons].sort((a, b) => {
+          const envA = environmentById.get(a.getAttribute('data-environment-type'));
+          const envB = environmentById.get(b.getAttribute('data-environment-type'));
+          return (envA?.order || 0) - (envB?.order || 0);
+        });
+
+        const container = environmentButtons[0].parentElement;
+        sortedButtons.forEach((button) => container.append(button));
+      } else {
+        debug('Sorting environments by name');
+        sortNameButton.setAttribute('data-sorted-by-name', 'true');
+        sortNameButtonText.textContent = 'Sort by Default Order';
+
+        // Sort alphabetically by name
+        const sortedButtons = [...environmentButtons].sort((a, b) => {
+          const envA = environmentById.get(a.getAttribute('data-environment-type'));
+          const envB = environmentById.get(b.getAttribute('data-environment-type'));
+          return (envA?.name || '').localeCompare(envB?.name || '');
+        });
+
+        const container = environmentButtons[0].parentElement;
+        sortedButtons.forEach((button) => container.append(button));
+      }
+    });
+  }
+
+  editButton.addEventListener('click', () => {
+    isEditing = ! isEditing;
+    if (isEditing) {
+      travelWindow.classList.add('mh-improved-travel-window--editing');
+      editButtonSpan.textContent = 'Save';
+      editButton.classList.add('active');
+    } else {
+      travelWindow.classList.remove('mh-improved-travel-window--editing');
+      editButtonSpan.textContent = 'Edit';
+      editButton.classList.remove('active');
+    }
+  });
+
+  environmentButtons.forEach((button) => {
+    const environmentType = button.getAttribute('data-environment-type');
+
+    button.addEventListener('click', async () => {
+      if (isEditing) {
+        toggleLocation(environmentType);
+        button.classList.toggle('mh-improved-travel-window-hidden');
+      } else {
+        debug(`Traveling to ${environmentType}`);
+        await travelTo(environmentType);
+        popup.hide();
+      }
+    });
+  });
+
+  onDialogHide(() => {
+    isEditing = false;
+  });
+
+  const search = document.querySelector('.mh-improved-travel-window-search-input');
+  if (! search) {
+    return;
+  }
+
+  search.focus();
+
+  search.addEventListener('input', () => {
+    const value = search.value.trim().toLowerCase();
+
+    environmentButtons.forEach((button) => {
+      const environmentType = button.getAttribute('data-environment-type');
+      const environment = environmentById.get(environmentType);
+
+      button.style.display = environment.name.toLowerCase().includes(value) ? 'block' : 'none';
+    });
+  });
+
+  // if they hit enter, travel to the first visible location.
+  search.addEventListener('keydown', (e) => {
+    if (e.key === 'Enter') {
+      const visibleButton = document.querySelector('.greatWinterHuntGolemDestinationView__environment[style="display: block;"]');
+      if (visibleButton && ! visibleButton.classList.contains('greatWinterHuntGolemDestinationView__environment--active')) {
+        visibleButton.click();
+      }
+    }
+  });
+};
+
+let isEditing = false;
+let environments = [];
+
+/**
+ * Add the travel window to the menu.
+ */
+const makeMenuItem = () => {
+  addSubmenuItem({
+    id: 'mh-improved-travel-window',
+    menu: 'travel',
+    label: 'Travel Window',
+    icon: 'https://i.mouse.rip/icons/tiles.png',
+    callback: () => openTravelWindow(),
+  });
+};
+
+/**
+ * Add a listener to the environment icon to open the travel window.
+ */
+const addEnvironmentIconListener = () => {
+  const environmentIcon = document.querySelector('.mousehuntHud-environmentIcon');
+  if (! environmentIcon) {
+    return;
+  }
+
+  environmentIcon.classList.add('mh-improved-travel-window-environment-icon');
+  environmentIcon.title = 'Open Travel Window';
+
+  environmentIcon.addEventListener('click', () => {
+    openTravelWindow();
+  });
+};
+
+/**
+ * Initialize the module.
+ */
+export default async () => {
+  addStyles(styles, 'better-travel-travel-window');
+  makeMenuItem();
+
+  if (getSetting('better-travel.travel-window-environment-icon', true)) {
+    addEnvironmentIconListener();
+  }
+
+  onEvent('mh-improved-open-travel-window', openTravelWindow);
+
+  environments = await getData('environments');
+};

package/src/modules/better-travel/modules/travel-window/styles.css

@@ -0,0 +1,142 @@
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__content {
+  flex-direction: column;
+  align-items: center;
+  background-color: transparent;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environmentsScroller {
+  height: auto;
+  min-height: 425px;
+  max-height: 650px;
+  padding: 0 0 10px 5px;
+  margin-right: -5px;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__regionEnvironments {
+  gap: 15px 6px;
+  justify-content: space-evenly;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__regionsContainer {
+  display: none;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__regionName {
+  margin: 10px 0;
+  font-size: 16px;
+  text-align: center;
+  border: none;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environment {
+  width: 150px;
+  overflow: hidden;
+  border: 1px solid #b4a481;
+  box-shadow: 0 2px 2px 0 #7e7e7e;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__regionGroup {
+  margin: 0;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environmentName {
+  position: absolute;
+  right: 0;
+  left: 0;
+  z-index: 2;
+  height: 20px;
+  background-color: rgb(255 255 255 / 90%);
+  border-radius: 0;
+  transition: all 0.2s ease-in-out;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environmentName span {
+  padding: 5px;
+  text-align: center;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environmentImage {
+  border-radius: 0;
+  transition: all 0.2s ease-in-out;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environment:hover .greatWinterHuntGolemDestinationView__environmentImage,
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environment:focus .greatWinterHuntGolemDestinationView__environmentImage {
+  background-position-y: 30%;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environment:hover .greatWinterHuntGolemDestinationView__environmentName,
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environment:focus .greatWinterHuntGolemDestinationView__environmentName {
+  background-color: #fff;
+}
+
+.mh-improved-travel-window .greatWinterHuntGolemDestinationView__environment[data-environment-type="train_station"] .greatWinterHuntGolemDestinationView__environmentName span {
+  font-size: 10px;
+}
+
+.mh-improved-travel-window-footer {
+  position: absolute;
+  bottom: 20px;
+  display: flex;
+  gap: 10px;
+  align-items: center;
+  width: 330px;
+}
+
+.mh-improved-travel-window-edit {
+  padding: 0 15px;
+  font-weight: 400;
+  line-height: 24px;
+}
+
+.mh-improved-travel-window--editing {
+  border-radius: 5px;
+  outline: 3px solid #f37c7c;
+}
+
+.mh-improved-travel-window-description,
+.mh-improved-travel-window-hidden {
+  display: none;
+}
+
+.mh-improved-travel-window--editing .mh-improved-travel-window-hidden {
+  display: block;
+  filter: grayscale(1);
+  opacity: 0.4;
+}
+
+.mh-improved-travel-window--editing .mh-improved-travel-window-description {
+  display: inline-block;
+}
+
+.mh-improved-travel-window-environment-icon {
+  cursor: pointer;
+}
+
+.mh-improved-travel-window-search-input-wrapper {
+  display: flex;
+  gap: 10px;
+  align-items: center;
+  margin-bottom: 15px;
+}
+
+.mh-improved-travel-window-search-input,
+input.mh-improved-travel-window-search-input[type="text"] {
+  width: auto;
+  min-width: 350px;
+  padding: 10px;
+  font-size: 14px;
+  border: 1px solid #333;
+}
+
+.mh-improved-travel-window-popup .greatWinterHuntGolemDestinationView__environment.greatWinterHuntGolemDestinationView__environment--active {
+  opacity: 0.4;
+}
+
+.mh-dark #overlayPopup.mh-improved-travel-window-popup .content {
+  background-color: var(--d-bg);
+}
+
+.mh-improved-travel-window-sort-name {
+  width: 150px;
+}