mousehunt-improved 0.97.1

package/CONTRIBUTING.md

@@ -0,0 +1,317 @@
+# Contributing to MouseHunt Improved
+
+Thank you for your interest in contributing to MouseHunt Improved! We welcome contributions from the community to make our project even better.
+
+## Table of Contents
+
+- [Contributing to MouseHunt Improved](#contributing-to-mousehunt-improved)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+    - [Step 1: Fork](#step-1-fork)
+    - [Step 2: Install Dependencies](#step-2-install-dependencies)
+    - [Step 3: Branch](#step-3-branch)
+    - [Step 4: Make Changes](#step-4-make-changes)
+    - [Step 5: Commit and Push](#step-5-commit-and-push)
+    - [Step 6: Create a Pull Request](#step-6-create-a-pull-request)
+  - [Project Structure](#project-structure)
+  - [How to add a new module](#how-to-add-a-new-module)
+    - [Importing utilities](#importing-utilities)
+    - [Adding settings to a module](#adding-settings-to-a-module)
+  - [Code Style](#code-style)
+  - [Building](#building)
+  - [Testing](#testing)
+  - [Data files](#data-files)
+  - [Adding a map to the map sorter/categorizer](#adding-a-map-to-the-map-sortercategorizer)
+  - [Building an extension or userscript that interacts with MouseHunt Improved](#building-an-extension-or-userscript-that-interacts-with-mousehunt-improved)
+    - [Example Userscript](#example-userscript)
+
+## Getting Started
+
+### Step 1: Fork
+
+Fork the project [on GitHub](https://github.com/MHCommunity/mousehunt-improved) and clone your fork
+locally.
+
+```sh
+git clone git@github.com:<your-username>/mousehunt-improved.git
+cd mousehunt-improved
+git remote add upstream https://github.com/MHCommunity/mousehunt-improved.git
+git fetch upstream
+```
+
+### Step 2: Install Dependencies
+
+MouseHunt Improved uses [Bun](https://bun.sh/) to manage dependencies, but if you prefer to use `npm` you can use that instead, just replace `bun` with `npm` in the commands below.
+
+```sh
+bun install
+```
+
+### Step 3: Branch
+
+Create a branch and start hacking:
+
+```sh
+git checkout -b my-branch
+```
+
+### Step 4: Make Changes
+
+Check out the [project structure](#project-structure) section for information on how the project is structured and [building](#building) for information on how to build the project and test your changes.
+
+### Step 5: Commit and Push
+
+```sh
+git commit -m "Add some feature"
+git push origin my-branch
+```
+
+### Step 6: Create a Pull Request
+
+Open a [pull request](https://github.com/MHCommunity/mousehunt-improved/pulls) with a clear title and description of your changes.
+ion of your changes.
+
+## Project Structure
+
+The project is structured as follows:
+
+- `src/data/` Data files, such as the image upscaling mapping file.
+- `src/extension/` Files for building the extensions, such as the manifest files.
+- `src/modules/` The code for all the different modules.
+- `src/utils/` Utility functions used by the modules.
+- `src/index.js` The entry point for the extension. This handles module registration and loading.
+
+## How to add a new module
+
+1. Create a new folder in `src/modules/` with the name of your module. Inside this folder, create an `index.js` file that exports the expected module properties, for example:
+
+```javascript
+const init = async () => {
+  // Your module code here.
+};
+
+/**
+ * Initialize the module.
+ */
+export default {
+  id: 'my-module',
+  name: 'My Module',
+  description: 'This is my module description.',
+  type: 'feature', // or 'element-hiding', 'advanced', or 'beta'.
+  default: false, // Whether the module should be enabled by default.
+  load: init
+};
+```
+
+### Importing utilities
+
+All of the utility functions are in `src/utils/`. They are broken up into different files, but you can import any of them like this:
+
+```javascript
+import { addStyles, getCurrentLocation } from '@utils';
+```
+
+### Adding settings to a module
+
+Settings for a module are defined by passing a function that returns an array of settings objects to the module. A simple example of a toggle setting would look like this:
+
+```javascript
+const settings = () => {
+  return [
+    {
+      id: 'my-module.my-setting',
+      title: 'Enable an option for my module',
+      description: 'This is a description of the setting.', // Optional, usually not needed.
+      default: false,
+    }
+  ];
+};
+
+/**
+ * Initialize the module.
+ */
+export default {
+  id: 'my-module',
+  name: 'My Module',
+  description: 'This is my module description.',
+  type: 'feature',
+  default: false,
+  load: init,
+  settings
+};
+```
+
+There are a variety of different setting types available, such as text inputs, dropdowns, and more. Check out the existing modules for examples of how to use these.
+
+## Code Style
+
+The code style is enforced using [ESLint](https://eslint.org/) and [Stylelint](https://stylelint.io/).
+
+To lint your code, run `bun run lint`. This will run both ESLint and Stylelint. To automatically fix any issues, run `bun run lint:fix`.
+
+There are also individual commands for more specific linting:
+
+- `bun run lint:js` to lint JavaScript files.
+- `bun run lint:js:fix` to automatically fix any issues in JavaScript files.
+- `bun run lint:css` to lint CSS files.
+- `bun run lint:css:fix` to automatically fix any issues in CSS files.
+- `bun run lint:json` to lint JSON files.
+- `bun run lint:json:fix` to automatically fix any issues in JSON files.
+- `bun run lint:md` to lint Markdown files.
+- `bun run lint:md:fix` to automatically fix any issues in Markdown files.
+
+## Building
+
+You can build a Chrome extension, Firefox extension, or userscript.
+
+- `bun run build` to build the extensions and userscript.
+- `bun run build:extension` to just build the extensions.
+- `bun run build:extension:chrome` to just build the Chrome extension.
+- `bun run build:extension:firefox` to just build the Firefox extension.
+- `bun run build:userscript` to just build the userscript.
+
+After building, you will find the following files in the `dist/` folder.
+
+- `dist/chrome/` The Chrome extension.
+- `dist/firefox/` The Firefox extension. You can load this into Firefox by going to `about:debugging` and clicking 'Load Temporary Add-on' and selecting the `manifest.json` file.
+- `dist/archive.zip` Zip file containing the non-minified code for uploading to the Firefox Add-ons site.
+- `dist/chrome.zip` Zip file for uploading to the Chrome Web Store.
+- `dist/firefox.zip` Zip file for uploading to the Firefox Add-ons site.
+- `dist/mousehunt-improved.user.js` The userscript file.
+
+## Testing
+
+To test your changes, you can load the local version of the extension into your browser.
+
+For Chrome, go to `chrome://extensions` and enable 'Developer mode' in the top right corner.
+Then click 'Load unpacked' and select the `dist/chrome` folder.
+
+For Firefox, go to `about:debugging` and click 'Load Temporary Add-on' and select the `manifest.json` file in the `dist/firefox` folder.
+
+For the userscript, you can use [Violentmonkey](https://violentmonkey.github.io/) to install it in your browser. You can then use the 'Track local file changes' option to develop locally.
+
+_For Chrome or Firefox you can reload the extension by clicking the reload button on the extension card if your aren't seeing your changes._
+
+## Data files
+
+The `src/data/` folder contains JSON data files that are used by the extension and may need to be updated from time to time.
+
+- `backgrounds.json` - Used by Custom Background and Custom HUD to provide a list of available backgrounds.
+  - The format is an array of objects with the following properties:
+    - `id` - A unique ID for the background.
+    - `name` - The name of the background.
+    - `css` - The CSS value to use for the background. This should be a valid CSS `background` value.
+  - Examples:
+    - `{ "id": "my-background", "name": "My Background", "css": "url(https://example.com/background.png) top center / 200px" }`
+    - `{ "id": "a-gradient", "name": "A Gradient", "css": "linear-gradient(90deg, #ff0000, #00ff00)" }`
+- `journal-item-colors.json` - Used by Better Journal's 'Unique item colors' setting to color code journal items.
+- `journal-environment-mapping.json` - Used by Journal Changer to map environments to the corresponding journal theme.
+- `journal-events.json` - Used by Journal Changer to categorize the event journal themes.
+- `library-assignments.json` - Used by Better Quests to enhance the Library Assignments popup.
+- `magic-essence-potions.json` - Used by Better Inventory to show warnings on potions that are a bad use of Magic Essence.
+- `map-groups.json` - Used by Better Maps to categorize mice on the Sorted map tab.
+- `ultimate-checkmark.json` - Used by Ultimate Checkmark to populate the list of items for each category.
+- `update-summary.json` - Used to provide a summary of the changes with each update.
+
+## Adding a map to the map sorter/categorizer
+
+To add a new map to the list of automatically sorted/categorized maps, you need to add it to `src/data/map-groups.json`. The format is as follows:
+
+```json
+{
+  "<map-id>": {
+    "categories": [
+      {
+        "name": "My Category",
+        "id": "my-category",
+        "icon": "https://example.com/icon.png",
+        "color": "#bc4ce3",
+        "mice": [
+          "mouse-type",
+          "another-mouse-type",
+          {
+            "mouse": "a-mouse-with-a-subcategory",
+            "subcategory": "my-subcategory"
+          }
+        ]
+      },
+      {
+        "name": "Another Category",
+        "id": "..."
+      }
+    ],
+    "subcategories": [
+      {
+        "id": "my-subcategory",
+        "name": "My Subcategory",
+      }
+    ]
+  }
+}
+```
+
+The `categories` array contains the categories that the map should be sorted into. Each category has the following properties:
+
+- `name` - The name of the category.
+- `id` - The ID of the category. This should be unique and can only contain lowercase letters, numbers, and dashes.
+- `icon` - The URL of the icon to use for the category.
+- `color` - A hex color code to use for the category.
+- `mice` - An array of mice that should be sorted into this category. Each mouse can either be a string with the mouse type, or an object with the following properties:
+  - `mouse` - The mouse type.
+  - `subcategory` - The ID of the subcategory to sort the mouse into.
+
+The `subcategories` array is only needed if you have mice that should be sorted into a subcategory. The subcategory object just needs `id` and `name` properties.
+
+> [!TIP]
+> Running `bun run fix-map-groups` will go through the mice in the map groups file and replace any mouse names with their mouse types, so you can use the full names like "Mutated Behemoth Mouse" in the file and then run this command to replace them with the mouse types like "mutated_behemoth".
+
+## Building an extension or userscript that interacts with MouseHunt Improved
+
+If you want to build an extension or userscript that is compatible with or interacts with MouseHunt Improved, it is pretty simple to do so. The extension adds `mhui` (containing information about what modules are loaded) and `mhutils` (a collection of utility functions) to the `app` object in the global scope. You can access these from your extension or userscript.
+
+This is how you can check if MouseHunt Improved is loaded and use the utilities:
+
+```javascript
+// Listen for the extension to load.
+document.addEventListener('mh-improved-loaded', () => {
+  // `app.mhui` contains information about what modules are loaded.
+  // `window.app.mhutils` contains utility functions that you can use.
+
+  // For example, to do something only if the "Better Maps" module is loaded:
+  if (app.mhui.modules.includes('better-maps')) {
+    console.log('Better Maps module is loaded!');
+  }
+
+  // You can also leverage the utility functions provided by MouseHunt Improved.
+  const currentLocation = app.mhutils.getCurrentLocation();
+  console.log('Current location:', currentLocation);
+});
+```
+
+### Example Userscript
+
+```javascript
+// ==UserScript==
+// @name         My MouseHunt Userscript
+// @match        https://www.mousehuntgame.com/*
+// ==/UserScript==
+
+(function() {
+  'use strict';
+
+  // When the user navigates to the scoreboards page, show a message.
+  // This is just an example of how to use the mhutils functions.
+  // You can use any of the functions available in mhutils.
+  document.addEventListener('mh-improved-loaded', () => {
+    app.mhutils.onNavigation(() => {
+      app.mhutils.showHornMessage({
+        title: "Don't forget!",
+        text: "You're always #1!",
+        button: 'Got it!',
+        dismiss: 5000,
+        color: 'pink',
+      });
+    }, { page: 'scoreboards' });
+  });
+})();
+```

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Brad Parbs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,176 @@
+# 🐭️ MouseHunt Improved
+
+[![Add to Chrome](https://img.shields.io/badge/Add_to_Chrome-4c8bf5?style=plastic&logo=googlechrome&logoColor=white&link=https%3A%2F%2Fchromewebstore.google.com%2Fdetail%2Fmousehunt-improved%2Ffgjkidgknmkhnbeobehlfabjbignhkhm)](https://chrome.google.com/webstore/detail/mousehunt-improved/fgjkidgknmkhnbeobehlfabjbignhkhm) [![Add to Firefox](https://img.shields.io/badge/Add_to_Firefox-ff7139?style=plastic&logo=firefoxbrowser&logoColor=white&link=https%3A%2F%2Faddons.mozilla.org%2Fen-US%2Ffirefox%2Faddon%2Fmousehunt-improved%2F)](https://addons.mozilla.org/en-US/firefox/addon/mousehunt-improved/)
+
+Enhance your [MouseHunt](https://mousehuntgame.com) experience with a variety of improvements and features. Each feature can be enabled or disabled individually to suit your preferences.
+
+## Installation
+
+- **Chrome**: [Install from Chrome Web Store](https://chrome.google.com/webstore/detail/mousehunt-improved/fgjkidgknmkhnbeobehlfabjbignhkhm)
+- **Firefox**: [Install from Mozilla Addons](https://addons.mozilla.org/en-US/firefox/addon/mousehunt-improved/)
+- **Userscript**: [Install from Greasyfork](https://greasyfork.org/en/scripts/465139-mousehunt-improved) for mobile or unsupported browsers.
+
+## ⭐️ Features
+
+- **[Better UI](docs/better-ui.md)**: Update the interface with UI and style changes.
+- **[Better Gifts](docs/better-gifts.md)**: Quickly accept and return all your gifts, and pick random friends to send to.
+- **[Better Inventory](docs/better-inventory.md)**: Update the inventory layout and styling.
+- **[Better Items](docs/better-items.md)**: Update the styles, show drop rates, and provide links to MHCT and MH Wiki.
+- **[Better Journal](docs/better-journal.md)**: Modify the journal text, layout, and styling.
+- **[Better King's Reward](docs/better-kings-reward.md)**: Update the style of the King's Reward and automatically close the success message.
+- **[Better Maps](docs/better-maps.md)**: Add features to maps such as updated styles, attraction rates, a sorted tab categorizing various maps, and displaying more information on the various tabs.
+- **[Better Marketplace](docs/better-marketplace.md)**: Update the styles, and add small features like toggling between "Buying" and "Selling" by clicking the text.
+- **[Better Mice](docs/better-mice.md)**: Add attraction rate stats and links to MH Wiki and MHCT to mouse dialogs. Sort the mouse stats pages and add the King's Crown tab to the mouse pages.
+- **[Better Quests](docs/better-quests.md)**: Allow opening the assignments popup anywhere, improve the UI of the quests tab, and add a helper for the M400 assignments.
+- **[Better Send Supplies](docs/better-send-supplies.md)**: Add pinned items, search, and sorting to the Send Supplies page.
+- **[Better Shops](docs/better-shops.md)**: Update the shop layout and appearance, minimize owned items with an inventory limit of 1, and more.
+- **[Better Tournaments](docs/better-tournaments.md)**: Update the Tournaments UI to show information on hover and make various small interface tweaks.
+- **[Better Travel](docs/better-travel.md)**: Add locations in the current region to the Travel dropdown menu, include a "Simple Travel" tab with a grid of locations, offer an optional alphabetized list, and indicate where the Relic Hunter is.
+- **[Big Timer](docs/big-timer.md)**: Click the timer to toggle between sizes.
+- **[Catch Rate Estimator & Minlucks](docs/catch-rate-estimator-and-minlucks.md)**: Display Minluck and catch rate estimates on the Camp page.
+- **[Codex at Bottom](docs/codex-at-bottom.md)**: Move the codex to the bottom of the trap view.
+- **[Copy ID Button](docs/copy-id-button.md)**: Hover over your profile picture in the HUD for a quick "Copy ID to clipboard" button.
+- **[Dark Mode](docs/dark-mode.md)**: Enable the dark mode.
+- **[Dark Mode Updates & Tweaks](docs/dark-mode-updates-and-tweaks.md)**: Updates and tweaks to the MHCT/Dark Mode Extension dark mode.
+- **[Data Exporters](docs/data-exporters.md)**: Export data from the game.
+- **[Delayed Menus](docs/delayed-menus.md)**: Add a short delay to the menu dropdowns to prevent accidental clicks.
+- **[Delayed Tooltips](docs/delayed-tooltips.md)**: Delay the display of tooltips when you mouse over something. Hold down the shift key to display tooltips immediately.
+- **[Emotes](docs/emotes.md)**: Replace Discord-style emotes on corkboards (e.g., :jerry:) with actual images in map and profile corkboard messages.
+- **[Favorite Setups](docs/favorite-setups.md)**: Save your favorite setups and arm them with a single click.
+- **[Fixes](docs/fixes.md)**: Fix various bugs and issues in the game.
+- **[FLRT Helper](docs/flrt-helper.md)**: Add a "Return to Maptain" button when opening a chest from a map, allowing you to choose which tradable items to send directly to the Maptain.
+- **[Hover Profiles](docs/hover-profiles.md)**: Hover over a name to see a mini profile popup.
+- **[Image Upscaling and Transparency](docs/image-upscaling-and-transparency.md)**: Update all images to use higher resolution versions with transparent backgrounds.
+- **[Inline Wiki](docs/inline-wiki.md)**: Clicking "Wiki" in the menu loads it right on the page, rather than opening a new tab.
+- **[Inventory - Lock and Hide](docs/inventory-lock-and-hide.md)**: Lock and hide items in your inventory. Also hide items in the trap browser.
+- **[Inventory - Open All](docs/inventory-open-all.md)**: Adds an "Open All" button to convertible items in your inventory.
+- **[Inventory - Only Open Multiple](docs/inventory-only-open-multiple.md)**: Lock opening items unless you have more than one.
+- **[Inventory - Open All but One](docs/inventory-open-all-but-one.md)**: Adds an "Open All But One" button to convertible items in your inventory.
+- **[Journal Theme Changer](docs/journal-theme-changer.md)**: Randomize your journal theme, randomize it daily, or change it based on your location.
+- **[Keyboard Shortcuts](docs/keyboard-shortcuts.md)**: Press "?" to see and edit keyboard shortcuts.
+- **[Larger Codices](docs/larger-codices.md)**: Show larger codex images in the trap selector.
+- **[Larger Skin Images](docs/larger-skin-images.md)**: Show larger skin images in the trap selector.
+- **[Legacy HUD](docs/legacy-hud.md)**: Enable the legacy HUD or make tweaks to it.
+- **[Location Catch Stats](docs/location-catch-stats.md)**: Add a "Location Catch Stats" option to the Mice menu to see your catch stats for the current location.
+- **[Location Dashboard](docs/location-dashboard.md)**: View location HUD information in a dashboard available in the top dropdown menu.
+- **[Lucky Golden Shield Duration & Reminder](docs/lucky-golden-shield-duration-and-reminder.md)**: Show your LGS duration in the HUD and warn you when it’s about to expire.
+- **[Metric Units](docs/metric-units.md)**: Use metric units instead of imperial units.
+- **[Paste Hunter ID](docs/paste-hunter-id.md)**: Copy a Hunter ID to your clipboard and press Ctrl/Cmd+V anywhere to go directly to that hunter’s profile.
+- **[Prestige Base Stats](docs/prestige-base-stats.md)**: Show the correct stats for the Prestige Base in the base selector.
+- **[Printing Press Paper Counter](docs/printing-press-paper-counter.md)**: Show the number of Prolific Printing Papers you have for the Printing Press bases.
+- **[Quick Filters and Sort](docs/quick-filters-and-sort.md)**: Add quick filters and sorting to the trap, base, charm, and cheese selectors.
+- **[Quick Send Supplies](docs/quick-send-supplies.md)**: Hover or click on Send Supplies to quickly send any quantity of a configured item.
+- **[Replace Favicon](docs/replace-favicon.md)**: Replace the favicon with a more fitting one.
+- **[Scoreboard Search on Profiles](docs/scoreboard-search-on-profiles.md)**: Easily search for a friend on the scoreboard from their profile.
+- **[Shield Goes to Camp](docs/shield-goes-to-camp.md)**: Click the shield to go to the Camp page if you’re not already there, otherwise, it will take you to your Hunter Profile.
+- **[Show Adventure Book](docs/show-adventure-book.md)**: Add an Adventure Book button to the Kingdom dropdown menu.
+- **[Show Auras](docs/show-auras.md)**: Show auras and their expiry time below the trap stats.
+- **[SSDB Toothlet Counter](docs/ssdb-toothlet-counter.md)**: Show the number of toothlets you have when SSDB is equipped.
+- **[Taller Windows](docs/taller-windows.md)**: Make popup and dialog windows taller.
+- **[TEM Crowns](docs/tem-crowns.md)**: Add crowns and catches to the Trap Effectiveness Meter.
+- **[Ultimate Checkmark](docs/ultimate-checkmark.md)**: Add more items to collect on your Hunter profile.
+- **[Unique Loot Count](docs/unique-loot-count.md)**: Show the number of unique loot items in the progress log.
+- **[Wisdom in Stat Bar](docs/wisdom-in-stat-bar.md)**: Show wisdom in the stat bar.
+
+### 🎨 Customization
+
+- **[Custom Background](docs/custom-background.md)**: Change the background to an event background, color, or gradient.
+- **[Custom Camp Background](docs/custom-camp-background.md)**: Set a custom background for the Camp page.
+- **[Custom Horn](docs/custom-horn.md)**: Customize the horn with event or color themes.
+- **[Custom HUD](docs/custom-hud.md)**: Change the marbled HUD background.
+- **[Custom Shield](docs/custom-shield.md)**: Change the shield to an event shield, color, title shield, or silly shield.
+- **[Custom Styles](docs/custom-styles.md)**: Apply custom CSS.
+
+### 🛑 Element Hiding
+
+- **[Adblock](docs/adblock.md)**: Hide advertisements for Feedback Friday, mobile apps, news ticker, etc.
+- **[Hide Codices](docs/hide-codices.md)**: Hide the codices on the trap selector.
+- **[Hide Daily Draw](docs/hide-daily-draw.md)**: Hide the Daily Draw inbox tab and notifications.
+- **[Hide Daily Reward Popup](docs/hide-daily-reward-popup.md)**: Automatically hide the daily reward popup.
+- **[Hide Footer](docs/hide-footer.md)**: Hide the footer.
+- **[Hide News Ticker](docs/hide-news-ticker.md)**: Hide the news ticker in the header.
+- **[Hide Share Buttons](docs/hide-share-buttons.md)**: Hide the share buttons.
+- **[Hide Sidebar](docs/hide-sidebar.md)**: Hide the sidebar and add a "Sidebar" dropdown in the top menu.
+- **[Journal Privacy](docs/journal-privacy.md)**: Hide player names in the journal. Good for screenshots that maintain privacy.
+
+### 📍 Location HUDs
+
+- Event Locations
+- Acolyte Realm
+- Afterword Acres
+- Balack's Cove
+- Bazaar
+- Bountiful Beanstalk
+- Bristle Woods Rift
+- Burroughs Rift
+- Calm Clearing
+- Cape Clawed
+- Catacombs
+- Claw Shot City
+- Conclusion Cliffs
+- Derr Dunes
+- Dojo
+- Dracano
+- Draconic Depths
+- Elub Shore
+- Epilogue Falls
+- Event Locations
+- Fiery Warpath
+- Floating Islands
+- Forbidden Grove
+- Foreword Farm
+- Fort Rox
+- Fungal Cavern
+- Furoma Rift
+- Gnawnia Express Station
+- Gnawnia Rift
+- Great Gnarled Tree
+- Harbour
+- Iceberg
+- Jungle of Dread
+- King's Arms
+- King's Gauntlet
+- Laboratory
+- Labyrinth
+- Lagoon
+- Meditation Room
+- Mountain
+- Mousoleum
+- Moussu Picchu
+- Muridae Market
+- Nerg Plains
+- Pinnacle Chamber
+- Prologue Pond
+- Region: Living Garden
+- Region: Queso Canyon
+- School of Sorcery
+- Seasonal Garden
+- Slushy Shoreline
+- S.S. Huntington IV
+- Sunken City
+- Table of Contents
+- Tournament Hall
+- Town of Digby
+- Town of Gnawnia
+- Toxic Spill
+- Valour Rift
+- Whisker Woods Rift
+- Windmill
+- Zokor
+- Zugzwang's Tower
+
+## 🗑️ Uninstalling Userscripts
+
+Refer to [Superseded Userscripts](https://github.com/MHCommunity/mousehunt-improved/wiki/Superseded-Userscripts) on the GitHub Wiki for a list of userscripts you no longer need after installing MouseHunt Improved.
+
+## 📝 Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for detailed updates and changes.
+
+## 🤝 Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on contributing to this project.
+
+## 📜 License
+
+Licensed under the MIT License. [LICENSE.md](LICENSE.md) details the terms and conditions.