# 💧 HydroMate 💧
# Your Hydration Companion

A Discord bot that helps users stay hydrated and maintain healthy habits with automated reminders.

## How It Works

HydroMate sends you smart reminders **only when you're online** - No spam when you're away.

### Highlights

- ⚡ **Event-based presence system** - Instant detection when you come online
- ⏰ **Custom intervals** - Personalize reminder frequency from 1-4 hours
- 🔥 **Gamification** - Streaks, achievements, and leaderboards
- 🌍 **Multi-language** - English and Turkish support
- 📊 **Rich statistics** - Track your hydration journey
- 🏆 **Social features** - Compete with friends and server members

## ✨ Features

### Core Features

- ⚡ **Real-time Reminders** - Instant scheduling when you come online
- 💧 **Hydration Focus** - Stay hydrated with regular water reminders
- 🎯 **Smart Notifications** - Event-based presence detection
- 📊 **Status Tracking** - Users can check their reminder status
- ⚙️ **Customizable Settings** - Choose between DM or server channel notifications
- ⏰ **Custom Intervals** - Set your own reminder frequency (1-4 hours)
- ⏸️ **Pause/Resume** - Full control over reminder activation
- 👥 **Multi-Server Support** - Works across multiple Discord servers
- 🔒 **Admin Controls** - Server admins can configure reminder channels

### Gamification & Engagement

- 🔥 **Streak System** - Track consecutive days of hydration with emoji tiers
- 🏆 **Achievements** - Unlock 12 achievements for milestones
- ✅ **Interactive Buttons** - Quick completion tracking with 60-minute expiration
- 📈 **Personal Stats** - Detailed statistics and progress tracking
- 💎 **Completion Rate** - Track your hydration consistency with visual progress bars
- 🎯 **Milestone Celebrations** - Special messages for 7, 14, 30, 60, 100+ day streaks

### Social Features

- 🏅 **User Leaderboards** - Rankings by streak, completion rate, or total completed
- 👥 **Role Competition** - Server role-based leaderboard system
- ⚔️ **Friend Comparison** - Head-to-head stats comparison
- 📊 **Server Statistics** - Comprehensive guild analytics with hydration score
- 🎉 **Public Celebrations** - Optional milestone announcements (admin toggle)
- 💎 **Hydration Score** - 6-tier server ranking system (Seedling to Diamond)

### Localization & Accessibility

- 🌍 **Multi-Language** - English (🇺🇸) and Turkish (🇹🇷) support
- 🔄 **User-Selectable** - Change language anytime with `/reminder settings`
- 📝 **Fully Translated** - Commands, reminders, achievements, errors, and facts
- 💬 **Message Variations** - 12+ different reminder messages for variety
- 💡 **Educational Content** - 25+ hydration facts in both languages

## 📝 Quick Start (First-Time User Experience)

  1. **Registration:** Use `/reminder register` - Join the hydration journey
  2. **Preview:** Receive your first reminder in ~5 minutes (preview mode)
  3. **Activation:** Use `/reminder start` to enable regular hourly reminders
  4. **Engagement:** Click "Hydrated!" when you drink water
  5. **Progress:** Build your streak, unlock achievements and have fun!

## 📖 Commands

### User Commands

#### Reminder Management

- `/reminder register` - Register for health reminders
- `/reminder start` - Activate reminder notifications
- `/reminder stop` - Deactivate reminder notifications
- `/reminder status` - Check your reminder status (streaks, stats, achievements)

#### Settings

- `/reminder settings` - View current settings
- `/reminder settings type:dm|channel` - Choose where to receive reminders
- `/reminder settings send_on_idle:true|false` - Receive reminders when idle/AFK
- `/reminder settings language:en|tr` - Change language (English or Turkish)
- `/reminder settings interval:60-240` - Set custom reminder interval in minutes (1-4 hours)

#### Social Features

- `/reminder compare @user` - Compare your stats with another user
- `/leaderboard users` - View user rankings
  - `sort:streak` - Sort by current streak (default)
  - `sort:completion` - Sort by completion rate
  - `sort:completed` - Sort by total completed reminders
- `/leaderboard roles` - View role competition standings
- `/stats server` - View server statistics and achievements

### Admin Commands (Administrator only)

- `/setup channel #channel` - Set or change the reminder channel
- `/setup view` - View current bot settings for this server
- `/setup celebrations enabled:true|false` - Toggle public celebration announcements

### Support

- `/help` - Command guide with all available commands and features
- `/support` - Get help and join HydroMate Support server

## 🤝 Need Help?

  Join our [Support Server](https://discord.gg/sRUWQSNg44) - we're happy to help!

---

Made with 💙 by @okk_oguzkagan
Stay Hydrated, Stay Healthy 💪

HydroMate

A Discord bot that helps users stay hydrated and maintain healthy habits with automated reminders.

Voting for HydroMate

Do you want to support us?