README

# Lorescribe 🎙️

A Discord bot that records, transcribes, and summarizes voice channel conversations using AI.

## 🚀 Quick Start

### Prerequisites

Before you begin, ensure you have the following installed:
- [Node.js](https://nodejs.org/) (v16 or higher)
- [pnpm](https://pnpm.io/) - Fast, disk space efficient package manager
- [Docker](https://www.docker.com/) - For running required services

### Account Configuration

1. Create a new Discord bot and get the token (https://discordpy.readthedocs.io/en/stable/discord.html)
2. Create a new or use an existing OpenAI account and get the API key (https://platform.openai.com/docs/guides/chat/introduction)

### Setup & Installation

1. **Install Dependencies**
   ```bash
   pnpm install
   ```

2. **Start Required Services**
   ```bash
   docker compose up -d
   ```

3. **Launch the Bot**
   ```bash
   pnpm start
   ```

4. **Deploy Commands**
   ```bash
   node src/deploy-commands.js
   ```

## 💡 Tips
- Make sure to set up your environment variables in `.env` file
- You'll need a Discord bot token and OpenAI API key to get started
- Check out our documentation for advanced configuration options

## 🤝 Contributing
We welcome contributions! Feel free to open issues and pull requests.