🤖 CloneMe

Your AI Personality, Perfected

Transform any AI into your perfect digital twin
Advanced memory • Natural conversations • Multi-platform magic ✨

---

🚀 Quick Start • 📖 Documentation • 💬 Join Discord • 🤝 Contribute

🎯 What Makes CloneMe Special?

Ever wished you could be everywhere at once? CloneMe makes it possible. Transform any AI into your perfect digital twin that learns, remembers, and responds just like you would - but smarter and always available.

🎭 CloneMe in action - natural AI conversations with memory and personality

✨ Why Developers Love CloneMe

🧠 Intelligent Memory Never repeat yourself again. CloneMe remembers names, preferences, and context across conversations. 🎭 Dynamic Personalities Hot-swap between different AI personas instantly. From professional to casual, gaming to business. ⚡ Lightning Setup One command setup with our autonomous installer. No complex configuration headaches.

🌐 Multi-Platform Ready Built for Discord today, designed for everywhere tomorrow. Extensible architecture that scales. 🤖 AI Provider Agnostic Works with OpenAI, Claude, Gemini, Groq, and local models. Your choice, your control. 🛡️ Security First Prompt injection protection, rate limiting, and local data storage. Your privacy matters.

💡 Pro Tip: CloneMe isn't just another chatbot - it's your digital presence that learns and evolves with every conversation.

🌐 Platform & AI Support

Supported Platforms

Platform	Status	Features
🎮 Discord	✅ Live	Full implementation with memory & personalities
📱 Telegram	🚧 Coming Soon	Bot API integration in progress
🐦 Twitter/X	📋 Planned	Social media engagement ready
💬 WhatsApp	🔮 Future	Business API integration planned

AI Provider Ecosystem

Provider	Models	Speed	Best For
🤖 OpenAI	GPT-4, GPT-3.5-turbo	⚡⚡⚡	Balanced performance
🧠 Anthropic	Claude-3-sonnet, Claude-3-haiku	⚡⚡⚡	Thoughtful responses
🔍 Google	Gemini-pro, Gemini-1.5-pro	⚡⚡⚡⚡	Fast & efficient
🚀 Groq	Llama, Mixtral	⚡⚡⚡⚡⚡	Ultra-fast inference
🏠 Ollama	Local models	⚡⚡	Privacy & control

🚀 Quick Start

Get your AI clone running in under 5 minutes!

📋 What You'll Need

🐍 Python 3.11.6+ The foundation

🔑 AI API Key Your AI provider credentials

🎮 Discord Token For Discord integration

⚡ Lightning Installation

Step 1: Get the Code

git clone https://github.com/vibheksoni/cloneme.git
cd cloneme

Step 2: Magic Setup ✨

python scripts/setup.py

🎯 Our autonomous installer handles everything:

• ✅ Python compatibility check
• ✅ Virtual environment creation
• ✅ Dependency installation
• ✅ Directory structure setup
• ✅ Configuration templates

🔧 Configuration Made Simple

Step 3: Configure Your Clone

🔑 Essential Settings (.env file)

# 🎮 Platform Setup
PLATFORM=discord
DISCORD_SELF_TOKEN=your_discord_self_token_here

# 🤖 AI Brain Configuration  
AI_PROVIDER=openai                    # Choose your AI provider
AI_API_KEY=your_api_key_here         # Your API credentials
AI_MODEL=gpt-4                       # Model selection
AI_PROFILE=default_profile           # Personality profile

# 🎬 Optional Enhancements
GIPHY_API_KEY=your_giphy_api_key_here    # For GIF reactions
AZURE_OPENAI_ENDPOINT=your_azure_endpoint # For Azure OpenAI users

🎭 Personality Customization (profiles/default_profile.json)

{
  "profiles": {
    "default": {
      "required": {
        "username": "YourUsername",
        "name": "Your Display Name"
      },
      "personality_traits": {
        "humor_style": "witty and sarcastic",
        "communication_style": "casual but intelligent",
        "interests": ["AI", "Gaming", "Technology"]
      },
      "custom_behaviors": {
        "emoji_usage": "moderate",
        "response_length": "concise",
        "technical_depth": "intermediate"
      }
    }
  }
}

🎉 Launch Your Clone

python main.py

🎊 Success! Your AI clone is now live and learning. Watch the magic happen in real-time!

Documentation

Document	Description
Settings Guide	Complete settings configuration with hot-reload
Profile System	Create dynamic AI personalities with flexible schemas
Memory System	Intelligent memory with quality filtering and deduplication
Message Flow	Detailed breakdown of message processing pipeline

Architecture

System Design

graph TB
    subgraph "Platform Layer"
        A[Discord] --> D[Platform Manager]
        B[Telegram*] --> D
        C[Twitter*] --> D
    end
    
    subgraph "Core AI Layer"
        D --> E[Decision Engine]
        E --> F[Memory System]
        F --> G[Response Generator]
    end
    
    subgraph "AI Providers"
        G --> H[OpenAI]
        G --> I[Anthropic]
        G --> J[Google]
        G --> K[Groq]
        G --> L[Ollama]
    end

