-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
build.md + вывод времени матча + логи конфига на запуске
- Loading branch information
denrus
committed
Dec 2, 2021
1 parent
577b2b3
commit 481b396
Showing
4 changed files
with
38 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
##Структура проекта | ||
|
||
- `common` - модуль с общими классами, используемыми и на стороне сервера, и на стороне бота | ||
- `server` - модуль с кодом сервера. Дорабатывается исключительно администраторами. | ||
- `starter-bot` - модуль-заготовка для бота. Он же - простейший пример. Можно брать за основу для работы над ботом. | ||
|
||
##Сборка и запуск проекта | ||
|
||
Сборка проекта осуществляется с помощью [Maven](https://ru.wikipedia.org/wiki/Apache_Maven). | ||
Шаги сборки: | ||
- Клонирование репозитория | ||
- Установка IDE и Maven | ||
- Выполнение команды Maven (`Execute maven goal`): mvn clean package | ||
- Результатом сборки будут следующие артефакты: | ||
- `server` - ./server/target/server.jar | ||
- `starter-bot` - ./starter-bot/target/starter-bot.jar | ||
|
||
Для запуска: | ||
- Сервера: | ||
- Скопировать артефакт сборки `server.jar` и файл конфигурации [hypernull.properties](server/hypernull.properties) (файл конфигурации опционален - при его отсутствии будут использоваться значения по умолчанию) в одну папку | ||
- Открыть командную строку (`cmd`) в папке из предыдущего пункта | ||
- Выполнить в командной строке: `java -jar server.jar` | ||
- Сервер запустится и станет доступным для ботов по указанным в конфигурации параметрам (порту, в частности) | ||
- Бота: | ||
- Скопировать артефакт сборки `starter-bot.jar` и файл конфигурации [bot.properties](starter-bot/bot.properties) в одну папку | ||
- Открыть командную строку (`cmd`) в папке из предыдущего пункта | ||
- Выполнить в командной строке: `java -jar starter-bot.jar` | ||
- Бот автоматически попробует подключиться к серверу по адресу и порту, указанным в конфигурационном файле | ||
|
||
NOTE: И сервер, и бота можно запустить из IDE, задав нужные параметры в `.properties`-файлах и запустив соответствующие main-классы. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters