🤖 NYRA AI - Neural Your Reality Assistant

⚡ Private • 🎯 Powerful • 🎭 Personal

Features • Installation • Usage • Documentation • Contributing

---

🌟 Overview

NYRA (Neural Your Reality Assistant) is a complete, production-level, local-first AI operating system designed to be your personal desktop partner. Unlike traditional chatbots, NYRA integrates deeply with your system, offering voice interaction, intelligent automation, memory management, and an expressive anime avatar.

Core Identity

• Name: NYRA
• Type: Local AI Partner Assistant
• Voice: Female, cute, expressive (via TTS)
• Avatar: Anime-style (VTuber/VRM compatible)
• Personality: Calm, Intelligent, Supportive, Slightly Playful
• Languages: English, Banglish, Bengali (বাংলা)
• Privacy: 100% local-first, no secret tracking

---

✨ Highlights

🧠 Smart AI	🎤 Voice Enabled	🎭 Anime Avatar	🔒 100% Private
Powered by Gemini 2.0	Offline + Online TTS/STT	VRM Model Support	Local-First Design

---

🚀 Features

🧠 AI Brain

• ✅ Gemini Integration: Uses Google's Gemini 2.0 Flash models
• ✅ Automatic Model Routing: Primary, fallback, and reasoning models
• ✅ Context Memory: Short-term (RAM) + Long-term (ChromaDB)
• ✅ Multi-language: Detects English, Banglish, and Bengali
• ✅ Smart Responses: Context-aware conversations

🎤 Voice Interface

• ✅ Offline STT: VOSK for speech recognition
• ✅ Expressive TTS: pyttsx3 (offline) + Gemini TTS (online)
• ✅ Hands-free Operation: Full voice command support
• ✅ Multi-language Voice: English, Bengali, Banglish
• ✅ Wake Word Detection: Custom activation phrase

🎭 Avatar System

• ✅ Anime Character: VRM model support (VTuber-ready)
• ✅ Emotion Engine: Reacts to user sentiment in real-time
• ✅ Lip Sync: Audio-driven mouth animations
• ✅ Idle Animations: Breathing, blinking, subtle movements
• ✅ Customizable: Change avatar expressions and states

🖥️ System Control

• ✅ Application Management: Open/close apps with voice or text
• ✅ System Commands: Shutdown, restart, sleep, lock
• ✅ File Operations: Create, move, delete files/folders
• ✅ System Monitoring: Real-time CPU, RAM, disk usage
• ✅ Smart Automation: Schedule tasks and reminders

🌐 Services & Integrations

• ✅ Web Search: Google search integration
• ✅ Weather: Real-time weather via wttr.in
• ✅ WhatsApp: Browser automation for messaging
• ✅ Notes & Reminders: Local JSON storage
• ✅ PDF Generation: Create documents from text
• ✅ Email: Send/receive emails (coming soon)

💻 Coding Tools

• ✅ Code Writer: Generate code in any language
• ✅ Debugger: Analyze errors and suggest fixes
• ✅ Code Explainer: Understand complex code
• ✅ Project Analyzer: Analyze entire codebases
• ✅ Refactoring: Improve code quality

👁️ Vision Capabilities

• ✅ Screen Capture: Take screenshots on command
• ✅ OCR: Extract text from screen (Tesseract)
• ✅ Image Analysis: Understand images (coming soon)

---

📸 Screenshots

Main Dashboard

Voice Interaction

Avatar Hologram

---

🎯 Use Cases

• 💼 Productivity: Automate daily tasks, manage files, set reminders
• 🎓 Learning: Code assistant, research helper, language translation
• 🎮 Entertainment: Tell jokes, play music, chat casually
• 🔧 Development: Debug code, write documentation, analyze projects
• 🌐 Communication: Send messages, check weather, web search

---

• Error Detection: Automatically find errors on screen

😄 Personality

• Humor Engine: Light jokes and playful responses
• Emotion Detection: Understands user mood
• Adaptive Responses: Adjusts tone based on context

---

📦 Installation

Prerequisites

• Python 3.11+ (Python 3.13 recommended)
• Windows OS (tested on Windows 11)
• Gemini API Key (Get it here)

Step 1: Clone Repository

git clone <your-repo-url>
cd NYRA_OS

Step 2: Create Virtual Environment

python -m venv venv
venv\Scripts\activate

