Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/achraf-oujjir/profgpt-smart-vr-professor
👨🏫🤖 ProfGPT: AI-powered VR professor with electrical circuits lab table ⚡💡 Built with Unity 🎮 GPT and Whisper APIs 🧠 and AWS Polly 🦜🗣️
https://github.com/achraf-oujjir/profgpt-smart-vr-professor
ai-education aws-polly chatgpt-api csharp education oculus-quest-2 openai-api openai-whisper speech-to-text text-to-speech unity3d virtual-reality vr whisper
Last synced: about 2 months ago
JSON representation
👨🏫🤖 ProfGPT: AI-powered VR professor with electrical circuits lab table ⚡💡 Built with Unity 🎮 GPT and Whisper APIs 🧠 and AWS Polly 🦜🗣️
- Host: GitHub
- URL: https://github.com/achraf-oujjir/profgpt-smart-vr-professor
- Owner: achraf-oujjir
- License: gpl-3.0
- Created: 2024-08-23T00:18:41.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-08-24T23:57:16.000Z (4 months ago)
- Last Synced: 2024-11-03T11:02:41.495Z (about 2 months ago)
- Topics: ai-education, aws-polly, chatgpt-api, csharp, education, oculus-quest-2, openai-api, openai-whisper, speech-to-text, text-to-speech, unity3d, virtual-reality, vr, whisper
- Language: Smalltalk
- Homepage:
- Size: 111 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 👨🏫🤖 ProfGPT: Virtual Reality Education with AI-powered Virtual Teacher 🧠
## 🎯 Project Overview
ProfGPT is a virtual reality (VR) educational application developed for Oculus Quest 2. It offers an immersive learning experience for users to explore and experiment with electrical circuits in a virtual lab environment. The highlight of the application is ProfGPT, an AI-powered virtual teacher who guides users through the learning process using natural language interaction (English or French).
## 🚀 Features
- 🔌 **Interactive Electrical Circuits Lab**: Experiment with a wide range of electrical components to build and explore circuits in a realistic 3D setting.
- 🤖 **AI-powered Virtual Instructor**: ProfGPT guides users with spoken explanations, utilizing ChatGPT, Whisper, and AWS Polly to answer questions.
- 🎮 **Immersive VR Learning**: Designed for Oculus Quest 2, offering an engaging and hands-on learning experience in virtual reality.
- 🗣️ **Natural Language Assistance**: Voice queries are seamlessly processed via Whisper, ChatGPT, and AWS Polly for a smooth interactive experience.
## 🏗️ Architecture
The application architecture is divided into two key components:
1. **Virtual Lab Table**: A space where users can interact with various electrical components to build circuits.
2. **ProfGPT**: An intelligent virtual teacher built using APIs for speech recognition, natural language processing, and text-to-speech services.
The architecture leverages several APIs:
- **Whisper** (speech-to-text)
- **ChatGPT** (AI conversational responses)
- **AWS Polly** (text-to-speech)
## 🛠️ Implementation
ProfGPT uses a modular architecture where each component is responsible for specific interactions:
1. **Speech Recognition**: The user records their voice, which is sent to Whisper by OpenAI for transcription.
2. **AI Interaction**: The transcribed text is sent to ChatGPT to generate a response.
3. **Speech Synthesis**: The AI's response is converted back into speech using AWS Polly and played for the user.
### 🔑 Key Technologies:
- **Unity** for the VR environment
- **OpenAI's Whisper and ChatGPT** for smart voice interaction
- **AWS Polly** for text-to-speech synthesis
### 🔧 APIs & Services Used
- **Whisper**: Converts audio input to text using state-of-the-art speech recognition.
- **AWS Polly**: Provides natural-sounding text-to-speech conversion to generate responses from ProfGPT.
- **ChatGPT**: AI-powered responses to user queries, allowing natural language interaction.
### 📦 Plugins & Packages
- **[ReadyPlayerMe](https://readyplayer.me/)**: Used to create the ProfGPT avatar.
- **[OpenAI-Unity](https://github.com/srcnalt/OpenAI-Unity)**: For integrating OpenAI models (Whisper and ChatGPT) with Unity.
- **XR Interaction Toolkit**: Facilitates interactions within the VR environment.
- **[Mixamo](https://www.mixamo.com/)**: Provides animations for ProfGPT’s avatar.
## 🧪 Virtual Lab Table
The virtual lab table was imported from [this repo](https://github.com/Schackasawa/faraday) and it contains various components for users to build electrical circuits. Users can interact with components like:
- 💡 Bulbs
- 🔋 Batteries
- 🌞 Solar Panels
These components can be picked up and placed on the lab table to form functioning circuits.
## 🤖 ProfGPT: Avatar & Configuration
ProfGPT is designed using the ReadyPlayerMe platform, and the avatar is integrated with Unity via the ReadyPlayerMe SDK. The avatar used has the following glb url:
```https://models.readyplayer.me/644c3d00b7a1ed40a46033c9.glb```
The avatar can:
- Hear user queries using Whisper.
- Respond to users using ChatGPT and AWS Polly.
The following scripts are essential:
- `ProfFrGPT.cs`: Manages interactions between the user and ProfGPT, including sending audio to APIs and handling responses.
- `ProfUI.cs`: Manages the GUI for recording voice input and displaying ProfGPT’s responses.
## 📸 Media
We can see the structure of the scene next to the ProfGPT avatar
ProfGPT next to the lab table. Any question can be asked to ProfGPT and we can see it written in the UI.
This is a side-view of the lab table.
## 📚 References
- [Faraday Virtual Lab Table](https://github.com/Schackasawa/faraday) - Credit to the creator for providing the virtual lab table asset used in this project.
- [OpenAI-Unity GitHub Repo](https://github.com/srcnalt/OpenAI-Unity) - Credit to the developer for making it easier to integrate OpenAI's models with Unity.
- [Sgt3v YouTube Channel](https://www.youtube.com/@sgt3v) - Special thanks to Sgt3v for providing invaluable tutorials on developing smart VR NPCs powered by GPT. Check out his channel for amazing content!
## ⚠️ Notice
**This project is incomplete.** The repository contains all the files I could retrieve from the original project. Due to the age of the project, some assets and code might be missing or outdated. Please take this into consideration when reviewing or attempting to use the code.