� ZORIN - Advanced AI Desktop Assistant

A sophisticated, modern desktop AI assistant with voice interaction, real-time web search, and beautiful animated UI

Features • Installation • Usage • API Keys • Contributing

</div>

🌟 Overview

Zorin is a cutting-edge AI desktop assistant that combines the power of modern AI models with an intuitive, animated web interface. Built with Python and JavaScript, it offers seamless voice and text interactions, real-time information retrieval, and system integration capabilities.

🎯 What Makes Zorin Special

🎨 Modern UI: Beautiful glassmorphism design with animated orb visualizations
🎙️ Advanced Voice: Natural speech recognition and text-to-speech with Edge TTS
🧠 Multi-Model AI: Support for Groq, Cohere, and HuggingFace models
🌐 Real-time Search: Live web search integration for up-to-date information
📱 Responsive Design: Works seamlessly across desktop and mobile browsers
🔧 Extensible: Modular architecture for easy feature additions

✨ Features

🤖 AI & Conversation

Multiple AI model support (Llama 3.3, DeepSeek R1, Gemma 2, etc.)
Persistent conversation memory with chat history
Context-aware responses with real-time information
Custom personality and response styling

🎙️ Voice & Audio

Advanced speech recognition with Web Speech API
Natural text-to-speech using Microsoft Edge TTS
Voice activation with wake word detection (Pvporcupine)
Multiple voice options and languages

🌐 Web Integration

Real-time web search capabilities
Live weather updates
News and information retrieval
Website content summarization

🎨 User Interface

Animated AI orb with multiple states (idle, listening, thinking, speaking)
Modern glassmorphism design with backdrop blur effects
Responsive layout for all screen sizes
Dark theme with cyan/teal accent colors
Smooth animations and transitions

� System Features

Real-time system monitoring (CPU, RAM, Network)
Application launcher integration
File and folder management capabilities
Cross-platform compatibility (Windows, macOS, Linux)

🚀 Installation

Prerequisites

Python 3.8+ (3.9+ recommended)
Modern web browser (Chrome, Firefox, Edge, Safari)
Microphone for voice input (optional)
Internet connection for AI models and web search

1. Clone the Repository

git clone https://github.com/JashanMaan28/Zorin.git
cd Zorin

2. Create Virtual Environment (Recommended)

# Windows
python -m venv env-zorin
env-zorin\Scripts\activate

# macOS/Linux
python3 -m venv env-zorin
source env-zorin/bin/activate

3. Install Dependencies

pip install -r requirements.txt

4. Set Up Environment Variables

Create a .env file in the root directory:

# User Configuration
Username=YourName

# AI Model Configuration
Model=llama-3.3-70b-versatile
GroqAPIKey=your_groq_api_key_here
COHERE_API_KEY=your_cohere_api_key_here
HuggingFaceAPIKey=your_huggingface_api_key_here

# Voice Configuration
pvporcupine_ACCESS_KEY=your_picovoice_api_key_here

5. Run the Application

python run.py

The application will automatically open in your default web browser at http://localhost:8000

🔑 API Configuration

Required API Keys

| Service | Purpose | Free Tier | Get Key | |---------|---------|-----------|---------| | Groq | Primary AI model | ✅ Yes | groq.com | | Cohere | Web search & embeddings | ✅ Yes | cohere.ai | | HuggingFace | Alternative AI models | ✅ Yes | huggingface.co | | Picovoice | Wake word detection | ✅ Limited | picovoice.ai |

Setting Up API Keys

Groq (Primary AI):
- Sign up at groq.com
- Navigate to API Keys section
- Create new API key
- Add to .env file
Cohere (Web Search):
- Register at cohere.ai
- Go to Dashboard → API Keys
- Generate new key
- Add to .env file
HuggingFace (Optional):
- Create account at huggingface.co
- Go to Settings → Access Tokens
- Create new token
- Add to .env file
Picovoice (Wake Word):
- Sign up at picovoice.ai
- Access Console → Porcupine
- Copy access key
- Add to .env file

🎮 Usage

Basic Interaction

Text Input: Type your question in the input field and press Enter or click Send
Voice Input: Click the microphone button and speak your question
Settings: Click the gear icon to configure API keys and models
Chat History: Click the chat icon to view conversation history

