Files
platform/README.md

60 lines
3.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Игровая Платформа Minecraft
[![Build Status](https://drone.mrixs.me/api/badges/minecraft-platform/platform/status.svg)](https://drone.mrixs.me/minecraft-platform/platform)
Единая платформа для создания, управления и распространения сборок Minecraft. Включает в себя систему авторизации (совместимую с Authlib Injector), управление модпаками, скинами и мониторинг игровых серверов.
---
## Возможности
### 🔐 Авторизация и Лаунчер
- **Yggdrasil API**: Полная совместимость с лаунчерами, поддерживающими Authlib Injector APIs (HMCL, Prism Launcher и др.).
- **Система профилей**: Поддержка скинов (загрузка через веб-интерфейс).
- **Восстановление сессий**: Лаунчер запоминает вход пользователя.
### 📦 Управление Модпаками
- **Автоматический импорт**: Поддержка импорта сборок с **CurseForge** и **Modrinth** (.mrpack).
- **Обновления**: Система версионирования сборок. Автоматическое обновление клиентов.
- **Оптимизация**: Дедупликация файлов для экономии места на сервере.
### 🖥️ Веб-интерфейс
- **Личный кабинет**: Управление профилем и скинами.
- **Админ-панель**: Управление пользователями, серверами и модпаками.
- **Мониторинг**: Отображение статуса серверов и онлайн-карты (**BlueMap**).
### ⚙️ Технические особенности
- **Микросервисная архитектура** (Go, Vue.js, PostgreSQL).
- **Асинхронная обработка**: Фоновые задачи для тяжелых операций (импорт сборок) с WebSocket-уведомлениями.
- **Безопасность**: JWT авторизация, Rate Limiting, защита паролей (Argon2/Bcrypt).
---
## Документация
Вся детальная документация находится в папке `docs/`:
* [🚀 Руководство по развертыванию](docs/DEPLOYMENT.md): Инструкции по установке, настройке Docker Compose и переменных окружения.
* [📖 Руководство пользователя и администратора](docs/USER_GUIDE.md): Инструкции по работе с сайтом, лаунчером и администрированию платформы.
* [🔌 OpenAPI Specification](backend/internal/api/openapi.yaml): Описание API для разработчиков.
## Быстрый старт (Dev)
```bash
# 1. Клонирование репозитория
git clone --recursive https://git.mrixs.me/minecraft-platform/platform.git
cd platform
# 2. Настройка переменных окружения
cp .env.example .env
# (Отредактируйте .env)
# 3. Генерация ключей
mkdir -p secrets
openssl genrsa -out secrets/private_key.pem 2048
openssl rsa -in secrets/private_key.pem -pubout -out secrets/public_key.pem
# 4. Запуск
docker-compose up -d --build
```