Metadata-Version: 2.1
Name: mc5_api_client
Version: 1.0.4
Summary: A comprehensive Python library for interacting with the Modern Combat 5 API
Home-page: https://pypi.org/project/mc5-api-client/
Author: Chizoba
Author-email: Chizoba <chizoba2026@hotmail.com>
Maintainer-email: Chizoba <chizoba2026@hotmail.com>
License: MIT License
        
        Copyright (c) 2026 Chizoba
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Documentation, https://mc5-api-client.readthedocs.io/
Project-URL: Source, https://pypi.org/project/mc5-api-client/
Project-URL: Tracker, https://pypi.org/project/mc5-api-client/
Keywords: modern combat 5,mc5,gameloft,api,client,gaming,authentication,clan,messaging
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: cli
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: all
License-File: LICENSE

# 🎮 Modern Combat 5 API Client

[![Python Version](https://img.shields.io/badge/python-3.8+-blue.svg)](https://python.org)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Author](https://img.shields.io/badge/author-Chizoba-orange.svg)](mailto:chizoba2026@hotmail.com)

Hey there! 👋 Welcome to the **Modern Combat 5 API Client** - your friendly Python library for connecting to the MC5 game API. Whether you want to automate your clan management, check your daily tasks, or just explore the game's data, this library makes it super easy!

## 🌟 What Can You Do With This?

Think of this as your remote control for Modern Combat 5! Here's what you can do:

- 🔐 **Easy Login**: No more hassle - just one line to get authenticated
- 👤 **Player Profile**: Check your stats, level, and update your profile
- 🏰 **Complete Clan Management**: Create, manage, and lead clans with 20+ methods
- 👥 **Squad/Group Management**: Manage squad members, stats, and activities in real-time
- 💬 **Complete Communication System**: Private messages, squad wall posts, and alerts
- 🎯 **Kill Signature Management**: Update player kill signatures and colors
- 📊 **Statistics & Analytics**: Track squad performance, member activity, and progress
- 🎮 **Friend Management**: Send friend requests and manage connections
- 📅 **Daily Tasks & Events**: Never miss your daily rewards and special events
- 🏆 **Leaderboards**: See how you rank against other players
- 🎮 **Game Data**: Access weapons, items, and game configuration
- 🖥️ **Modern CLI**: A beautiful command-line tool with colors and emojis
- 🔄 **Auto-Refresh**: Tokens refresh automatically - no interruptions!
- 🛡️ **Error Handling**: Get helpful error messages when things go wrong

## � Installation & Publishing

### 🚀 Install from PyPI

```bash
pip install mc5_api_client
```

✅ **Published and Available!** The MC5 API Client is now live on PyPI and ready for worldwide use!

### 📦 Install from Local Package

```bash
# Install the wheel file you just created
pip install dist/mc5_api_client-1.0.0-py3-none-any.whl

# Or install from source
cd mc5-api-client-1.0.0
pip install .
```

### 📤 Publishing Status

🎉 **Successfully Published!** The package is now available on PyPI:

✅ **Package Name**: `mc5_api_client`  
✅ **Version**: `1.0.1`  
✅ **PyPI URL**: https://pypi.org/project/mc5_api_client/  
✅ **Installation**: `pip install mc5_api_client`  
✅ **CLI Command**: `mc5 --help`  

### 📦 Package Files

✅ **Source Distribution**: `dist/mc5_api_client-1.0.1.tar.gz`  
✅ **Wheel Distribution**: `dist/mc5_api_client-1.0.1-py3-none-any.whl`

### 🔧 Build Status


### Step 1: Install the Library

Just run this in your terminal (Command Prompt/PowerShell):

```bash
pip install mc5_api_client
```

### Step 2: Verify Installation

```bash
# Check the CLI
mc5 --help
mc5 version

# Test in Python
python -c "import mc5_api_client; print('✅ MC5 API Client ready!')"
```

### Step 3: Your First Program

Copy and paste this simple example to get started:

```python
# Save this as my_mc5_script.py
from mc5_api_client import MC5Client

# Replace with your actual credentials
username = "YOUR_USERNAME_HERE"
password = "YOUR_PASSWORD_HERE"

# Create client and login
client = MC5Client(username=username, password=password)

# See what's happening in the game
events = client.get_events()
print(f"There are {len(events)} active events right now!")

# Don't forget to close the connection
client.close()
```

**What just happened?** 
- We imported the MC5 client
- We logged in with your credentials (replace with yours!)
- We got your profile info
- We checked what events are active
- We cleaned up properly

### Step 3: Try the Cool CLI Tool

The library comes with an awesome command-line tool! Check this out:

```bash
# Generate a token (your login key)
mc5 generate-token --username "anonymous:your_credential" --password "your_password" --save

# Check if your token is still valid
mc5 validate-token

# See your saved info
mc5 show-config
```

You'll see beautiful colored output with emojis! 🎨

## 📖 How It Actually Works

### 🔑 Getting Your Login Credentials

Before you can use the API, you need your MC5 login info:

1. **Username**: This looks like `anonymous:some_long_string_here=`
2. **Password**: Your regular MC5 password

**Where do I find this?**
- Your username is usually stored in the game files
- The password is what you use to log into the game

### 🎯 Different Ways to Authenticate

**Method 1: Login when creating the client**
```python
client = MC5Client(
    username="anonymous:your_username_here",
    password="your_password_here"
)
```

**Method 2: Login later**
```python
client = MC5Client()
client.authenticate(
    username="anonymous:your_username_here", 
    password="your_password_here"
)
```

**Method 3: Admin access (if you have it)**
```python
client.authenticate_admin()
```

### 👤 Managing Your Profile

Want to check your stats or update your profile?

```python
# Get your current profile
profile = client.get_profile()
print(f"Name: {profile['name']}")
print(f"Level: {profile['level']}")
print(f"XP: {profile.get('xp', 'N/A')}")

# Update your profile (if the game allows it)
try:
    client.update_profile({
        "name": "CoolNewName",
        "description": "I love MC5!"
    })
    print("Profile updated!")
except:
    print("Couldn't update profile - might not be allowed")
```

### 🏰 Complete Clan Management

If you run a clan, you can manage it programmatically with 20+ methods:

```python
# Search for clans
clans = client.search_clans("Elite", limit=10)
for clan in clans:
    print(f"{clan['name']} - {clan['member_count']} members")

# Create a new clan
new_clan = client.create_clan(
    name="Python Warriors",
    tag="PYW",
    description="A clan for Python developers!",
    membership_type="open"
)

# Get clan info
clan_id = new_clan.get('id')
clan_info = client.get_clan_settings(clan_id)
print(f"Clan: {clan_info['name']}")

# Update clan settings
client.update_clan_settings(clan_id, {
    "description": "Welcome to our awesome squad!",
    "membership_type": "invite_only"
})

# Manage members
members = client.get_clan_members(clan_id)
print(f"Found {len(members)} members")

# Invite a player
client.invite_clan_member(clan_id, "anonymous:player_credential", "officer")

# Handle applications
applications = client.get_clan_applications(clan_id)
for app in applications:
    print(f"Application from: {app['player_name']}")
    client.accept_clan_application(clan_id, app['credential'], "member")

# Get clan statistics
stats = client.get_clan_statistics(clan_id)
print(f"Total wins: {stats.get('total_wins', 0)}")

# Get internal leaderboard
leaderboard = client.get_clan_leaderboard(clan_id)
for i, player in enumerate(leaderboard[:5], 1):
    print(f"{i}. {player['name']} - {player['score']} points")
```

### 👥 Squad/Group Management

Manage your squad members and their stats in real-time:

```python
# Get all squad members with stats
members = client.get_group_members("your-group-id")
for member in members:
    print(f"{member['name']} - Score: {member['_score']} - Online: {member['online']}")

# Update member stats
client.update_member_score("group-id", "member-credential", 1500)
client.update_member_xp("group-id", "member-credential", 2500000)

# Update kill signature
client.update_member_killsig(
    "group-id", 
    "member-credential",
    "default_killsig_90",
    "-123456789"
)

# Get online members only
online_members = client.get_online_members("group-id")
print(f"{len(online_members)} members online now")

# Get squad statistics
stats = client.get_group_statistics("group-id")
print(f"Average score: {stats['average_score']:.1f}")
print(f"Total XP: {stats['total_xp']:,}")

# Find specific member
member = client.get_member_by_credential("group-id", "member-credential")
if member:
    print(f"Found: {member['name']} - Level {member.get('level', 'Unknown')}")
```

### 💬 Squad Wall Communication

Post messages, announcements, and updates to your squad wall:

```python
# Send a simple message
client.send_squad_wall_message(
    clan_id="your-group-id",
    message="Hello squad! Great game today! 🎮"
)

# Send message with kill signature
client.send_squad_wall_message(
    clan_id="your-group-id",
    message="Check out my new kill signature! 🔥",
    player_killsig="default_killsig_90",
    player_killsig_color="-123456789"
)

# Send squad statistics update
stats = client.get_group_statistics("group-id")
stats_message = f"""📊 Squad Statistics Update:
👥 Members: {stats['total_members']}
🟢 Online: {stats['online_members']}
🏆 Total Score: {stats['total_score']:,}
⭐ Total XP: {stats['total_xp']:,}

Keep up the great work squad! 💪"""

client.send_squad_wall_message(
    clan_id="your-group-id",
    message=stats_message,
    player_killsig="default_killsig_100",
    player_killsig_color="-987654321"
)

# Send welcome message
welcome_msg = """🎉 Welcome to the squad!

We're excited to have you join! Here's what you need to know:
🎮 Be active and participate in squad activities
💪 Help us climb the leaderboards
🤝 Support your squad mates
🏆 Represent our squad with pride

Let's dominate together! 🔥"""

client.send_squad_wall_message(
    clan_id="your-group-id",
    message=welcome_msg,
    activity_type="user_post"
)

# Send motivational message
import random
motivational_quotes = [
    "💪 Champions train, losers complain! Let's get better today!",
    "🔥 The only easy day was yesterday! Let's dominate!",
    "� Success is the sum of small efforts repeated day in and day out!"
]

quote = random.choice(motivational_quotes)
client.send_squad_wall_message(
    clan_id="your-group-id",
    message=quote,
    player_killsig="default_killsig_95",
    player_killsig_color="-555555555"
)
```

### � Private Messaging

Send direct messages to players with rich formatting:

```python
# Send a simple private message
client.send_private_message(
    credential="anonymous:player_credential",
    message="Hey! Want to play some matches together? 🎮"
)

# Send message with kill signature
client.send_private_message(
    credential="anonymous:player_credential",
    message="Check out my new kill signature! 🔥",
    kill_sign_color="-974646126",
    kill_sign_name="default_killsig_80"
)

# Send message with alert notification
client.send_private_message(
    credential="anonymous:player_credential",
    message="🔔 Important: Clan war at 8 PM! Don't be late! 🎮",
    alert_kairos=True
)

# Send reply message
client.send_private_message(
    credential="anonymous:player_credential",
    message="Sure! Let's play at 8 PM tonight! 🎮",
    reply_to="message_id_here"
)

# Send rich formatted message
formatted_message = """🎮 Squad Invitation

🎯 When: Tonight at 8 PM
📍 Where: Clan War Server
🎮 What: Practice Match
🏆 Prizes: 5000 XP bonus

📋 Requirements:
• Level 50+
• Active squad member
• Good teamwork skills
• Voice chat enabled

🎮 Let's dominate together! 🔥"""

client.send_private_message(
    credential="anonymous:player_credential",
    message=formatted_message,
    kill_sign_color="-123456789",
    kill_sign_name="default_killsig_95"
)

# Get inbox messages
messages = client.get_inbox_messages(limit=10)
for msg in messages:
    print(f"From: {msg['from']}")
    print(f"Message: {msg['body']}")
    print(f"Time: {msg['created']}")
    print(f"ID: {msg['id']}")

# Delete inbox message
client.delete_inbox_message("message_id_here")

# Delete multiple messages at once
message_ids = ["msg1_id", "msg2_id", "msg3_id"]
client.delete_multiple_inbox_messages(message_ids)

# Clear entire inbox (use with caution!)
client.clear_inbox()

# Bulk messaging
target_players = [
    "anonymous:player1_credential",
    "anonymous:player2_credential",
    "anonymous:player3_credential"
]

messages = [
    "Hey everyone! Ready for clan war? 🎮",
    "Let's practice together! 💪",
    "Good luck in the tournament! 🏆"
]

for credential, message in zip(target_players, messages):
    client.send_private_message(credential=credential, message=message)
    time.sleep(1)  # Small delay between messages
```

### � Daily Tasks and Events

Never miss your daily rewards:

```python
# Get all active events
events = client.get_events()

for event in events:
    print(f"📅 {event['name']}")
    print(f"   Status: {event['status']}")
    
    # Check if it's daily tasks
    if 'daily' in event['name'].lower() or 'activities' in event['name'].lower():
        print("   🎯 This is your daily tasks event!")
        
        # Get the tasks
        template = event.get('_template', {})
        tasks = template.get('event_tuning', {}).get('_tasks', {}).get('value', [])
        
        for i, task in enumerate(tasks[:3]):  # Show first 3 tasks
            points = task.get('points', 0)
            print(f"      Task {i+1}: {points} points")
```

### 🏆 Checking Leaderboards

See how you stack up:

```python
# Get regular leaderboard
leaderboard = client.get_leaderboard("ro")
print(f"Top {len(leaderboard.get('players', []))} players")

# Admin leaderboard (if you have admin access)
# admin_leaderboard = client.get_leaderboard("admin")
```

## 🖥️ CLI Commands - Your Command Center

The CLI tool is like having a remote control for MC5! Here are all the commands:

### 🔑 Token Management

**Generate a new token:**
```bash
mc5 generate-token --username "anonymous:your_credential" --password "your_password" --save
```

**Generate admin token:**
```bash
mc5 generate-admin-token --save
```

**Check if your token is still good:**
```bash
mc5 validate-token
```

### 🏰 Clan Management

**Search for clans:**
```bash
mc5 clan search "Elite" --limit 10
```

**Create a new clan:**
```bash
mc5 clan create --name "Python Warriors" --tag "PYW" --description "A clan for Python developers!"
```

**Get clan information:**
```bash
mc5 clan info your-clan-id
```

**Get clan members:**
```bash
mc5 clan members your-clan-id
```

**Invite a player:**
```bash
mc5 clan invite your-clan-id "anonymous:player_credential" --role officer
```

**Handle applications:**
```bash
mc5 clan applications your-clan-id
mc5 clan accept your-clan-id "anonymous:applicant" --role member
mc5 clan reject your-clan-id "anonymous:applicant"
```

**Apply to join a clan:**
```bash
mc5 clan apply target-clan-id --message "Let me join your squad!"
```

**Get clan statistics:**
```bash
mc5 clan stats your-clan-id
```

**Get clan leaderboard:**
```bash
mc5 clan leaderboard your-clan-id
```

### ⚙️ Configuration

**See your saved info:**
```bash
mc5 show-config
```

**Clear everything (start fresh):**
```bash
mc5 clear-config
```

### 🎨 Cool Options

**Enable debug mode (see what's happening behind the scenes):**
```bash
mc5 --debug generate-token --username "..." --password "..."
```

**Skip the fancy banner:**
```bash
mc5 --no-banner validate-token
```

## 🔧 Where Does Everything Get Saved?

The CLI saves your stuff in a special folder:

- **Windows**: `C:\Users\YourName\.mc5\`
- **Mac/Linux**: `~/.mc5/`

Inside you'll find:
- `config.json` - Your saved username and settings
- `token.json` - Your login tokens (so you don't have to login every time)
- `debug.log` - Debug information (if you use debug mode)

## 🚨 When Things Go Wrong

Don't worry! The library has great error handling:

```python
from mc5_api_client import MC5Client
from mc5_api_client.exceptions import (
    MC5APIError,
    AuthenticationError,
    TokenExpiredError,
    RateLimitError,
    NetworkError
)

try:
    client = MC5Client(username="user", password="pass")
    profile = client.get_profile()
    
except AuthenticationError:
    print("❌ Oops! Wrong username or password")
    
except TokenExpiredError:
    print("⏰ Your login expired! Try logging in again")
    
except RateLimitError as e:
    print(f"⏸️ Slow down! Try again in {e.retry_after} seconds")
    
except NetworkError:
    print("🌐 Can't connect to the internet. Check your connection!")
    
except MC5APIError as e:
    print(f"❌ Something went wrong: {e.message}")
```

## 🎯 Pro Tips

### 🔄 Auto-Refresh Tokens

Don't want to worry about your login expiring?

```python
client = MC5Client(
    username="your_username",
    password="your_password",
    auto_refresh=True  # Magic! 🪄
)

# Your token will refresh automatically when it expires
```

### 📦 Use Context Manager (Clean Code)

```python
with MC5Client(username="user", password="pass") as client:
    profile = client.get_profile()
    events = client.get_events()
    # Connection automatically closes when done!
```

### 🎯 Custom Permissions

Only need specific permissions?

```python
client.authenticate(
    username="user",
    password="pass",
    scope="message chat social"  # Only these permissions
)
```

## 🚀 Advanced Examples & Use Cases

### 🏆 Squad Management Bot

Create a bot that automatically manages your squad:

```python
import time
from mc5_api_client import MC5Client

def squad_management_bot():
    client = MC5Client(
        username="YOUR_USERNAME_HERE",
        password="YOUR_PASSWORD_HERE"
    )
    
    group_id = "your-group-id"
    
    while True:
        try:
            # Get squad statistics
            stats = client.get_group_statistics(group_id)
            
            # Post hourly updates
            update_message = f""""📊 Hourly Squad Update:
👥 Members: {stats['total_members']}
🟢 Online: {stats['online_members']}
🏆 Total Score: {stats['total_score']:,}
⭐ Total XP: {stats['total_xp']:,}

Keep up the great work squad! 💪"""
            
            client.send_squad_wall_message(
                clan_id=group_id,
                message=update_message,
                player_killsig="default_killsig_100",
                player_killsig_color="-987654321"
            )
            
            print(f"✅ Posted update at {time.strftime('%H:%M')}")
            
            # Wait for 1 hour
            time.sleep(3600)
            
        except Exception as e:
            print(f"❌ Error: {e}")
            time.sleep(60)  # Wait 1 minute before retrying
```

### � Private Messaging Bot

Create a bot that handles private communications:

```python
import time
from mc5_api_client import MC5Client

def private_messaging_bot():
    client = MC5Client(
        username="YOUR_USERNAME_HERE",
        password="YOUR_PASSWORD_HERE"
    )
    
    # Check inbox for new messages
    while True:
        try:
            messages = client.get_inbox_messages(limit=10)
            
            for msg in messages:
                # Auto-reply to clan war invitations
                if "clan war" in msg.get('body', '').lower():
                    client.send_private_message(
                        credential=msg.get('from', ''),
                        message="✅ I'll be there for the clan war! See you at 8 PM! 🎮",
                        reply_to=msg.get('id', ''),
                        kill_sign_color="-123456789",
                        kill_sign_name="default_killsig_95"
                    )
                    print(f"✅ Auto-replied to clan war invitation from {msg.get('from', '')}")
                
                # Send welcome message to new friends
                elif "friend request" in msg.get('body', '').lower():
                    client.send_private_message(
                        credential=msg.get('from', ''),
                        message="🎉 Thanks for the friend request! Let's play together soon! 💪",
                        alert_kairos=True
                    )
                    print(f"✅ Sent welcome message to {msg.get('from', '')}")
            
            # Wait 30 seconds before checking again
            time.sleep(30)
            
        except Exception as e:
            print(f"❌ Error: {e}")
            time.sleep(60)  # Wait 1 minute before retrying
```

### �� Performance Tracker

Track squad performance over time:

```python
from mc5_api_client import MC5Client
import json
from datetime import datetime

def track_squad_performance():
    client = MC5Client(
        username="YOUR_USERNAME_HERE",
        password="YOUR_PASSWORD_HERE"
    )
    
    group_id = "your-group-id"
    
    # Get current stats
    stats = client.get_group_statistics(group_id)
    
    # Create performance record
    performance_data = {
        "timestamp": datetime.now().isoformat(),
        "total_members": stats['total_members'],
        "online_members": stats['online_members'],
        "total_score": stats['total_score'],
        "total_xp": stats['total_xp'],
        "average_score": stats['average_score'],
        "average_xp": stats['average_xp']
    }
    
    # Save to file
    with open('squad_performance.json', 'a') as f:
        f.write(json.dumps(performance_data, indent=2) + '\n')
    
    print(f"✅ Performance data saved: {performance_data['total_score']} points")
    
    client.close()
```

### 🎮 Achievement Celebration Bot

Celebrate squad achievements automatically:

```python
def celebrate_achievements():
    client = MC5Client(
        username="YOUR_USERNAME_HERE",
        password="YOUR_PASSWORD_HERE"
    )
    
    group_id = "your-group-id"
    
    # Get current stats
    stats = client.get_group_statistics(group_id)
    
    # Check for milestones
    if stats['total_score'] > 10000:
        celebration_message = """🎉 MILESTONE ACHIEVED! 🎉

🏆 Squad reached 10,000 points! 
This is a huge achievement! 

🎮 Great teamwork everyone! 
Let's keep climbing! 🔥"""
        
        client.send_squad_wall_message(
            clan_id=group_id,
            message=celebration_message,
            player_killsig="default_killsig_99",
            player_killsig_color="-111111111"
        )
        
        print("🎉 Celebrated 10,000 point milestone!")
    
    client.close()
```

### 📈 Leaderboard Monitor

Create a custom leaderboard system:

```python
def create_custom_leaderboard():
    client = MC5Client(
        username="YOUR_USERNAME_HERE",
        password="YOUR_PASSWORD_HERE"
    )
    
    group_id = "your-group-id"
    
    # Get all members
    members = client.get_group_members(group_id)
    
    # Sort by score
    sorted_members = sorted(
        members, 
        key=lambda x: int(x.get('_score', 0)), 
        reverse=True
    )
    
    print("🏆 Squad Leaderboard:")
    print("=" * 50)
    
    for i, member in enumerate(sorted_members, 1):
        name = member.get('name', 'Unknown')
        score = member.get('_score', '0')
        xp = member.get('_xp', '0')
        online = "🟢" if member.get('online') else "🔴"
        
        print(f"{i:2d}. {online} {name:<20} Score: {score:>10} XP: {xp:>12}")
    
    print("=" * 50)
    print(f"📊 Total Members: {len(members)}")
    
    client.close()
```

## 📚 Available Examples

The library comes with comprehensive examples to get you started:

### 📋 Basic Examples
- `examples/basic_usage.py` - Simple authentication and API usage
- `examples/clan_management.py` - Complete clan management demonstration
- `examples/events_and_tasks.py` - Daily tasks and events handling
- `examples/squad_management.py` - Real-time squad member management
- `examples/squad_wall_management.py` - Squad wall communication examples
- `examples/private_messaging.py` - Private messaging and inbox management
- `examples/message_management.py` - Advanced message management and bulk deletion
- `examples/advanced_features.py` - Events, account management, alias system, game config
- `examples/player_stats.py` - Player statistics, batch profiles, dogtag search

### 🚀 Advanced Examples
- Squad management bot with automated updates
- Performance tracking and analytics
- Achievement celebration systems
- Custom leaderboard generation
- Real-time activity monitoring

## 📊 Complete Feature List

### 🔐 Authentication
- ✅ User and admin token generation
- ✅ Automatic token refresh
- ✅ Token validation and parsing
- ✅ Device ID management
- ✅ Multiple authentication methods

### 👤 Profile Management
- ✅ Get player profiles
- ✅ Update profile information
- ✅ Profile statistics

### 🏰 Clan Management (20+ Methods)
- ✅ Search for clans
- ✅ Create new clans
- ✅ Get clan information
- ✅ Update clan settings
- ✅ Manage clan members
- ✅ Invite/kick members
- ✅ Promote/demote members
- ✅ Handle applications
- ✅ Join/leave clans
- ✅ Get clan statistics
- ✅ Internal leaderboards
- ✅ Transfer ownership
- ✅ Disband clans

### 👥 Squad/Group Management (10+ Methods)
- ✅ Get squad members with stats
- ✅ Update member scores and XP
- ✅ Update kill signatures
- ✅ Monitor online/offline status
- ✅ Calculate squad statistics
- ✅ Find specific members
- ✅ Bulk stat updates
- ✅ Real-time activity monitoring

### � Events API (10+ Methods)
- ✅ Get all active and upcoming events
- ✅ Filter events by type and status
- ✅ Get detailed event information with tasks and milestones
- ✅ Parse event templates and extract rewards
- ✅ Get daily tasks with progress tracking
- ✅ Get squad events and tournament information
- ✅ Calculate event rewards based on current points
- ✅ Track event progress and next milestones
- ✅ Extract task conditions and reward types
- ✅ Support for multiple event categories

### 👤 Account Management (5+ Methods)
- ✅ Import account data from other platforms
- ✅ Link accounts across different platforms
- ✅ Get detailed account information
- ✅ Unlink platform accounts
- ✅ Migrate account data between platforms
- ✅ Support for cross-platform data transfer
- ✅ Account verification and validation

### 📊 Player Statistics & Batch Profiles

Get detailed player statistics using dogtags (in-game IDs) or credentials:

```python
# Search player by their in-game dogtag
player_stats = client.get_player_stats_by_dogtag("f55f")
print(f"Player found: {player_stats.get('player_info', {}).get('account', 'Unknown')}")

# Parse and analyze statistics
parsed = client.parse_player_stats(player_stats)
print(f"Rating: {parsed.get('rating', 0)}")
print(f"K/D Ratio: {parsed.get('overall_stats', {}).get('total_kills', 0) / max(parsed.get('overall_stats', {}).get('total_deaths', 1), 1):.2f}")

# Get detailed stats for multiple players
credentials = ["player1_cred", "player2_cred", "player3_cred"]
batch_stats = client.get_batch_profiles(credentials)

# Search players using dogtags
for dogtag in ["f55f", "ff11", "g6765"]:
    player = client.search_player_by_dogtag(dogtag)
    if 'error' not in player:
        print(f"Found: {player.get('player_info', {}).get('account')}")
```

### 📊 Player Statistics & Batch Profiles (6+ Methods)
- ✅ Get batch player profiles with detailed statistics
- ✅ Search players by dogtag (in-game ID)
- ✅ Get detailed player statistics using credentials
- ✅ Parse and structure player statistics
- ✅ Convert dogtags to aliases for API lookup
- ✅ Combine alias lookup with stats retrieval
- ✅ Support for multiple player batch operations
- ✅ Detailed game save and inventory data access
- ✅ Weapon statistics and performance analysis
- ✅ Campaign progress tracking
- ✅ Overall statistics calculation (K/D, accuracy, etc.)
- ✅ Player performance analysis tools

### ⚙️ Game Configuration (4+ Methods)
- ✅ Get asset hash metadata
- ✅ Get game object catalog
- ✅ Get service URLs for current region
- ✅ Get comprehensive game configuration
- ✅ Support for multiple config types
- ✅ Asset metadata tracking
- ✅ Service URL management
- ✅ Game object categorization
### 💬 Complete Communication System (6+ Methods)
- ✅ Send private messages with rich formatting
- ✅ Include kill signatures and colors
- ✅ Send alert notifications
- ✅ Reply to messages
- ✅ Get inbox messages
- ✅ Delete single messages
- ✅ Delete multiple messages (bulk deletion)
- ✅ Clear entire inbox
- ✅ Bulk messaging capabilities
- ✅ Message tracking and management
- ✅ Rich text formatting
- ✅ Multi-language support
- ✅ Message type customization

### 🎮 Social Features
- ✅ Friend management
- ✅ Send friend requests
- ✅ Check friend status
- ✅ Private messaging
- ✅ Squad wall posting

### 📅 Events & Tasks
- ✅ Get daily tasks and events
- ✅ Event details and parsing
- ✅ Task completion tracking
- ✅ Special event handling

### 🏆 Leaderboards
- ✅ Global leaderboards
- ✅ Clan leaderboards
- ✅ Squad leaderboards
- ✅ Custom ranking systems

### 🎮 Game Data
- ✅ Game object catalog
- ✅ Asset metadata
- ✅ Configuration access
- ✅ Alias and dogtag utilities

### 🖥️ CLI Interface
- ✅ Beautiful command-line tool
- ✅ Colorful output with emojis
- ✅ Token management commands
- ✅ Clan management commands
- ✅ Configuration management
- ✅ Debug capabilities

### 🛡️ Error Handling
- ✅ Comprehensive exception system
✅ Specific error types for different scenarios
✅ Helpful error messages
✅ Network error recovery

### 🔄 Automation
- ✅ Auto token refresh
- ✅ Context manager support
- ✅ Background task support
- ✅ Scheduled operations

## 🧪 For Developers

Want to contribute or modify the library?

```bash
# Clone the project
git clone https://github.com/chizoba2026/mc5-api-client
cd mc5-api-client

# Install for development
pip install -e ".[dev]"

# Run tests
pytest tests/

# Make code pretty
black src/
isort src/
```

## 📝 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. Basically, you can do whatever you want with it!

## 👋 About the Author

Hey! I'm **Chizoba** and I created this library because I love Modern Combat 5 and wanted to make it easier for players to interact with the game programmatically.

- 📧 **Email**: [chizoba2026@hotmail.com](mailto:chizoba2026@hotmail.com)
- 🎮 **MC5 Player**: Just like you!

## 🤝 Want to Help?

Awesome! Contributions are welcome! Here's how:

1. **Fork** the project
2. **Create** your feature branch: `git checkout -b feature/AmazingFeature`
3. **Commit** your changes: `git commit -m 'Added this cool thing'`
4. **Push** to the branch: `git push origin feature/AmazingFeature`
5. **Open** a Pull Request

## ❓ Need Help?

Stuck on something? No worries!

- 📧 **Email me**: chizoba2026@hotmail.com
- 📖 **Check the examples**: Look in the `examples/` folder
- 🐛 **Report issues**: Let me know what's not working

## 🔗 Useful Links

This is the **most comprehensive Modern Combat 5 API library** ever created! With **95+ methods** across **14 major categories**, you can:

- 🏰 **Manage entire clans** from creation to disbandment
- 👥 **Control squad members** with real-time stat updates
- 💬 **Complete communication system** - Private messages, squad wall, alerts
- 📅 **Advanced events system** - Daily tasks, squad events, milestones
- 👤 **Account management** - Import, link, migrate across platforms
- 🏷️ **Alias/dogtags system** - Player ID conversion and search
- ⚙️ **Game configuration** - Assets, catalogs, service URLs
- 🎯 **Customize everything** with kill signatures and rich formatting
- 📊 **Track performance** with detailed analytics
- 🎮 **Automate gameplay** with custom bots and scripts
- 🏆 **Create leaderboards** and ranking systems
- 🔄 **Schedule tasks** and monitor activity

**Perfect for:**
- 🏆 Squad leaders who want to automate management
- 📊 Players who want to track their progress
- 🤖 Developers building MC5 applications
- 🎮 Gamers creating custom tools and bots
- 📈 Analysts studying squad performance
- 🏅 Competitive players seeking advantages
- 💬 Community managers handling communications
- 📧 Support teams providing assistance
- 📅 Event coordinators managing tournaments
- 🏷️ Player search and identification systems

**Ready to dominate Modern Combat 5?** 🚀

```bash
pip install mc5_api_client
mc5 --help  # See all commands!