Voice Commands

"Hey Zorin" - Wake word activation (if configured)
Natural conversation - Ask questions, request information, get help
System commands - "Open calculator", "Check weather", etc.

Keyboard Shortcuts

Ctrl + Enter - Send message
Cmd/Ctrl + J - Activate voice input
Escape - Return to main interface

Advanced Features

Model Selection

Choose from multiple AI models in settings:

Llama 3.3 70B (Recommended) - Balanced performance and accuracy
DeepSeek R1 - Advanced reasoning capabilities
Gemma 2 9B - Fast and efficient responses

Web Search Integration

Zorin automatically searches the web for current information when needed:

User: "What's the weather in Tokyo today?"
Zorin: *searches web* "Currently in Tokyo, it's 22°C with partly cloudy skies..."

Chat Management

Auto-save: Conversations are automatically saved
Archive: Old chats are archived by date
Export: Download chat history as JSON

🏗️ Project Structure

Zorin/
├── 📁 backend/              # Python backend modules
│   ├── ChatBot.py          # Main AI chat logic
│   ├── Model.py            # AI model management
│   ├── RealtimeSearchEngine.py  # Web search functionality
│   ├── speechToText.py     # Voice recognition
│   ├── textToSpeech.py     # Voice synthesis
│   ├── commands.py         # System commands
│   ├── features.py         # Core features
│   └── settings.py         # Configuration management
├── 📁 frontend/             # Web interface
│   ├── index.html          # Main UI
│   ├── style.css           # Modern styling
│   ├── main.js             # Core JavaScript
│   ├── controller.js       # Backend communication
│   └── 📁 assets/          # Static assets
├── � Data/                 # User data and logs
│   ├── ChatLog.json        # Current conversation
│   └── 📁 Files/           # Generated content
├── 📁 chatlog_archives/     # Historical conversations
├── main.py                 # Core application logic
├── run.py                  # Application launcher
├── requirements.txt        # Python dependencies
└── .env                    # Environment configuration

� Development

Architecture

Zorin uses a hybrid architecture combining:

Backend: Python with Eel for web app integration
Frontend: Modern web technologies (HTML5, CSS3, ES6+)
Communication: Eel framework for Python-JavaScript bridge
AI: Multiple model providers via REST APIs
Voice: Web Speech API + Edge TTS integration

Key Components

Backend (Python)

ChatBot.py: Manages AI conversations and context
Model.py: Handles multiple AI model integrations
RealtimeSearchEngine.py: Web search and information retrieval
speechToText.py: Voice input processing
textToSpeech.py: Voice output generation

Frontend (JavaScript)

OrbController: Manages visual AI orb animations
WebSocket Communication: Real-time backend interaction
Responsive UI: Modern glassmorphism design
State Management: Handles conversation and UI states

Adding New Features

Backend Features: Add to /backend/ directory
UI Components: Modify /frontend/ files
API Integration: Update Model.py and settings
Commands: Extend commands.py for system integration

🎨 Customization

Themes & Styling

The UI uses CSS custom properties for easy theming:

:root {
  --primary-color: #0ab0d1;
  --secondary-color: #05738a;
  --accent-color: #29e9dd;
  --background-color: rgba(25, 25, 25, 0.95);
  --text-color: #ffffff;
}

Voice Configuration

Customize voice settings in .env:

# Voice Settings
VOICE_LANGUAGE=en-US
VOICE_SPEED=1.0
VOICE_PITCH=1.0
TTS_PROVIDER=edge

AI Personality

Modify the system prompt in backend/ChatBot.py:

System = f"""
You are Zorin, a helpful AI assistant.
Customize personality traits here...
"""

🚀 Deployment

Local Network Access

To access Zorin from other devices on your network:

Find your local IP address
Update run.py to bind to 0.0.0.0
Access via http://YOUR_IP:8000

Docker Deployment

FROM python:3.9-slim

WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt

COPY . .
EXPOSE 8000

CMD ["python", "run.py"]

🔮 Roadmap

Upcoming Features

[ ] � Media Control: Spotify, YouTube Music integration
[ ] 📁 File Management: Advanced file operations and search
[ ] 🔍 Screen OCR: Text extraction from screen content
[ ] � Auto Startup:

Zorin

Install / Use

README