Skip to content

aaronjacobs-chelt/MycoMate-Digital-Pet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

7 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ„ MycoMate - Digital Mushroom Pet

๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„
      __  __                   __  __       _       
     |  \/  |                 |  \/  |     | |      
     | \  / |_   _  ___ ___   | \  / | __ _| |_ ___ 
     | |\/| | | | |/ __/ _ \  | |\/| |/ _` | __/ _ \
     | |  | | |_| | (_| (_) | | |  | | (_| | ||  __/
     |_|  |_|\__, |\___\___/  |_|  |_|\__,_|\__\___|
              __/ |                                 
             |___/                                  
            
         Your Digital Mushroom Pet Companion
๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„โœจ๐Ÿ„

A Tamagotchi-style digital pet game where you care for and nurture your very own mushroom companion!

๐ŸŽฎ Features

  • 5 Growth Stages: Watch your pet evolve from Spore โ†’ Sprout โ†’ Young โ†’ Mature โ†’ Magical Mushroom
  • Real-time Care: Your pet needs regular feeding, playing, cleaning, and rest
  • Unique Personalities: Each pet has its own personality (shy, playful, curious, sleepy, energetic)
  • Favorite Foods: Every pet has preferred foods that provide bonus benefits
  • Experience System: Gain XP through care activities to unlock the magical final stage
  • Persistent Save Data: Your pet continues growing even when you're away
  • Beautiful ASCII Art: Different visual representations for each growth stage and mood
  • Enhanced Visual Feedback: Color-coded stat changes, level-up celebrations, and evolution banners
  • Personality-Driven Gameplay: Each personality type offers distinct gameplay experiences
  • Stats Management: Monitor hunger, happiness, health, cleanliness, and energy

๐Ÿš€ Quick Start

Prerequisites

  • Python 3.6 or higher
  • Terminal/Command line access

Installation

  1. Clone the repository:
git clone https://github.com/aaronjacobs-chelt/MycoMate-Digital-Pet.git
cd MycoMate-Digital-Pet
  1. Run the game:
python3 mycomate.py

First Time Setup

  1. Enter a name for your new mushroom pet
  2. Your pet will be born as a tiny spore!
  3. Learn about their personality and favorite food
  4. Start caring for your new companion

โญ Recent Improvements (v1.1)

๐ŸŽจ Enhanced Visual Experience

  • Color-coded stat changes: See your pet's improvements with green (+) and warnings with red (-)
  • Celebration banners: Special ASCII art displays for level-ups and evolution milestones
  • Personality-driven responses: Each personality type has unique reactions to care actions
  • Enhanced emojis: More expressive visual feedback throughout the game

โš–๏ธ Game Balance Improvements

  • Faster progression: Reduced time requirements for growth stages (Magical: 72โ†’48hrs, 500โ†’400xp)
  • Better stat decay: More forgiving decay rates for improved playability
  • Personality affects gameplay: Each personality type now has distinct stat decay patterns:
    • Energetic: High metabolism, burns energy fast, gets dirty easily
    • Sleepy: Conserves energy well, needs stimulation, rests efficiently
    • Playful: Maintains happiness better, loves interaction
    • Shy: Stays clean, needs attention, gets satisfaction from overcoming shyness
    • Curious: Balanced explorer with moderate energy use
  • Enhanced food system: Rebalanced food effects with dynamic favorite food bonuses
  • Smarter XP distribution: Context-based bonuses reward good care timing
  • Necessity-based bonuses: More rewards when your pet really needs care

๐ŸŽฎ Improved Gameplay

  • Reduced cooldowns: Better feeding cooldown logic when pet is very hungry
  • Enhanced health system: More granular health factors with achievable good care conditions
  • Better care timing: XP bonuses for feeding hungry pets and optimal care timing

๐ŸŽฏ How to Play

Pet Care Actions

Action Effect Cooldown Notes
๐Ÿฝ๏ธ Feed +Hunger, +Happiness, +Health 30 min* Different foods have different effects
๐ŸŽฎ Play +Happiness, +XP, -Energy 20 min Requires >30 energy
๐Ÿงผ Clean +Cleanliness, +Happiness, +Health 1 hour Keeps your pet pristine
๐Ÿ˜ด Rest +Energy, +Health None Let your pet recharge

*Feeding cooldown is reduced if pet is very hungry

Food Types

  • Nutrients: Balanced nutrition (default)
  • Compost: Great for hunger, moderate happiness
  • Water: Moderate hunger, good energy boost
  • Sunshine: High happiness and energy, moderate hunger
  • Minerals: Excellent hunger, good health boost

๐Ÿ’ก Tip: Feed your pet their favorite food for bonus effects!

Growth Stages

Stage Requirements Time Health Needed XP Needed
๐ŸŒฑ Spore Starting stage 0 hours - -
๐ŸŒฟ Sprout Survival 4 hours Any -
๐Ÿ„ Young Basic care 16 hours >35% -
๐Ÿ„๐Ÿ„ Mature Good care 30 hours >50% -
โœจ๐Ÿ„โœจ Magical Excellent care 48 hours >75% 400+

Stats Explained

  • Hunger (0-100%): How well-fed your pet is. Decays over time.
  • Happiness (0-100%): Your pet's mood. Increased by playing and favorite foods.
  • Health (0-100%): Overall wellbeing. Affected by other stats.
  • Cleanliness (0-100%): How clean your pet is. Decays slowly over time.
  • Energy (0-100%): Available energy for activities. Restored by resting.

๐Ÿ“ Project Structure

MycoMate-Digital-Pet/
โ”œโ”€โ”€ mycomate.py          # Main game file
โ”œโ”€โ”€ README.md            # This file
โ”œโ”€โ”€ LICENSE              # Project license
โ”œโ”€โ”€ requirements.txt     # Python dependencies
โ”œโ”€โ”€ .gitignore          # Git ignore rules
โ”œโ”€โ”€ docs/               # Documentation
โ”‚   โ”œโ”€โ”€ gameplay.md     # Detailed gameplay guide
โ”‚   โ”œโ”€โ”€ development.md  # Development documentation
โ”‚   โ””โ”€โ”€ api.md          # Code documentation
โ”œโ”€โ”€ examples/           # Example configurations
โ””โ”€โ”€ assets/            # Game assets and media

๐Ÿ› ๏ธ Development

Code Structure

The main game is contained in mycomate.py with the following key components:

  • MushroomPet Class: Core pet logic and state management
  • Stats System: Real-time stat updates and decay
  • Growth System: Age-based evolution with requirements
  • UI System: Terminal-based interface with ASCII art
  • Save System: JSON-based persistence

Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

See docs/development.md for detailed development guidelines.

๐Ÿ› Troubleshooting

Common Issues

Pet won't evolve to next stage:

  • Check that enough time has passed
  • Ensure health requirements are met
  • For Magical stage, verify you have 500+ XP

Stats declining too fast:

  • This is normal! Pets need regular care
  • Check back every few hours to maintain stats
  • Use the rest function to restore energy

Can't find save file:

  • Save files are stored as hidden files (.mushroom_pet_[name].json)
  • Located in your home directory by default

๐Ÿ“ License

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

๐Ÿ™ Acknowledgments

  • Inspired by classic Tamagotchi digital pets
  • ASCII art inspired by text-based adventure games
  • Built with Python's standard library for maximum compatibility

๐Ÿ“Š Roadmap

Planned Features

  • Multiple pet support in single session
  • Pet breeding system
  • Mini-games for interaction
  • Seasonal events and special foods
  • Pet social interactions
  • Achievement system
  • Custom ASCII art themes
  • Mobile app version

Version History

  • v1.0.0: Initial release with core pet care mechanics
  • v1.1.0: Enhanced UI and growth system improvements
  • v1.2.0: Experience system and stat balancing

๐ŸŽฎ Start Your Journey

Ready to meet your new mushroom companion? Run the game and watch your spore grow into a magnificent magical mushroom through love and care!

python3 mycomate.py

Happy mushroom parenting! ๐Ÿ„โœจ

About

๐Ÿ„ A Tamagotchi-style digital mushroom pet game. Care for your spore and watch it grow through 5 evolution stages!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors