Dialogues Through Time - FastAPI Backend

Overview

This repository contains the FastAPI backend module for "Dialogues Through Time," an immersive educational game that combines historical education with interactive AI dialogues. Our backend manages game states, processes AI dialogues, and integrates with Azure services.

Link to Unity frontend

YouTube video overview

Features

• AI Dialogue Management
• LLM Constraining System
• Game State Management
• Azure OpenAI Integration

Getting Started

Prerequisites

• Python 3.8+
• FastAPI
• Uvicorn
• Azure account and Redis service

Installation

1. Clone the repository
2. Navigate to the project directory
3. Install the required packages

Environment Setup

Create a .env file in the root directory with the following structure:

AZURE_API_KEY=YourAzureApiKeyHere
API_KEY=YourApiKeyHere
REDIS_PASSWORD=YourRedisPasswordHere

Note: The above keys are placeholders. Replace them with your actual keys.

Running the Server

Run the server using Uvicorn:

uvicorn main:app --reload

Usage

Access the backend API at http://localhost:8000.

Documentation

For a detailed explanation of the backend setup and functionalities, refer to our YouTube video overview.

Architecture

• Unity Frontend Integration
• Azure Redis Cache
• LLM Constraining Module
• Azure OpenAI Service

License

This project is licensed under the MIT License.