RealChar. - Your Realtime AI Character

🎙️🤖Create, customize and talk to your AI Character/Companion in realtime🎙️🤖

✨ Demo

Try our site at RealChar.ai

(We are also beta-testing our iOS mobile app📱! Sign up here)

Not sure how to pronounce RealChar? Listen to this 👉 audip

Demo 1 - with AI Elon about cage fight!

Demo 2 - with AI Raiden about AI and "real" memory

Demo settings: Web, GPT4, ElevenLabs with voice clone, Chroma, Google Speech to Text

🎯 Key Features

• Easy to use: No coding required to create your own AI character.
• Customizable: You can customize your AI character's personality, background, and even voice
• Realtime: Talk to or message your AI character in realtime
• Multi-Platform: You can talk to your AI character on web, terminal and mobile(Yes. we open source our mobile app)
• Most up-to-date AI: We use the most up-to-date AI technology to power your AI character, including OpenAI, Anthropic Claude 2, Chroma, Whisper, ElevenLabs, etc.
• Modular: You can easily swap out different modules to customize your flow. Less opinionated, more flexible. Great project to start your AI Engineering journey.

🔬 Tech stack

• ✅Web: React JS, Vanilla JS, WebSockets
• ✅Mobile: Swift, WebSockets
• ✅Backend: FastAPI, SQLite, Docker
• ✅Data Ingestion: LlamaIndex, Chroma
• ✅LLM Orchestration: LangChain, Chroma
• ✅LLM: OpenAI GPT3.5/4, Anthropic Claude 2
• ✅Speech to Text: Local Whisper, OpenAI Whisper API, Google Speech to Text
• ✅Text to Speech: ElevenLabs
• ✅Voice Clone: ElevenLabs

📚 Comparison with existing products

👨‍🚀 Prerequisites

Before you begin setting up this project, please ensure you have completed the following tasks:

0. Setup Tutorial

• Tutorial - YouTuBe

1. LLM - OpenAI API Token

1.1 (Optional) Prepare LLM - Anthropic(Claude 2) API Token

2. (Optional) Prepare Speech to Text - Google Cloud API

3. Prepare Text to Speech - ElevenLabs API Key

ELEVEN_LABS_API_KEY=<api key>

💿 Installation via Python

• Step 1. Clone the repo

  git clone https://github.com/Shaunwei/RealChar.git && cd RealChar

• Step 2. Install requirements
  • Install portaudio and ffmpeg for audio

  # for mac
  brew install portaudio
  brew install ffmpeg

  # for ubuntu
  sudo apt update
  sudo apt install portaudio19-dev
  sudo apt install ffmpeg

  • Then install all python requirements

  pip install -r requirements.txt

• Step 3. Create an empty sqlite database if you have not done so before

  sqlite3 test.db "VACUUM;"

• Step 4. Run db upgrade

  alembic upgrade head

  This ensures your database schema is up to date. Please run this after every time you pull the main branch.
• Step 5. Setup .env: update API keys and select module

  cp .env.example .env

• Step 6. Run server with cli.py or use uvicorn directly

  # Build the web fronend.
  python cli.py web-build

  python cli.py run-uvicorn
  # or
  uvicorn realtime_ai_character.main:app

• Step 7. Run client:
  • Use GPT4 for better conversation and Wear headphone for best audio(avoid echo)
  • There are two ways to access the web client:
    • Option 1 Open your web browser and navigate to http://localhost:8000 (NOT 0.0.0.0:8000)
      • Make sure you have ran python cli.py web-build before starting the server.
    • Option 2: Running the client in React.

      cd client/web
      npm install
      npm start

      After running these commands, a local development server will start, and your default web browser will open a new tab/window pointing to this server (usually http://localhost:3000).
    • Option 3 (experimental): Running the client in Nextjs.

      cd client/next-web
      npm install
      npm run dev

      After running these commands, a local development server will start, and your default web browser will open a new tab/window pointing to this server (usually http://localhost:3000).
  • (Optional) Terminal client: Run the following command in your terminal

  python client/cli.py

  • (Optional) mobile client: open client/mobile/ios/rac/rac.xcodeproj/project.pbxproj in Xcode and run the app
• Step 8. Select one character to talk to, then start talking

Note if you want to remotely connect to a RealChar server, SSL set up is required to establish the audio connection.

(Optional) 📀 Installation via Docker

🆕! Anyscale and LangSmith integration

ANYSCALE_ENDPOINT_API_KEY=<your API Key>

LANGCHAIN_TRACING_V2=false # default off
LANGCHAIN_ENDPOINT=https://api.smith.langchain.com
LANGCHAIN_API_KEY=YOUR_LANGCHAIN_API_KEY
LANGCHAIN_PROJECT=YOUR_LANGCHAIN_PROJECT

📍 Roadmap

• Launch v0.0.3
• Create a new character via web UI
• Add additional tts service
• Better UI/UX for home page
• Better UI/UX for conversation page
• Support MultiOn
• Support SocialAGI

🫶 Contribute to RealChar

Please check out our Contribution Guide!

💪 Contributors

🎲 Community

• Join us on Discord