Loading

Core Components

• Platform Manager: Handles platform-specific message processing
• Decision Engine: Determines when and how to respond
• Memory System: Manages long-term conversation memory
• Profile Manager: Handles personality configuration and hot-reloading
• AI Provider Interface: Abstracts different AI service providers

Extensibility

The system uses a BasePlatform abstraction for easy platform expansion:

class NewPlatform(BasePlatform):
    def get_platform_name(self) -> str:
        return "new_platform"

    async def send_message(self, chat_id: str, content: str) -> bool:
        # Platform-specific implementation
        pass

    def convert_platform_message(self, platform_msg, chat, sender) -> Message:
        # Convert to generic Message object
        pass

Memory System

The intelligent memory system focuses on quality over quantity:

graph LR
    A[User Message] --> B[Quality Filter]
    B --> C[Deduplication Check]
    C --> D[Memory Storage]
    D --> E[Context Retrieval]
    E --> F[Natural Response]
    
    G[Memory Cleanup] --> D
    H[Importance Ranking] --> G

Loading

What it remembers:

• Names, ages, locations, occupations
• Preferences, hobbies, relationships
• Important life events and goals

What it filters out:

• Temporary states and requests
• Meta-questions about the AI
• Low-quality or redundant information

Features:

• Quality-based filtering
• Automatic deduplication
• Importance-based cleanup
• Context-aware retrieval

Profile System

Create sophisticated AI personalities with unlimited customization:

• Hot-reload: Changes apply instantly without restart
• Flexible schema: Required core fields plus unlimited custom fields
• Multi-profile support: Switch between different personalities
• Validation: Automatic schema checking

Security Features

• Prompt injection protection: Advanced filtering of malicious inputs
• Rate limiting: Configurable participation controls
• Local data storage: No cloud sync, user-controlled data
• Secure configuration: Environment variable protection

💬 Community & Support

🎮 Join Our Thriving Discord Community

🌟 Where CloneMe creators gather to build the future of AI personalities

🛠️ Get Expert Help Instant setup assistance from the community Troubleshooting with experienced users Best practices and optimization tips Live support from maintainers 🎭 Share Your Creations Showcase your unique AI personalities Exchange custom profile configurations Get feedback on your implementations Inspire others with your use cases

🚀 Shape the Future Collaborate on new platform integrations Vote on upcoming features and priorities Beta test cutting-edge functionality Connect with potential collaborators 📢 Stay in the Loop First to know about new releases Exclusive previews and behind-the-scenes Community challenges and events Direct line to the development team

💡 Pro Community Tip: Our most active contributors often become platform maintainers and get early access to new features!

Roadmap & Contributing

Current Development Status

graph TB
    subgraph "✅ Completed"
        A[Discord Implementation]
    end
    
    subgraph "🚧 In Progress"
        B[Telegram Bot API]
        C[Voice Message Support]
    end
    
    subgraph "📋 Planned - High Priority"
        D[Twitter/X Integration]
        E[Web Dashboard]
        F[Image Understanding]
    end
    
    subgraph "🔮 Future Development"
        G[WhatsApp Business API]
        H[Multi-language Support]
        I[Docker Deployment]
        J[Cloud Templates]
    end
    
    A --> B
    B --> D
    C --> F
    E --> I

Loading

🌟 We're Actively Recruiting Talented Contributors!

Ready to shape the future of AI personalities? CloneMe is more than just a project - it's a movement. We're building the next generation of AI interaction, and we need passionate developers, designers, and AI enthusiasts to join our mission.

🎯 Whether you're a seasoned developer or just getting started, there's a perfect contribution waiting for you!

High-Priority Implementations Needed

Platform Integrations - Help us reach more users

Telegram Bot API Priority: High

• Well-documented API with extensive bot capabilities
• Large user base seeking AI integration
• Framework already prepared, needs implementation
• Skills needed: Python, Telegram Bot API, async programming

Twitter/X API Integration Priority: Medium

• Social media expansion opportunity
• Real-time engagement possibilities
• API access considerations required
• Skills needed: Python, Twitter API v2, social media best practices

WhatsApp Business API Priority: Medium

• Business and personal communication platform
• Growing demand for AI assistants
• Complex API but high impact
• Skills needed: Python, WhatsApp Business API, webhook handling

Slack Bot Integration Priority: Medium

• Workplace productivity enhancement
• Team collaboration features
• Enterprise-friendly deployment
• Skills needed: Python, Slack API, workspace integrations

AI & ML Enhancements - Advance the intelligence

Voice Message Processing Priority: High

• Audio input/output capabilities
• Speech-to-text and text-to-speech integration
• Natural voice personality matching
• Skills needed: Python, audio processing, OpenAI Whisper, TTS APIs

Computer Vision Integration Priority: Medium