Step 3: Install Dependencies

pip install -r requirements.txt

Step 4: Configure Environment

Open .env and add your API key:

GEMINI_API_KEY=YOUR_ACTUAL_API_KEY_HERE
USER_NAME=YourName
AI_NAME=NYRA

Step 5: Optional Assets

• VOSK Model: Download vosk-model-small-en-us-0.15 and extract to model/
• VRM Avatar: Place your .vrm file at avatar/assets/nyra.vrm
• Tesseract OCR: Install from here for vision features

---

🎮 Usage

Launch NYRA

python main.py

First Boot

You'll see a cyberpunk-style boot sequence:

1. "Initializing NYRA..."
2. "Loading memory modules..."
3. "Neural link established..."
4. Dashboard opens

Interface

• Top Bar: Time (12-hour AM/PM), Status, Mood
• Left Panel: System stats (CPU, RAM, Disk)
• Center: Avatar hologram with emotion display
• Right Panel: Communication log (chat history)
• Bottom Bar: Text input + Voice button

Commands

Type or speak:

• "What time is it?" → Shows current time
• "Tell me a joke" → Returns a programming joke
• "Open browser" → Launches default browser
• "Weather" → Gets current weather
• "Search for Python tutorials" → Opens Google search
• "Write Python code for sorting" → Generates code
• "Shutdown" → Powers off PC (use carefully!)

Note on Voice Commands: Text input works 100%. Voice commands require a microphone and Google Speech API access. If voice doesn't work, just use text input—all features work identically! See VOICE_SETUP_GUIDE.py for troubleshooting.

---

🏗️ Architecture

NYRA_OS/
├── main.py              # Entry point
├── boot/                # Startup loader
├── core/                # Brain, orchestrator, language, emotion
├── ui/                  # PyQt6 dashboard and widgets
├── voice/               # STT (VOSK) and TTS (pyttsx3)
├── avatar/              # VRM engine, emotions, lip-sync
├── memory/              # Short-term + ChromaDB long-term
├── system/              # OS control, monitoring, files
├── services/            # Web search, weather, messaging
├── coding/              # Code assistant
├── documents/           # Notes, PDF generation
├── vision/              # Screen capture, OCR
├── humor/               # Jokes and playfulness
├── utils/               # Logger
└── config/              # Settings

---

🎨 Customization

Change Theme Colors

Edit ui/styles/theme.qss:

/* Primary cyan */
color: #00ffcc;

/* Accent pink */
color: #ff007f;

Adjust Personality

Modify core/brain.py system instruction:

system_instruction = f"""
You are {Config.AI_NAME}...
Personality: [Your custom traits here]
"""

Add New Commands

Edit core/router.py:

if 'my_command' in text_lower:
    return {'type': 'custom', 'action': 'my_action'}

---

🛠️ Troubleshooting

Issue: API Key Error

Solution: Ensure GEMINI_API_KEY is set correctly in .env

Issue: Voice Not Working

Solution: Download VOSK model and update path in .env

Issue: TTS Not Speaking

Solution: Check audio drivers, try running as Administrator

Issue: ImportError

Solution: Ensure all dependencies installed:

pip install -r requirements.txt

Issue: PyQt6 Display Problems

Solution: Update graphics drivers, run in compatibility mode

---

📝 Roadmap

• Multi-modal input (image + text)
• Plugin system for extensibility
• Mobile companion app
• Advanced VRM rendering with OpenGL
• Proactive suggestions based on usage patterns
• Calendar and schedule integration
• Email management
• Real-time translation

---

🤝 Contributing

Contributions welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Submit a pull request with clear description

---

📄 License

MIT License - See LICENSE file for details

---

🙏 Credits

• AI Model: Google Gemini
• UI Framework: PyQt6
• Voice: VOSK, pyttsx3
• Memory: ChromaDB

---

👨‍💻 Developer

Salah Uddin Kader

• GitHub: @salahuddingfx
• Email: salauddinkaderappy@gmail.com
• Project: NYRA AI - Personal AI Assistant

---

💬 Support

For issues, questions, or feature requests:

• Open an issue on GitHub: NYRA_AI Issues
• Email: salauddinkaderappy@gmail.com
• Discussions: GitHub Discussions

---

⚡ NYRA - Your Local AI Partner. Private. Powerful. Personal.

Made with ❤️ by Salah Uddin Kader