Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 2.64 KB

build.md

File metadata and controls

30 lines (25 loc) · 2.64 KB

Структура проекта

  • common - модуль с общими классами, используемыми и на стороне сервера, и на стороне бота
  • server - модуль с кодом сервера. Дорабатывается исключительно администраторами.
  • starter-bot - модуль-заготовка для бота. Он же - простейший пример. Можно брать за основу для работы над ботом.

Сборка и запуск проекта

Сборка проекта осуществляется с помощью 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 (файл конфигурации опционален - при его отсутствии будут использоваться значения по умолчанию) в одну папку
    • Открыть командную строку (cmd) в папке из предыдущего пункта
    • Выполнить в командной строке: java -jar server.jar
    • Сервер запустится и станет доступным для ботов по указанным в конфигурации параметрам (порту, в частности)
  • Бота:
    • Скопировать артефакт сборки starter-bot.jar и файл конфигурации bot.properties в одну папку
    • Открыть командную строку (cmd) в папке из предыдущего пункта
    • Выполнить в командной строке: java -jar starter-bot.jar
    • Бот автоматически попробует подключиться к серверу по адресу и порту, указанным в конфигурационном файле

NOTE: И сервер, и бота можно запустить из IDE, задав нужные параметры в .properties-файлах и запустив соответствующие main-классы.