NarrateXAI

NarrateXAI is a Text-to-Video AI Agent Storyline Framework, built on top of the powerful PydanticAI framework. It brings your narratives to life by combining character-driven storytelling with cutting-edge AI technology.

---

Overview

Features

Feature	Description
Character Lore	Define rich, structured backstories and traits for your AI agents to enhance storytelling depth.
Prompt Classification AI Agent	Automatically classify user prompts into categories like "Chat" or "Vision" for tailored responses.
Character AI Agents	Generate responses based on the defined character lore, ensuring consistency in personality.
Text-to-Video AI Agent	Convert narrative responses into videos using integrated text-to-video APIs like CogVideo, Sora, or Veo.*
Text-to-Video Prompt Generator	Create detailed prompts for external text-to-video services when visual storytelling is needed.
API Integration	Seamlessly integrates with text-to-video AI providers (e.g., CogVideoX, Sora*, Veo*) to generate dynamic visuals.
X Bot Integration	Extract data from X (formerly Twitter) and send AI-generated responses or visual content directly to X, automating social media interactions.

*API availability may vary based on provider support.

Additional Feature: X Bot Integration

Sub-Feature	Description
Data Extraction from X	Automate mentions tweet data scraping or retrieval from X (formerly Twitter).
AI Response Automation	Generate and send AI-crafted responses to mentions, comments, or messages on X.
Content Posting	Automatically post AI-generated content, such as text or videos, directly to X.

---

Use Cases

• Chatbots: Create conversational agents with personality and visual appeal.
• Social Media AI Agents: Build engaging AI-driven content creators.
• Creative Storytelling: Develop immersive storylines and bring them to life with visuals.
• Educational Tools: Visualize lessons with AI-crafted characters.
• Gaming Prototypes: Define characters and scenes for RPGs or narrative-driven games.

---

Quick Start Guide

Prerequisites

• Python 3.10+
• Chromedriver

---

Installation

1. Clone the Repository:

   git clone https://github.com/NarrateXAI/NarrateX.git
   cd NarrateX

2. Set Up a Virtual Environment (Optional):

   python -m venv myenv

   Activate the virtual environment:

   • On macOS or Linux:

     source myenv/bin/activate

   • On Windows:

     # CMD
     myenv\Scripts\activate.bat
     # PowerShell
     .\myenv\Scripts\Activate.ps1

3. Install Dependencies:

   pip install -r requirements.txt

4. Configure the Environment:
   Copy the example environment file:

   cp .env.example .env

   Edit .env to configure:

   • AI API Key
   • X account details (optional)
   • Chromedriver path

5. Customize Your Agent:
   Open /starter/char.py to configure your own character using the Character Lore Template.

6. Start the Agent:
   Run the starter script to interact with your AI agent:

   python -m starter.simple_chat.py

---

Congratulations!

Your AI Agent is ready. Start interacting with a personalized agent powered by NarrateXAI!

---

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Support

For questions or issues, visit our GitHub repository or open an issue.