# Getting Started with Yemaya

Welcome to Yemaya - the comprehensive platform for end-to-end movie and game
creation. This guide will help you get up and running quickly.

## Overview

Yemaya integrates game engines (Blender, Godot, Unreal), AI services, and
creative production tools into a unified ecosystem. Whether you're building a
game, creating a film, or producing animated content, Yemaya provides the tools
you need.

## Quick Start

### Prerequisites

Before you begin, ensure you have the following installed:

- **Node.js** 20+ ([Download](https://nodejs.org/))
- **pnpm** 10+ (`npm install -g pnpm`)
- **Docker** & Docker Compose ([Download](https://docker.com/))
- **Git** ([Download](https://git-scm.com/))

Optional (for full engine integration):

- Blender 4.0+
- Godot 4.2+
- Unreal Engine 5.3+

### Installation

1. **Clone the repository**

   ```bash
   git clone https://github.com/yemaya/yemaya.git
   cd yemaya
   ```

2. **Install dependencies**

   ```bash
   pnpm install
   ```

3. **Start infrastructure services**

   ```bash
   docker compose up -d
   ```

   This starts:
   - PostgreSQL (database)
   - Redis (caching)
   - MinIO (object storage)
   - Mailpit (email testing)

4. **Configure environment**

   ```bash
   cp .env.example .env
   ```

   Edit `.env` with your API keys:
   - `ANTHROPIC_API_KEY` - For AI text generation
   - `OPENAI_API_KEY` - For AI capabilities
   - `GOOGLE_API_KEY` - For Gemini models

5. **Run database migrations**

   ```bash
   pnpm --filter @yemaya/database db:migrate
   ```

6. **Start the development server**
   ```bash
   pnpm dev
   ```

### Accessing the Application

After starting, access:

| Service       | URL                        | Description        |
| ------------- | -------------------------- | ------------------ |
| Web App       | http://localhost:5173      | Main web interface |
| API           | http://localhost:3000      | REST API           |
| API Docs      | http://localhost:3000/docs | Swagger UI         |
| MinIO Console | http://localhost:9001      | Object storage     |
| Mailpit       | http://localhost:8025      | Email testing      |

## Project Structure

```
yemaya/
├── apps/                    # Deployable applications
│   ├── api/                 # Hono REST API server
│   ├── web/                 # React + Vite web application
│   ├── desktop/             # Electron desktop app
│   └── cli/                 # CLI tool
├── packages/                # Shared libraries
│   ├── types/               # TypeScript type definitions
│   ├── core/                # Core utilities
│   ├── database/            # Database (Prisma)
│   ├── ai/                  # AI provider integrations
│   ├── agents/              # Multi-agent orchestration
│   ├── ui/                  # React component library
│   ├── blender/             # Blender integration
│   ├── godot/               # Godot integration
│   ├── unreal/              # Unreal Engine integration
│   ├── collaboration/       # Real-time collaboration
│   ├── audio/               # Audio processing
│   ├── video/               # Video processing
│   ├── assets/              # Asset management
│   └── pre-production/      # Scriptwriting & storyboards
├── configs/                 # Shared configurations
│   ├── typescript/          # TypeScript configs
│   ├── eslint/              # ESLint rules
│   └── testing/             # Test configurations
├── infrastructure/          # Deployment configs
│   ├── kubernetes/          # K8s manifests
│   ├── helm/                # Helm charts
│   └── terraform/           # Infrastructure as code
└── docs/                    # Documentation
```

## Core Concepts

### Projects

Projects are the top-level containers for your creative work. Each project can
be:

- A game project (integrates with Godot/Unreal)
- A film project (integrates with Blender/DaVinci)
- An animation project
- A mixed-media project

### Assets

Assets are the building blocks of your project:

- 3D models
- Textures and materials
- Audio files
- Video clips
- Scripts and dialogue
- Character definitions

### AI Agents

Yemaya includes AI agents that help automate creative tasks:

- **Script Writer** - Generates dialogue and scripts
- **Character Designer** - Creates character concepts
- **Scene Composer** - Arranges scene elements
- **Sound Designer** - Generates and edits audio
- **Quality Reviewer** - Reviews and suggests improvements

### Real-time Collaboration

Work with your team in real-time:

- Concurrent editing with conflict resolution
- Change tracking and history
- Comments and annotations
- Role-based permissions

## Next Steps

- [Create Your First Project](./first-project.md)
- [Working with AI Agents](./ai-agents.md)
- [Engine Integration](./engine-integration.md)
- [Collaboration Guide](./collaboration.md)
- [Video Tutorial Series](../video-tutorials/README.md)
- [API Reference](../api/README.md)

## Getting Help

- **Documentation**: https://docs.yemaya.io
- **GitHub Issues**: https://github.com/yemaya/yemaya/issues
- **Discord**: https://discord.gg/yemaya
- **Email**: support@yemaya.io

## License

Yemaya is open-source software licensed under the MIT License.
