An AI-powered virtual pet study companion built with Python and Tkinter that helps you stay motivated while studying!
- Interactive Pet: Click on your pet to make them bounce and gain affection points
- Pet Evolution: Your pet grows from Egg → Baby → Child → Grown → Battle-fit as you study
- Emotional System: Pets express different emotions based on care and study progress
- Multiple Pet Types: Choose from different pet species with unique personalities
- Smart Study Timer: Pomodoro-style timer with customizable durations
- Quick Quiz System: Randomized questions across multiple subjects and difficulty levels
- Progress Tracking: Monitor your study time and quiz performance
- Study Scheduler: Plan and organize your study sessions
- Local Language Generation: Chat with your pet using built-in generative AI
- Original Responses: Pet creates unique sentences instead of preset responses
- Study Support: Get encouragement and study tips from your companion
- Emotion Recognition: Your pet responds based on your mood and context
- Conversation Memory: Persistent chat history and relationship building
- Background Music: Play your favorite study music with built-in player
- Multiple Formats: Supports MP3, WAV, OGG, and M4A files
- Music Controls: Play, pause, skip tracks without leaving the app
- Dynamic Themes: Multiple color schemes to match your preferences
- Responsive UI: Interface scales with window size for optimal viewing
- Font Scaling: Text automatically adjusts based on window dimensions
- Developer Mode: Advanced controls for testing and debugging
- Pet Management: Force evolution, change emotions, modify stats
- Study Session Controls: Skip timers, complete sessions instantly
- Python 3.7 or higher
- pip package manager
- Clone the repository:
git clone https://github.com/YOUR_USERNAME/StudyPet.git
cd StudyPet- Install required dependencies:
pip install -r requirements.txt- Run the application:
python StudyPet.pyYour pet uses a built-in local language generation system:
- No external API keys required
- Completely offline functionality
- Creates original responses based on pet personality and conversation context
- Start Your Journey: Launch the app and watch your pet hatch from an egg
- Study Together: Use the study timer or take quick quizzes to help your pet grow
- Interact: Click on your pet to play and build affection
- Chat: Have conversations with your pet (AI features require OpenAI API key)
- Customize: Explore themes, music, and settings to personalize your experience
StudyPet/
├── src/
│ ├── screens/ # UI screens and layouts
│ ├── data/ # Pet data models and state management
│ ├── graphics/ # Pet graphics and visual elements
│ ├── ai/ # AI chat integration
│ ├── database/ # Data persistence
│ └── utils/ # Utility functions and helpers
├── bgm/ # Background music files
├── data/ # Static data files (quiz questions, etc.)
└── StudyPet.py # Main application entry point
- Python 3.7+: Core programming language
- Tkinter: Cross-platform GUI framework
- Local AI Model: Built-in generative language system
- SQLite: Local data storage
- Pygame: Audio playback functionality
- JSON: Configuration and data serialization
Contributions are welcome! Here are ways you can help:
- Report Bugs: Create issues for any bugs you encounter
- Feature Requests: Suggest new features or improvements
- Code Contributions: Submit pull requests with bug fixes or new features
- Documentation: Help improve documentation and guides
This project is open source and available under the MIT License.
Screenshots and demos coming soon!
- Mobile app version
- Multiplayer pet interactions
- More pet types and customizations
- Advanced study analytics
- Integration with external study platforms
- Achievement system
- Pet breeding and genetics
If you encounter any issues or have questions:
- Check the Issues page
- Create a new issue if your problem isn't already reported
- Include detailed information about your system and the issue
Happy studying with your new pet companion! 🐾📚