docs: add core-specific usage guides (RU/EN)
This commit is contained in:
213
docs/USAGE.ru.md
Normal file
213
docs/USAGE.ru.md
Normal file
@@ -0,0 +1,213 @@
|
||||
# Руководство по использованию AstraDeploy
|
||||
|
||||
Мини-гайды по каждому поддерживаемому ядру.
|
||||
|
||||
## Общие правила
|
||||
|
||||
- Для интерактива удобно:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh --easy --core <core>
|
||||
```
|
||||
|
||||
- Для автоматизации/бота обязательно добавляйте:
|
||||
|
||||
```bash
|
||||
--yes --accept-license yes
|
||||
```
|
||||
|
||||
- Для Java-ядер ещё:
|
||||
|
||||
```bash
|
||||
--accept-eula yes
|
||||
```
|
||||
|
||||
- Рекомендуется явно задавать режим сервиса:
|
||||
|
||||
- `tmux-systemd` (рекомендованный UX)
|
||||
- `systemd`
|
||||
- `screen`
|
||||
- `none` (только подготовка)
|
||||
|
||||
## Java-ядерные
|
||||
|
||||
### Paper (`--core paper`)
|
||||
|
||||
- Easy:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh --easy --core paper --service tmux-systemd
|
||||
```
|
||||
|
||||
- Non-interactive:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh \
|
||||
--yes \
|
||||
--core paper \
|
||||
--dir /opt/minecraft/paper \
|
||||
--service systemd \
|
||||
--ram 4G \
|
||||
--port 25565 \
|
||||
--accept-eula yes \
|
||||
--accept-license yes \
|
||||
--firewall yes \
|
||||
--locale ru
|
||||
```
|
||||
|
||||
### Purpur (`--core purpur`)
|
||||
|
||||
- Easy:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh --easy --core purpur --service tmux-systemd
|
||||
```
|
||||
|
||||
- Non-interactive:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh \
|
||||
--yes \
|
||||
--core purpur \
|
||||
--dir /opt/minecraft/purpur \
|
||||
--service tmux-systemd \
|
||||
--ram 4G \
|
||||
--port 25565 \
|
||||
--accept-eula yes \
|
||||
--accept-license yes \
|
||||
--firewall yes \
|
||||
--locale ru
|
||||
```
|
||||
|
||||
### Velocity (`--core velocity`)
|
||||
|
||||
- Easy:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh --easy --core velocity --service tmux-systemd
|
||||
```
|
||||
|
||||
- Non-interactive:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh \
|
||||
--yes \
|
||||
--core velocity \
|
||||
--dir /opt/minecraft/velocity \
|
||||
--service tmux-systemd \
|
||||
--ram 2G \
|
||||
--port 25577 \
|
||||
--accept-eula yes \
|
||||
--accept-license yes \
|
||||
--firewall yes \
|
||||
--locale ru
|
||||
```
|
||||
|
||||
### PowerNukkitX (`--core powernukkitx`)
|
||||
|
||||
- Easy:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh --easy --core powernukkitx --service tmux-systemd
|
||||
```
|
||||
|
||||
- Non-interactive:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh \
|
||||
--yes \
|
||||
--core powernukkitx \
|
||||
--dir /opt/minecraft/powernukkitx \
|
||||
--service systemd \
|
||||
--ram 2G \
|
||||
--port 19132 \
|
||||
--accept-eula yes \
|
||||
--accept-license yes \
|
||||
--firewall yes \
|
||||
--locale ru
|
||||
```
|
||||
|
||||
## Bedrock PHP-ядра
|
||||
|
||||
### PMMP (`--core pmmp`)
|
||||
|
||||
- Easy:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh --easy --core pmmp --service tmux-systemd
|
||||
```
|
||||
|
||||
- Non-interactive:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh \
|
||||
--yes \
|
||||
--core pmmp \
|
||||
--dir /opt/minecraft/pmmp \
|
||||
--service tmux-systemd \
|
||||
--port 19132 \
|
||||
--accept-license yes \
|
||||
--firewall yes \
|
||||
--locale ru
|
||||
```
|
||||
|
||||
### NetherGamesMC (`--core nethergamesmc`)
|
||||
|
||||
Доп. опции:
|
||||
|
||||
- `--build` — тег PHP-билда (`latest` или конкретный).
|
||||
- `--mc-version` — версия/тег PocketMine-MCPE (`latest` или конкретный).
|
||||
|
||||
- Easy:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh --easy --core nethergamesmc --service tmux-systemd
|
||||
```
|
||||
|
||||
- Non-interactive:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh \
|
||||
--yes \
|
||||
--core nethergamesmc \
|
||||
--dir /opt/minecraft/nethergamesmc \
|
||||
--service screen \
|
||||
--build latest \
|
||||
--mc-version latest \
|
||||
--accept-license yes \
|
||||
--firewall yes \
|
||||
--locale ru
|
||||
```
|
||||
|
||||
### Рекомендуемый порядок статусов для бота
|
||||
|
||||
Удобно отправлять пользователю:
|
||||
|
||||
1. "preflight"
|
||||
2. "package install"
|
||||
3. "core download/build"
|
||||
4. "service configured"
|
||||
5. "finished"
|
||||
|
||||
Или использовать callback:
|
||||
|
||||
- `started`
|
||||
- `step`
|
||||
- `success`
|
||||
- `failed`
|
||||
|
||||
## Режим обновления
|
||||
|
||||
Для обновления уже установленного каталога:
|
||||
|
||||
```bash
|
||||
sudo bash install.sh \
|
||||
--update \
|
||||
--core <core> \
|
||||
--dir /opt/minecraft/<core> \
|
||||
--yes \
|
||||
--accept-license yes
|
||||
```
|
||||
|
||||
Для Java-ядер добавляйте `--accept-eula yes`.
|
||||
|
||||
Reference in New Issue
Block a user