diff --git a/README.MD b/README.MD index 968e795..352a11a 100644 --- a/README.MD +++ b/README.MD @@ -4,22 +4,104 @@ ![codename: ZERO](https://img.shields.io/badge/codename-ZERO-509.svg?style=flat) ![protocol: 1.12.2](https://img.shields.io/badge/protocol-1.12.2-075.svg?style=flat) +Написанный с нуля сервер **Minecraft 1.12.2**. + +На данный момент может только показывать информацию о себе. Подключение к серверу не возможно. + --- +## Требования + * Java 11 ---- - ## Запуск -### Gradle +Для запуска требуются некоторые файлы настроек. Для их генерации можно воспользоваться командой инициализации окружения: ```shell -gradle :server:run --args="--config=config.yml --logconfig==logback.xml" +java -jar server.jar --init ``` -### Jar +После выполнить запуск самого сервера: ```shell -java -jar server.jar --config=config.yml --logconfig==logback.xml -``` \ No newline at end of file +java -jar server.jar +``` + +### Параметры командной строки + +`--init` +Инициализация окружения. Генерирует необхидимые для запуска сервера файлы. + +`--config=path/to/config.yml` +Указание альтернативного пути для конфигурационного файла сервера. + +`--logconfig=path/to/logback.xml` +Указание альтернативного пути для конфигурационного файла логгера (logback). + +## Настройки + +### Стилизованный текст + +Файл конфига позволяет использовать специальные коды для добавления цвета и стиля в текст. + +| Код | Цвет | Код | Стиль | +| ---- | ------------------------------------------- | ---- | --------------------------------------------------------------- | +| `&0` | Black | `&l` | Bold | +| `&1` | Dark Blue | `&o` | Italic | +| `&2` | Dark Green | `&n` | Underline | +| `&3` | Dark Aqua | `&m` | Strikethrough | +| `&4` | Dark Red | `&k` | Obfuscated | +| `&5` | Dark Purple | +| `&6` | Gold | +| `&7` | Gray | +| `&8` | Dark Gray | +| `&9` | Blue | +| `&a` | Green | +| `&b` | Aqua | +| `&c` | Red | +| `&d` | Purple | +| `&e` | Yellow | +| `&f` | White | + + +### motd + +```yaml +motd: | + mc-project :: ZERO + develop by DmitriyMX +``` + +Настройка надписи, которая будет отображаться в списке серверов у клиента. Максимум может состоять из двух строк. + +### disconnect-reason + +```yaml +disconnect-reason: Server is not available. +``` + +Причина отключения от сервера. Количество строк не ограничено. + +### players + +```yaml +players: + max-online: 0 + online: 0 +``` + +Фиктивные данные об онлайне сервера. + +### icon + +```yaml +icon: + enable: true + path: favicon.png +``` + +Использовать значок сервера. +Настройка `enable` говорит о факте использования значка, а в настройке `path` указывается путь к значку. + +Формат значка должен быть **PNG** и быть размерами **64x64 px**. Другие форматы или размеры _не поддерживаются_. \ No newline at end of file diff --git a/server/build.gradle b/server/build.gradle index 4802380..7b27ae3 100644 --- a/server/build.gradle +++ b/server/build.gradle @@ -1,6 +1,9 @@ /* Запуск - gradle :server:run + gradle :server:run --args="--config=config.yml --logconfig==logback.xml" + +Сборка + gradle :server:shadowJar */ //file:noinspection GrUnresolvedAccess