• Image understanding and description
• Visual context awareness
• Meme and image reaction capabilities
• Skills needed: Python, OpenAI Vision API, image processing

Emotion Detection & Response Priority: Medium

• Sentiment analysis integration
• Mood-aware personality adaptation
• Emotional intelligence features
• Skills needed: Python, NLP, sentiment analysis, psychology understanding

Multi-language Support Priority: Low

• International user base expansion
• Language-specific personality traits
• Cultural context awareness
• Skills needed: Python, i18n, multiple languages, cultural knowledge

Infrastructure & DevOps - Scale and optimize

Web Dashboard Priority: High

• GUI for configuration and monitoring
• Real-time conversation viewing
• Profile management interface
• Skills needed: React/Vue.js, Python FastAPI, WebSocket

Performance Optimizations Priority: Medium

• Response caching system
• Batch message processing
• Database integration options
• Skills needed: Python, Redis, PostgreSQL, performance optimization

Docker & Cloud Deployment Priority: Medium

• Containerized deployment options
• Cloud platform templates (AWS, GCP, Azure)
• Scalable architecture patterns
• Skills needed: Docker, Kubernetes, cloud platforms, DevOps

How to Contribute

Getting Started

1. Fork and Setup

   # Fork the repository on GitHub, then clone your fork
   git clone https://github.com/yourusername/CloneMe.git
   cd CloneMe
   
   # Set up development environment
   python scripts/setup.py
   
   # Install development dependencies
   pip install -r requirements-dev.txt

2. Development Workflow

   # Create feature branch
   git checkout -b feature/platform-telegram
   
   # Make your changes and test
   python -m pytest tests/
   
   # Run the application
   python main.py

3. Contribution Guidelines

   • Follow existing architecture patterns and code style
   • Use BasePlatform abstraction for new platform implementations
   • Maintain backward compatibility with existing configurations
   • Include comprehensive documentation and tests
   • Update relevant README sections for new features

🏆 Contributor Recognition & Rewards

We believe in recognizing and rewarding our amazing contributors!

🎖️ Code Attribution Permanent recognition in our contributors hall of fame

👑 Maintainer Status Lead maintainer role for your platform implementations

🚀 Early Access Preview and test new features before public release

🌟 Community Fame Featured in Discord, release notes, and social media

🎉 Special Perks: Top contributors get exclusive CloneMe swag, direct access to the core team, and opportunities to speak at AI conferences!

Troubleshooting

Common Issues

ModuleNotFoundError during installation

Problem: Python cannot find required modules after installation

Root Cause: Virtual environment not activated or dependencies not properly installed

Solution Steps:

1. Verify virtual environment activation:

   # Windows
   venv\Scripts\activate
   
   # macOS/Linux
   source venv/bin/activate

2. Reinstall dependencies:

   pip install --upgrade pip
   pip install -r requirements.txt

3. Verify Python version compatibility:

   python --version  # Should be 3.11.6+

Authentication and token errors

Problem: Invalid token errors or authentication failures

Common Error Messages:

• discord.errors.LoginFailure: Improper token has been passed
• openai.error.AuthenticationError: Invalid API key

Solution Steps:

1. Verify token format in .env file (no extra spaces or quotes)
2. Check token permissions and validity
3. For Discord: Ensure account doesn't have unusual restrictions
4. For AI providers: Verify API key is active and has sufficient credits
5. Test tokens independently before running CloneMe

Rate limiting and API quota issues

Problem: Frequent rate limiting or API quota exceeded

Symptoms:

• "Rate limited. Retrying in X seconds..." messages
• Delayed or missing responses
• API quota exceeded errors

Solution Steps:

1. Adjust participation controls in settings.json:

   {
     "participation_control": {
       "threshold_percentage": 15,
       "time_window_minutes": 20
     }
   }

2. Monitor API usage in your provider dashboard

3. Consider upgrading API plan if needed

4. Implement longer delays between messages

Profile and configuration issues

Problem: AI personality not reflecting configured settings

Common Issues:

• Profile changes not taking effect
• JSON syntax errors
• Missing required fields

Solution Steps:

1. Validate JSON syntax using online JSON validator
2. Check profile name matches .env AI_PROFILE setting
3. Verify all required fields are present
4. Test hot-reload by saving profile file
5. Check logs for profile loading errors

Memory system not functioning

Problem: AI doesn't remember previous conversations

Possible Causes:

• Memory directory permissions
• Quality filtering too aggressive
• Memory file corruption

Solution Steps:

1. Verify memories/ directory exists and is writable
2. Check memory settings in settings.json
3. Review memory quality thresholds
4. Clear corrupted memory files if necessary
5. Monitor logs for memory-related errors

Getting Help

Support Type	Link
🐛 Bug Reports	Create Issue
💡 Feature Requests	Request Feature
💬 Community Support	Join Discord
📖 Documentation	View Docs

License

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

Attribution Requirement: Any use, modification, or distribution must include proper attribution to the original CloneMe project and link to https://github.com/vibheksoni/cloneme