🐭️ MouseHunt Guides, Tools, and Resources - mouse.rip

📖 About

This is the repository powering mouse.rip.

🚀 Getting Started

First, clone the project locally:

  git clone https://github.com/MHCommunity/mouse.rip.git mouse-rip

Next, change to the project directory

  cd mouse-rip

Install the dependencies (You'll need Bun for this step):

  bun install

Finally, run the development server:

  bun run dev

This will make your site accessible at http://localhost:3000, and will automatically reload when you make changes.

When you're finished, run lint, formatting, and TypeScript checks:

  bun run check

Use bun run format to apply formatting and bun run build to verify production page generation.

If you're happy with your changes, you can submit a Pull Request!

🗒️ Updating the content

The items on the site are populated via the contents in the src/data directory.

Run bun run update:data to refresh the generated game data. The updater validates the responses before replacing the existing snapshots. Item contents, drop rates, and mouse attraction and map data are included in the generated pages; marketplace prices are fetched live in the browser.

Run bun run update:images to download images into the ignored static-mouse-rip/images directory. bun run update refreshes the data first, then downloads images. Publishing those images to i.mouse.rip is a separate step.

💬 Discussion & Feedback

If you'd like to suggest a change, you can open an issue or a pull request. If you aren't comfortable or familiar with GitHub, or if you have any questions, you can chat in the #community-tools channel on the MouseHunt Community Discord server.

📝 License

This project is licensed under the MIT License.