Avatar Chatbot Setup

Table of Contents

1. Overview
2. Virtual Girlfriend Frontend
   • Features
   • Prerequisites
   • Installation
   • Usage
   • Available Scripts
3. Virtual Girlfriend Backend
   • Features
   • Prerequisites
   • Installation
   • Usage
   • API Endpoints
   • Development
4. References
5. License

Overview

Experience the future of companionship with an AI-powered 3D virtual chatbot. Engage in lifelike conversations, enjoy emotional interactions, and immerse yourself in a hyper-realistic experience. With stunning visuals, adaptive intelligence, and a natural voice, your virtual companion is just a chat away! 💕

Virtual Girlfriend Frontend

This is the frontend service for the Virtual Girlfriend application. It provides a user interface for interacting with the virtual avatar, supporting real-time chat, audio playback, and lip-sync animations.

Features

• Chat Interface: Allows users to send and receive messages.
• Audio Playback: Plays generated speech from the backend.
• Lip-Syncing: Displays avatar animations based on audio responses.
• Facial Expressions and Animations: Enhances interactivity with dynamic visuals.

Prerequisites

• Node.js (v16 or higher)
• React.js (latest version)
• A running instance of the Virtual Girlfriend backend

Installation

1. Clone the repository:

   git clone https://github.com/satyamshorrf/virtual-girlfriend.git
   cd frontend

2. Install dependencies:

   npm install

3. Create a .env file in the frontend directory and add the backend API URL:

   REACT_APP_BACKEND_URL=http://localhost:3000

Usage

Start the frontend server:

npm start

The frontend will run on http://localhost:5173 (or another port if specified).

Available Scripts

npm start

Runs the app in development mode.

npm run build

Builds the app for production.

npm test

Runs the test suite.

Virtual Girlfriend Backend

This is the backend service for the Virtual Girlfriend application. It handles chat interactions, audio generation, and lip-syncing for the virtual avatar.

Features

• Chat Integration: Uses OpenAI's GPT-3.5-turbo for generating conversational responses.
• Text-to-Speech: Converts text responses into audio using the ElevenLabs API.
• Lip-Syncing: Generates lip-sync data for the avatar using Rhubarb Lip Sync.
• Facial Expressions and Animations: Supports dynamic facial expressions and animations for the avatar.

Prerequisites

• Node.js (v16 or higher)
• API keys for:
  • OpenAI
  • ElevenLabs
• Ensure ffmpeg and rhubarb are installed and available in your system's PATH.

Installation

1. Clone the repository:

   git clone https://github.com/satyamshorrf/virtual-girlfriend.git
   cd backend

2. Install dependencies:

   npm install

3. Create a .env file in the backend directory and add the following:

   OPENAI_API_KEY=your_openai_api_key
   ELEVEN_LABS_API_KEY=your_elevenlabs_api_key

Usage

Start the backend server:

npm run dev

The server will run on http://localhost:3000.

API Endpoints

GET /

Returns a simple "Hello World!" message.

GET /voices

Fetches available voices from the ElevenLabs API.

POST /chat

Handles chat requests. Accepts a JSON payload:

{
  "message": "Hello!",
  "user_id": "12345"
}

Returns a JSON response with text, audio, lip-sync data, facial expressions, and animations.

Development

Use nodemon for hot-reloading during development:

npm install -g nodemon
nodemon index.js

References

• Ready Player Me
• Virtual Girlfriend GitHub
• gltfjsx
• Rhubarb Lip Sync

License

This project is licensed under the MIT License.

---

Contributing to Virtual Girlfriend

Thank you for considering contributing to this project! We welcome contributions from everyone. Please follow the guidelines below to ensure smooth collaboration.

How to Contribute

1. Fork the Repository: Click on the Fork button at the top-right corner of the repository page to create a copy of the repository in your GitHub account.

2. Clone Your Fork: Clone your fork to your local machine using:

   git clone https://github.com/satyamshorrf/virtual-girlfriend.git

3. Create a Branch: Create a new branch for your changes:

   git checkout -b feature-branch

4. Make Changes: Implement your changes or improvements.

5. Commit Your Changes: Write a clear commit message:

   git commit -m "Added feature XYZ"

6. Push to Your Fork: Push the branch to your forked repository:

   git push origin feature-branch

7. Submit a Pull Request: Go to the original repository and open a Pull Request (PR) with a clear description of the changes you made.

Code of Conduct

• Be respectful to other contributors.
• Follow the project's coding standards.
• Keep commits and pull requests well-documented.

Issues & Bug Reports

If you find any bugs or issues, please open an issue in the repository and describe the problem clearly.

Contributors

We appreciate all contributions! If you contribute, feel free to add your name below:

1. Satyam Kumar
2. Rajesh Kumar
3. Pratik Kumar
4. Sandeep Kumar
5. Kajal Kumari
6. Kajal Kumari

License

By contributing to this project, you agree that your contributions will be licensed under the project's existing license.

Thank you for your contributions! 🚀

---