AutoServer
Плагин для Minecraft на Velocity Proxy, который автоматически запускает бэкенд-серверы при подключении игроков и останавливает их, когда на сервере нет игроков.
- Загрузчики
- FabricPaperBukkitVelocity
- Скачиваний на Modrinth
- 3,6 тыс.
- Подписчиков на Modrinth
- 27
- версий
- 17
- Обновлён
- 9 ноября 20269 нояб.
- Опубликован
- в 2024
Коротко о моде
Ставится только на сервер; игрокам ставить не нужно
AutoServer
Обзор
AutoServer — это плагин для Minecraft, созданный для Velocity Proxy. Этот плагин автоматически запускает офлайн-серверы, когда игрок пытается к ним подключиться. Он идеально подходит для серверных сетей, желающих экономить ресурсы, держа неактивные серверы выключенными до момента необходимости.
Возможности
- Автоматически запускает бэкенд-серверы, когда игрок пытается подключиться.
- Автоматически останавливает локальные серверы, когда нет игроков онлайн.
- Запуск и остановка бэкенд-серверов вручную с помощью команд.
- Поддержка горячей перезагрузки конфигурации.
- Настраиваемые сообщения.
Начало работы
В этом разделе описано, как установить и настроить минимальную конфигурацию AutoServer.
- Загрузка AutoServer Перейдите в раздел Versions, чтобы получить последнюю версию AutoServer. После загрузки AutoServer поместите JAR-файл в директорию
pluginsвашего Velocity-прокси. - Первый запуск После того как вы поместили AutoServer в директорию
plugins, нужно перезапустить Velocity, чтобы загрузить плагин. При первом запуске AutoServer создаст файл конфигурацииautoserver/config.toml, расположенный в директорииplugins. Настройка серверов Начните с изучения вашего файла
velocity.toml, найдите раздел[servers]. Названия серверов должны точно совпадать при настройке AutoServer. Откройтеautoserver/config.tomlв текстовом редакторе и найдите раздел[servers]. Этот раздел определяет серверы, которыми будет управлять AutoServer. Создайте таблицу для каждого сервера, которым вы хотите, чтобы управлял AutoServer. Например, если у вас есть сервер с именемlobby, вы создадите таблицу[servers.lobby]. Есть два пути настройки сервера: удалённый сервер или локальный сервер. Если у вас удалённый сервер, который нужно настроить, обратитесь к разделу Remote Backend для подробностей. В рамках этого раздела мы рассмотрим локальный сервер, для которого у нас есть скрипт. Этот пример локального сервера называетсяlobby, вот минимальные настройки для запуска сервера с помощью скрипта:[servers] [servers.lobby] # Path to the directory where the server runs. workingDirectory = "/home/user/minecraft/servers/lobby" # Command to start the "lobby" server. start = "bash start.sh" # Or if you have a Windows Batch Script # start = "start.bat"- Повторите для каждого сервера Теперь повторите шаг 3 для каждого сервера, которым вы хотите, чтобы управлял AutoServer. В разделе Command examples этого документа есть множество примеров команд. Они помогут вам составить команду, подходящую для вашей ситуации.
Установка
- Скачайте последнюю версию
autoserver-velocity-1.x.x.jarиз раздела Versions. - Поместите файл
AutoServer-velocity-x.x.x.jarв папкуpluginsвашего Velocity. - Перезапустите ваш Velocity-прокси, чтобы загрузить плагин.
Конфигурация
После первого запуска плагин создаст файл config.toml в директории plugins/autoserver. Измените этот файл в соответствии с вашей конфигурацией.
Global
| Ключ | Тип | Описание |
|---|---|---|
checkForUpdates | boolean | Должен ли AutoServer проверять обновления при запуске? |
messages | table | Сообщения, которые будут отправляться игрокам. |
servers | table | Конфигурация для каждого сервера. |
Messages
| Ключ | Тип | Описание |
|---|---|---|
prefix | string | Префикс, добавляемый ко всем сообщениям, отображаемым игроку. |
starting | string | Сообщение, отображаемое игроку, когда он пытается подключиться к серверу, который сейчас офлайн. |
failed | string | Сообщение, отображаемое игроку, если сервер не удалось запустить или к нему невозможно подключиться. |
notify | string | Сообщение, отображаемое игроку, когда сервер готов, с указанием, что он будет подключён в ближайшее время. |
Servers
| Ключ | Тип | Описание |
|---|---|---|
startupDelay | int | Время в секундах, которое нужно подождать перед попыткой подключить игрока после запуска сервера. |
shutdownDelay | int | Время в секундах, которое нужно подождать перед проверкой, успешно ли завершил работу сервер. |
start | string | Команда, используемая для локального запуска сервера. |
stop | string | Команда, используемая для локальной остановки сервера. |
workingDirectory | string | Путь к директории, в которой работает сервер. |
| remote | boolean | Указывает, является ли сервер удалённым (true) или локальным (false). | | port | int | Номер порта, на котором удалённый сервер принимает команду запуска. | | preserveQuotes | boolean | (Необязательно) Управляет сохранением кавычек в начале и конце; по умолчанию кавычки удаляются в системах, отличных от Windows, если явно не задано true. | | security | boolean | Указывает, должен ли удалённый сервер использовать защиту сообщений (по умолчанию: true) | | autoShutdownDelay | int | Время (в секундах) ожидания перед автоматическим выключением сервера; установите 0, чтобы отключить эту функцию. |
Примеры команд
Вот несколько примеров команд, которые помогут составить ваши команды start и stop.
Запуск команды Java
Чтобы запустить сервер с помощью java:
start = "java -Xmx4G -Xms4G -jar server.jar nogui"По умолчанию процесс будет запущен в фоне. Если вам нужно подключиться к процессу, рассмотрите запуск в новом сеансе терминала. В Linux можно использовать x-terminal-emulator:
start = "x-terminal-emulator -e java -Xmx4G -Xms4G -jar server.jar nogui"Использование скрипта Bash или sh
Чтобы запустить скрипт с помощью Bash или sh:
start = "bash start.sh"
stop = "bash stop.sh"Использование screen
Чтобы запустить сервер в отсоединённом сеансе screen:
start = "screen -DmS mc-example java -Xmx4G -Xms4G -jar server.jar nogui"
stop = "screen -p 0 -S mc-example -X stuff \"stop\r\""Использование tmux
Чтобы запустить сервер в новом сеансе tmux:
start = "tmux new -d -s mc-example 'java -Xmx4G -Xms4G -jar server.jar nogui'"
stop = "tmux send-keys -t mc-example 'stop' C-m"Использование systemd
Если у вас есть служба systemd для вашего сервера, вы можете управлять ею так:
start = "systemctl start myserver"
stop = "systemctl stop myserver"Примечание: Возможны проблемы с правами доступа.
Использование Docker
Чтобы запустить и остановить сервер с помощью Docker:
start = "docker start mc-example"
stop = "docker stop mc-example"Windows
Использование batch-скрипта
Учтите, что он запускается в фоне.
start = "start.bat"Использование start (командная строка Windows)
Чтобы запустить сервер в новом окне командной строки:
start = "cmd /c start \"ExampleTitle\" cmd /c java -Xmx4G -Xms4G -jar server.jar nogui"Использование PowerShell
Чтобы запустить сервер в новом окне PowerShell:
start = "powershell -Command Start-Process -FilePath 'java' -ArgumentList '-Xmx4G -Xms4G -jar server.jar nogui'"Чтобы запустить сервер в скрытом окне PowerShell:
start = "powershell -WindowStyle Hidden -Command Start-Process -NoNewWindow -FilePath 'java' -ArgumentList '-Xmx4G -Xms4G -jar server.jar nogui'"Использование wt
Чтобы запустить сервер в том же окне PowerShell новой вкладкой, выполните команду вроде этой:
start = "wt -w 0 new-tab -d \"C:/path/to/directory\" \"C:/path/to/script/start.bat\""Настройка workingDirectory не будет действовать для этой команды, поэтому рабочая директория передаётся в команде.
Использование планировщика заданий
Если у вас есть запланированное задание для запуска сервера:
start = "schtasks /run /tn \"MinecraftExampleTask\""
stop = "schtasks /end /tn \"MinecraftExampleTask\""Не используйте batch-скрипт для этого задания, если хотите использовать команду stop. Она не сработает, потому что завершит batch-скрипт, но не процесс java. Настройка workingDirectory не будет действовать для этой команды. Чтобы задать рабочую директорию, откройте графический интерфейс планировщика заданий и отредактируйте задание. Там есть текстовое поле для рабочей директории под названием Start in.
Команды и разрешения
| Команда | Описание | Разрешение |
|---|---|---|
| (Нет команды, базовое разрешение) | Базовое разрешение, необходимое для доступа к любой команде | autoserver.base |
/autoserver reload | Перезагружает конфигурацию плагина. | autoserver.command.reload |
/autoserver help | Показывает меню помощи с доступными командами | autoserver.command.help |
| `/autoserver status []` | Проверяет статус указанного сервера или всех серверов, если сервер не указан | autoserver.command.status |
| `/autoserver start ` | Запускает последовательность запуска для сервера | autoserver.command.start |
| `/autoserver stop ` | Запускает последовательность остановки для сервера | autoserver.command.stop |
| `/autoserver info ` | Показывает подробную информацию об указанном сервере | autoserver.command.info |
/autoserver version | Версия плагина | autoserver.command.version |
Удалённый бэкенд
ВНИМАНИЕ: функциональность поддержки удалённых серверов, вероятно, будет меняться по мере дальнейшей разработки, учитывайте это. Поддержка удалённого бэкенда доступна для серверов PaperMC и FabricMC. Удалённый бэкенд требуется только для функциональности запуска удалённого сервера.
Скачайте со страницы версий:
- Поместите в папку
modsилиplugins. - Перезапустите сервер, чтобы сгенерировать файл конфигурации. После первого запуска плагин создаст файл
AutoServer/config.ymlв той же директории, что и JAR-файл — вmodsилиplugins. На удалённом бэкенде нужно настроить несколько параметров. Сначала задайтеserver.workingDirectoryиserver.startCommandдля запуска сервера на удалённой машине. ПараметрstartCommandподчиняется тем же правилам, что иstartдля плагина Velocity, поэтому примеры смотрите в разделе Примеры команд. РазделbootListenerменять не нужно, если только у вас не доступен другой порт для бэкенд-листенера. Бэкенд-серверы поддерживают HMAC-защиту сообщений между бэкендом и плагином Velocity. Чтобы включить эту функцию, скопируйте ключ из файлаforwarding.secretна вашей машине с Velocity. Затем установитеsecurity.enabledв true и задайтеsecurityв true для этого сервера в конфиге AutoServer для Velocity. Вот пример таблицы конфигурации для удалённого сервера с именемsurvival. Она размещается вautoserver/config.tomlна Velocity:
[servers.survival]
# Указывает, что это удалённый сервер
remote = true
# Порт, на котором удалённый сервер слушает команду запуска (по умолчанию: 8080).
port = 8080
# Время в секундах, которое нужно подождать перед попыткой подключить игрока.
# Для удалённого сервера, вероятно, стоит задать задержку подольше.
startupDelay = 120
# Включает защиту соединения с этим бэкенд-сервером.
# Если не указано, по умолчанию true.
security = trueЗатем соответствующий пример конфигурации для сервера survival. Он размещается в AutoServer/config.yml на удалённой машине:
bootListener:
# Эта команда используется для запуска boot listener, когда сервер выключен.
# Меняйте только при необходимости.
runJarCommand: "java -jar %jarName"
enabled: true
port: 8080
server:
workingDirectory: "/home/user/servers/minecraft-server/survival"
startCommand: "screen -DmS mc-example java -Xmx4G -Xms4G -jar server.jar nogui"
## Настройки безопасности
security:
# Включает HMAC-защиту передачи сообщений между бэкендом и плагином Velocity.
# Если этот параметр опущен, по умолчанию используется "true".
enabled: true
# Общий секретный ключ, используемый для HMAC-аутентификации.
# Он должен совпадать с "forwarding.secret" в конфигурационном файле вашего прокси Velocity.
# Для корректной аутентификации скопируйте значение прямо из конфига Velocity.
# Замените это на точное значение из forwarding.secret в Velocity
secret: "xxxxxxxxxxxx"Бэкенд PaperMC
Плагин PaperMC AutoServer поддерживает горячую перезагрузку файла конфигурации через команду /autoserver reload, доступную на бэкенд-сервере.
Boot Listener
Boot Listener — это программа, которая ждёт и слушает команду от плагина Velocity для запуска сервера — отсюда и название «Boot Listener». Она также включает интерфейс командной строки (CLI), так что можно выполнять команды вроде reload для горячей перезагрузки файла конфигурации без перезапуска Boot Listener. Из-за поддержки CLI, возможно, вы захотите запускать Boot Listener в терминале, который позволяет с ним взаимодействовать, а не в фоне. Для этого обратитесь к разделу Примеры команд, чтобы собрать подходящую команду, а затем обновите bootListener.runJarCommand на нужную. Например, если вы хотите использовать screen, сделайте что-то вроде этого:
bootListener:
runJarCommand: "screen -DmS boot-listener java -jar %jarName%"Устранение неполадок
- Сервер не запускается? Убедитесь, что команда
startвconfig.tomlверна и исполняема. Полезно выполнить команду в новом терминале, чтобы проверить её вывод.
Частые вопросы
Как установить AutoServer?
Установите Fabric под свою версию Minecraft, скачайте AutoServer под ту же версию и загрузчик, положите файл в папку mods и запустите игру с профилем загрузчика.
Для каких версий Minecraft есть AutoServer?
У AutoServer есть сборки для Minecraft 1.7.2–26.3.
Нужен ли AutoServer на сервере?
Ставится только на сервер; игрокам ставить не нужно