docs: add user and admin guide

This commit is contained in:
2026-01-06 19:30:47 +03:00
parent 6d2fab922e
commit 805e1a2791

54
docs/USER_GUIDE.md Normal file
View File

@@ -0,0 +1,54 @@
# Руководство пользователя и администратора
## Для Пользователей
### Регистрация и Вход
1. Перейдите на страницу регистрации.
2. Введите имя пользователя, email и пароль.
3. После регистрации используйте email и пароль для входа.
### Управление профилем (Скины)
1. В личном кабинете вы можете загрузить **Скин** для вашего персонажа.
2. Поддерживаются стандартные PNG файлы скинов.
3. Загруженный скин будет автоматически отображаться в игре на серверах платформы.
### Использование Лаунчера
1. Скачайте наш кастомный лаунчер (на базе HMCL).
2. Запустите лаунчер.
3. Выберите метод авторизации: **Authlib Injector** (или Yggdrasil).
4. Введите адрес API платформы (например, `https://yourdomain.com/api/yggdrasil` - уточните у администратора).
5. Введите ваши Email и Пароль от платформы.
6. Выберите нужный модпак из списка и нажмите "Играть".
---
## Для Администраторов
Административный интерфейс доступен пользователям с ролью `admin`.
### Управление Модпаками
В разделе "Модпаки" вы можете добавлять новые сборки и обновлять существующие.
#### Импорт нового модпака
1. Нажмите "Импорт модпака".
2. Выберите тип импортера:
- **Simple ZIP**: Обычный архив с файлами игры.
- **CurseForge**: Импорт по ссылке или файлу манифеста CurseForge.
- **Modrinth**: Импорт `.mrpack` файлов.
3. Загрузите файл или укажите URL (для CurseForge).
4. Система запустит фоновую задачу по скачиванию и обработке файлов. Следите за прогресс-баром.
#### Обновление модпака
1. В списке модпаков нажмите кнопку "Обновить" напротив нужной сборки.
2. В модальном окне выберите новый файл обновления (например, новую версию `.mrpack` или ZIP).
3. При желании измените версию Minecraft.
4. После подтверждения, система удалит старые файлы сборки и загрузит новые. Клиенты получат обновление автоматически при следующем запуске лаунчера.
### Управление Пользователями
1. В разделе "Пользователи" отображается список всех зарегистрированных игроков.
2. Вы можете менять роли пользователей (например, выдать права администратора) через меню действий.
### Игровые Сервера и Карта
1. В разделе "Сервера" отображается статус подключенных игровых серверов (онлайн, игроки).
2. Если для сервера настроен **BlueMap**, появится кнопка "Карта мира", открывающая веб-карту в браузере.