kuhmann/CMHG

โ˜… 0Forks 0MDXGitHub โ†—Compare

README

๐Ÿญ Community MouseHunt Guide

A comprehensive, community-driven guide for the MouseHunt game, built with modern web technologies and organized by rank progression.

๐Ÿ“– About

This guide provides a step-by-step walkthrough for MouseHunt, reflecting the latest changes that older guides often miss. It focuses on practical strategy and decision-making rather than just raw data. For hard facts like crafting recipes, loot tables, and stats, players are directed to the official wiki.

โœจ Features

  • Rank-Based Organization: Content organized by MouseHunt ranks from Novice to Fabled
  • Modern Web Interface: Built with Astro for fast, static site generation
  • Responsive Design: Works seamlessly on desktop and mobile devices
  • Dark/Light Theme: Automatic theme switching with system preference detection
  • Search Functionality: Full-text search powered by Pagefind
  • Accessibility: Built with accessibility best practices in mind

๐Ÿ—๏ธ Project Structure

src/
โ”œโ”€โ”€ content/guide/           # Guide content organized by rank
โ”‚   โ”œโ”€โ”€ 01-Fabled/          # Highest rank guides
โ”‚   โ”œโ”€โ”€ 02-Sage/
โ”‚   โ”œโ”€โ”€ 03-Elder/
โ”‚   โ”œโ”€โ”€ 04-Viceroy/
โ”‚   โ”œโ”€โ”€ 05-Archduke/
โ”‚   โ”œโ”€โ”€ 06-Grand Duke/
โ”‚   โ”œโ”€โ”€ 07-Duke/
โ”‚   โ”œโ”€โ”€ 08-Count/
โ”‚   โ”œโ”€โ”€ 09-Baron/
โ”‚   โ”œโ”€โ”€ 10-Lord/
โ”‚   โ”œโ”€โ”€ 11-Knight/
โ”‚   โ”œโ”€โ”€ 12-Hero/
โ”‚   โ”œโ”€โ”€ 13-Legendary/
โ”‚   โ”œโ”€โ”€ 14-Grandmaster/
โ”‚   โ”œโ”€โ”€ 15-Master/
โ”‚   โ”œโ”€โ”€ 16-Journeyman/
โ”‚   โ”œโ”€โ”€ 17-Initiate/
โ”‚   โ”œโ”€โ”€ 18-Apprentice/
โ”‚   โ”œโ”€โ”€ 19-Recruit/
โ”‚   โ””โ”€โ”€ 20-Novice/          # Lowest rank guides
โ”œโ”€โ”€ components/              # Reusable UI components
โ”œโ”€โ”€ layouts/                 # Page layout templates
โ”œโ”€โ”€ pages/                   # Route definitions
โ””โ”€โ”€ styles/                  # Global CSS and styling

๐ŸŽฏ Rank Progression

The guide follows the official MouseHunt rank progression:

  1. Novice โ†’ Meadow
  2. Recruit โ†’ Town of Gnawnia
  3. Apprentice โ†’ Windmill
  4. Initiate โ†’ Harbour
  5. Journeyman โ†’ Mountain
  6. Master โ†’ Laboratory, Mousoleum, Calm Clearing, Great Gnarled Tree
  7. Grandmaster โ†’ Training Grounds, Bazaar, Dojo, Meditation Room, Pinnacle Chamber, Lagoon
  8. Legendary โ†’ SSIV, Cape Clawed, Nerg Plains, Derr Dunes, Elub Shore
  9. Hero โ†’ Jungle of Dread, Catacombs, Forbidden Grove, Acolyte Realm
  10. Knight โ†’ Dracano
  11. Lord/Lady โ†’ Seasonal Garden, Zugzwang's Tower, Slushy Shoreline, Iceberg, Claw Shot City
  12. Baron/Baroness โ†’ Fort Rox, Fiery Warpath, Muridae Market, Living Garden
  13. Count/Countess โ†’ Queso River, Queso Geyser, Gnawnia Rift, Sunken City
  14. Duke/Duchess โ†’ Fungal Cavern, Labyrinth, Zokor, Burroughs Rift, Whisker Woods Rift
  15. Grand Duke/Duchess โ†’ Moussu Picchu, Furoma Rift, Bristle Woods Rift
  16. Archduke/Archduchess โ†’ Floating Islands, Foreward Farm, Prologue Pond, Table of Contents, Valour Rift
  17. Viceroy+ โ†’ Bountiful Beanstalk, School of Sorcery, Draconic Depths, Afterword Arces, Epilogue Falls

๐Ÿš€ Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

  1. Clone the repository:
git clone https://github.com/kuhmann/CMHG.git
cd cd CMHG
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev
  1. Open http://localhost:4321 in your browser

๐Ÿ“ Adding Content

Creating a New Guide Post

  1. Navigate to the appropriate rank folder in src/content/guide/
  2. Create a new .mdx file with the following frontmatter:
---
title: "Your Guide Title"
description: "Brief description of the guide"
date: "2024-01-15"
rank: "Apprentice"  # Must match one of the defined ranks
area: "Forest"      # The hunting area this guide covers
order: 1            # Optional: for custom ordering within areas
---

Content Guidelines

  • Use clear, concise language
  • Focus on practical strategies and decision-making
  • Include relevant tips and warnings using the Callout component
  • Structure content with proper headings (H2, H3, etc.)
  • Keep guides focused on specific areas or mechanics

๐Ÿ› ๏ธ Technology Stack

  • Framework: Astro - Static site generator
  • Styling: Tailwind CSS - Utility-first CSS framework
  • Search: Pagefind - Static search library
  • Fonts: Geist Sans - Modern, readable typography
  • Icons: Custom SVG icons and emojis

๐Ÿค Contributing

We welcome contributions from the MouseHunt community! Here's how you can help:

Ways to Contribute

  1. Content Creation: Write guides for specific ranks or areas
  2. Content Updates: Keep existing guides current with game changes
  3. Bug Reports: Report issues or inconsistencies
  4. Feature Requests: Suggest improvements or new features
  5. Code Contributions: Help improve the website functionality

Contribution Process

  1. Fork the repository
  2. Create a branch: git checkout -b guide/edits-made
  3. Make your changes
  4. Commit your changes: git commit -m 'edited some guide'
  5. Push to the branch: git push origin guide/edits-made
  6. Submit a pull request

๐Ÿ”— Useful Resources

๐Ÿ™ Acknowledgments

Special thanks to all who have helped: contributors, Discord community members, and everyone else who has supported this project.

This guide was inspired by:

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

โš ๏ธ Disclaimer

This is a community-created guide for the game MouseHunt. All MouseHunt images and content included here are the properties of HitGrab Inc. This guide is not affiliated with or endorsed by HitGrab Inc.


Built with โค๏ธ by the MouseHunt community

Contributors

kuhmann

Issues