DigitalPal / README.md
BladeSzaSza's picture
Simplify OAuth configuration and add proper scopes
f00907a
---
title: DigiPal - AI Digital Pet
emoji: ๐Ÿฅš
colorFrom: blue
colorTo: purple
sdk: docker
app_port: 7860
pinned: false
license: mit
short_description: AI-powered digital pet inspired by Digimon World 1
hf_oauth: true
hf_oauth_scopes:
- read-repos
- inference-api
---
# ๐Ÿฅš DigiPal - Your AI Digital Pet
A sophisticated digital pet application inspired by Digimon World 1, featuring real-time AI interaction, dynamic evolution, and immersive pet care mechanics.
## โœจ Features
### ๐Ÿค– Advanced AI Integration
- **Natural Language Processing** with Qwen3-0.6B for contextual conversations
- **Speech Recognition** via Kyutai speech-to-text
- **Dynamic Image Generation** using FLUX.1-dev for real-time pet visualization
### ๐ŸŽฎ Rich Pet Mechanics
- **7 Life Stages**: Egg โ†’ Baby โ†’ Child โ†’ Adult โ†’ Champion โ†’ Ultimate โ†’ Elderly
- **Care System**: Feed, train, and nurture your DigiPal with 20+ care actions
- **Evolution System**: Your care quality determines evolution paths
- **Generational Inheritance**: Perfect care = 25% stat inheritance to next generation
### ๐Ÿ  Persistent World
- **Real-time Updates**: Pets age and evolve even when you're away
- **Backup System**: Automatic save states and recovery
- **Authentication**: Secure HuggingFace token integration
## ๐Ÿš€ Quick Start
### Online Mode (Recommended)
1. Enter your HuggingFace API token for full AI features
2. Select your starter egg from 4 unique types
3. Begin caring for your DigiPal through its life journey
### Offline Mode
1. Check "Enable Offline Mode"
2. Enter any placeholder token
3. Experience core mechanics without AI features
## ๐ŸŽฏ Gameplay Loop
1. **Hatch Your Egg**: Choose from Flame, Ocean, Forest, or Sky eggs
2. **Daily Care**: Feed, train, play, and interact with your pet
3. **Watch Evolution**: Care quality determines evolution outcomes
4. **Generational Play**: When pets reach end-of-life, their DNA influences the next generation
## ๐Ÿ“– Care Guide
### ๐ŸŽ Feeding
- **Fruits**: Increase happiness and health
- **Vegetables**: Boost training effectiveness
- **Treats**: Special happiness boost but use sparingly
### ๐Ÿ‹๏ธ Training
- **Strength**: Physical power and combat readiness
- **Intelligence**: Learning speed and AI interaction quality
- **Endurance**: Longevity and resistance to illness
### ๐Ÿ’ Care Quality
Your pet's care level affects everything:
- **Perfect Care** (90-100%): Best evolution options, 25% inheritance
- **Excellent Care** (80-89%): Great evolutions, 20% inheritance
- **Good Care** (70-79%): Standard growth, 15% inheritance
## ๐ŸŽจ Generated Content
DigiPal creates unique visual content for your pet using FLUX.1-dev, with intelligent caching for performance. Each pet's appearance reflects its species, life stage, and care history.
## ๐Ÿ”’ Privacy & Security
- Secure token storage with encryption
- Local data processing where possible
- Optional offline mode for privacy-conscious users
- Automatic backup system protects your progress
---
**Ready to start your DigiPal journey? ๐Ÿš€**