Разработчикам

Подключение зависимостей

Для написания модулей для лаунчсервера вам нужно подключить следующие библиотеки:

implementation "pro.gravit.launcher:launcher-core:5.2.9"
implementation "pro.gravit.launcher:launcher-ws-api:5.2.9"
implementation "pro.gravit.launcher:launchserver-api:5.2.9"
1
2
3
<dependency>
    <groupId>pro.gravit.launcher</groupId>
    <artifactId>launcher-core</artifactId>
    <version>5.2.9</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>
<dependency>
    <groupId>pro.gravit.launcher</groupId>
    <artifactId>launcher-ws-api</artifactId>
    <version>5.2.9</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>
<dependency>
    <groupId>pro.gravit.launcher</groupId>
    <artifactId>launchserver-api</artifactId>
    <version>5.2.9</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Для написания модулей для лаунчера вам нужно подключить следующие библиотеки:

implementation "pro.gravit.launcher:launcher-core:5.2.9"
implementation "pro.gravit.launcher:launcher-ws-api:5.2.9"
implementation "pro.gravit.launcher:launcher-client-api:5.2.9"
1
2
3
<dependency>
    <groupId>pro.gravit.launcher</groupId>
    <artifactId>launcher-core</artifactId>
    <version>5.2.9</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>
<dependency>
    <groupId>pro.gravit.launcher</groupId>
    <artifactId>launcher-ws-api</artifactId>
    <version>5.2.9</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>
<dependency>
    <groupId>pro.gravit.launcher</groupId>
    <artifactId>launcher-client-api</artifactId>
    <version>5.2.9</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Написание модуля

Загрузка модулей происходит из папки modules. Менеджер модулей открывает по очереди все jar и смотрит на параметр Module-Main-Class в манифесте JAR файла.

Главный класс модуля - это класс, наследуемый от pro.gravit.launcher.modules.LauncherModule и реализующий метод init(LauncherInitContext initContext)

Метод init вызывается при инициализации модуля на ранних этапах запуска лаунчера или лаунчсервера. Поэтому реализовывать логику внутри метода init запрещено. Внутри метода init разрешается обращаться только к методам modulesManager и initContext, при этом при статической загрузке модуля initContext = null, а при динамической загрузке модуля через команду loadModule он будет содержать инстанс контекста, из которого можно получить доступ к LaunchServer

События(евенты)

Всё что можно сделать из init - загружать другие модули, получать их инстансы и, самое важное, подписаться на события. Это единственный правильный способ реализовывать логику. При наступлении события менеджер модулей последовательно проходится по всем модулям в порядке приоритета и вызывает соответствующие обработчики

Встроеные события находятся в pro.gravit.launcher.modules.event

События лаунчсервера находятся в pro.gravit.launchserver.modules.events. Вы должны использовать при работе с лаунчсервером, так как внутри них содержится инстанс LaunchServer - главный объект лаунчсервера

События лаунчера находятся в pro.gravit.launcher.client.events. Они отвечают за основные события, происходящие в клиентской части лаунчера

Для подписки на событие вы должны создать метод в вашем классе, принимающий 1 аргумент соответствующий типу события, которое вы хотите обрабатывать, после чего в методе init вы должны вызвать метод registerEvent, первый аргумент которого

  • ваш метод-обработчик, второй аргумент - класс интересующего вас события

Обратите внимание при загрузке модуля через loadModule события, которые уже прошли не вызываются, вместо этого вам передается initContext

Внешние API

Вы можете использовать некоторые API лаунчера извне в вашем моде Minecraft. Вот список пакетов, к которым можно обращаться извне:

  • pro.gravit.utils - утилитные классы и хелперы
  • pro.gravit.launcher.events - ответы на запросы к лаунчсерверу и отдельные события
  • pro.gravit.launcher.request - запросы к лаунчсерверу
  • pro.gravit.launcher.api - Информация о текущем пользователе и профиле

Написание AuthCoreProvider

Для интеграции собственных CMS и сайтов с лаунчером рекомендуется написать свой AuthCoreProvider. Для этого Создайте класс наследник AuthCoreProvider и реализуйте обязательные методы oauth после чего реализуйте необходимые вам расширения:

Расширения класса AuthCoreProvider

  • AuthSupportExit - вы поддерживаете методы завершения сессии пользователя

  • AuthSupportGetAllUsers - вы поддерживаете метод получения всех пользователей

  • AuthSupportGetSessionsFromUser - вы поддерживаете получение списка сессий пользователя

  • AuthSupportHardware - вы поддерживаете работу с HWID важно

  • AuthSupportRegistration - вы поддерживаете регистрацию пользователей

  • AuthSupportUserBan - вы поддерживаете методы ban и unban

Расширения класса User

  • UserSupportTextures - ваш объект User хранит и предоставляет информацию о скинах и плащах. Вы должны вернуть соответствующие текстуры с метаданными при их наличии. При использовании этих методов TextureProvider больше не требуется
  • UserSupportHardware - ваш объект User хранит информацию о железе пользователя
  • UserSupportBanInfo - ваш объект User хранит информацию о банах пользователя
  • UserSupportAdditionalData - ваш объект User поддерживает кастомные параметры(такие как email, монеты и т.д.)

Своя реализация OAuth (HttpAuthCoreProvider)

OAuth в лаунчере позволяет использовать временные токены доступа(access) вместо устаревшей системы сессий. Этот метод отлично подойдет для интеграции собственных CMS с лаунчером

Для работы с OAuth вам необходимо реализовать соответствующие методы getUserSessionByOAuthAccessToken, refreshAccessToken, а в методе authorize вернуть результат с данными OAuth

Порядок авторизации с OAuth

  • Первым шагом вызывается getAuthDetails (Если используется), который сообщает все возможные факторы авторизации
  • Вторым шагом выполняется авторизация с помощью метода authorize. Вы должны:
    • Проверить, аргументы login и password на null и тип
    • Если context равен null то это означает, что вам не требуется проверять пароль(если это возможно). Это позволяет администратору с помощью команды 'sendAuth' авторизировать пользователя без пароля. Вы вправе не поддерживать данный режим работы и всегда требовать пароль
    • Создайте объект UserSession, содержащий информацию о пользователе, а так же токены accessToken и refreshToken при необходимости
  • Авторизация завершена

При необходимости пользователю обновить свой истекший accessToken будет вызван метод refreshAccessToken. В нем вы должны обновить accessToken и refreshToken(если это возможно) и вернуть их пользователю. Выставление параметра expire в 0 делает токен вечным

При повторной авторизации вызывается метод getUserByTokenUrl, который должен вернуть объект UserSession с находящимся внутри объектом HttpUser

Написание своего скрипта авторизации

Вы можете написать свой скрипт авторизации, для того что бы производить авторизацию через ваше API. Это позволит делать проверки любой сложности и адаптировать авторизацию лаунчера под любой сайт.

Настройте тип авторизации http

Авторизация приложения

HttpAuthCore будет выполнять Bearer авторизацию со всеми методами. Это значит, что с каждым запросом будет отправлен дополнительный заголовок:

Authorization: Bearer {token}

token - токен из поля bearerToken в конфиге.

Для обеспечения безопасности, вы должны также сохранить этот токен у себя на удалённом сервере и сверять этот заголовок, при любом запросе.

UDP: метод getUserByTokenUrl работает сейчас немного иначе. Заголовок будет отправлен, однако вместо токена, там будет лежать accessToken. Что-то вроде Authorization: Bearer {accessToken}. Учитывайте это, при построении систем.

Список методов

Ниже приведены все методы, которые обрабатывает HttpAuthCoreProvider

  1. GET getUserByUsernameUrl
  2. GET getUserByLoginUrl
  3. GET getUserByUUIDUrl
  4. GET getUserByTokenUrl
  5. GET getAuthDetailsUrl (В конфиге этот метод называется getAuthDetails, будет исправлено в будущем)
  6. POST authorizeUrl
  7. POST refreshTokenUrl
  8. POST updateServerIdUrl
  9. POST joinServerUrl
  10. POST checkServerUrl

Из последних 3-х методов вам необходимо реализовать либо updateServerIdUrl, либо joinServerUrl и checkServerUrl

Пример рекомендованного конфига, реализующего OAuth:

{
  "getUserByUsernameUrl": "https://example.com/user/name/%username%",
  "getUserByLoginUrl": "https://example.com/user/login/%login%",
  "getUserByUUIDUrl": "https://example.com/user/uuid/%uuid%",
  "getUserByTokenUrl": "https://example.com/auth/current",
  "getAuthDetailsUrl": "https://example.com/auth/details",
  "refreshTokenUrl": "https://example.com/auth/refresh",
  "authorizeUrl": "https://example.com/auth/authorize",
  "joinServerUrl": "https://example.com/auth/joinServer",
  "checkServerUrl": "https://example.com/auth/checkServer",
  "bearerToken": "TOKEN",
  "type": "http"
}
1
2
3
4
5
6
7
8
9
10
11
12
13

Успешный ответ предполагает код 200 и тело в виде JSON.

###Обработка ошибок

Вы можете возвращать некоторые ошибки. Все ошибки лаунчер ожидает в виде JSON ответа:

{
  "error": "тип ошибки (ниже)"
}
1
2
3

Список типов, которые вы можете вернуть:

  • auth.require2fa - вызывается, если нужно проверить второй фактор
  • auth.require.factor.{number} - вызывается, при использовании MFA для указания необходимости фактора по номеру
  • auth.expiretoken - вызывается, если токен авторизации истёк (Приведёт к выполнению refreshTokenUrl для получения нового токена)
  • auth.invalidtoken - вызывается, если токен неверный
  • auth.usernotfound - вызывается, если вы не нашли пользователя (Так же необходимо вернуть код 404)
  • auth.wrongpassword - вызывается, если пользователь ввёл неверный пароль
  • auth.userblocked - вызывается, если пользователь заблокирован в вашей системе

Основные объекты

Список объектов, которые будут возвращать методы:

HttpUser:

{
  "username": "Gravita",
  "uuid": "UUID",
  "accessToken": "accessToken авторизации",
  "permissions": {
    "perms": [
      "launchserver.*",
      "launcher.*"
    ],
    "roles": [
      "ADMIN"
    ]
  },
  "assets": {
    "SKIN": {
      "url": "https://example.com/skins/Gravita.png",
      "digest": "",//base64(md5(Bytes))
      "metadata": {//ничего, если скин типа стив
        "model": "slim"
      }
    },
    "CAPE": {//ничего, если не используется
      "url": "https://example.com/capes/Gravita.png",
      "digest": ""
    }
  },
  "properties": {
    "key": "value"
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

Properties

Properties - публичные параметры, ассоциированные с игроком(например параметры персонажа, выставляемые в личном кабинете). Получить их в моде/плагине можно из объекта GameProfile authlib. Вы не должны передавать textures как properties, так как это нарушит правильную работу скинов и плащей. Для работы properties требуется обновление authlib на стороне клиента и сервера

HttpUserSession:

    {
  "id": "RANDOM ID",
  // ID сессии в вашей системе, либо случайная строка или число, если такой системы нет
  "user": (( HttpUser )),
  "expireIn": 0
  // Срок окончания действия сессии, 0 - если сессия вечная. Не используется
}
1
2
3
4
5
6
7

AuthReport:

    {
  "minecraftAccessToken": "MINECRAFT ACCESS TOKEN",
  // При желании, может совпадать с "oauthAccessToken"
  "oauthAccessToken": "ACCESS TOKEN",
  "oauthRefreshToken": "REFRESH TOKEN",
  "oauthExpire": 0,
  // Длительность действия accessToken в мс, 0 - если токен будет вечным (В таком случае метод refreshToken не будет вызван)
  "session": (( HttpUserSession ))
}
1
2
3
4
5
6
7
8
9

Основные сведения о методах

Методы getUserByUsernameUrl, getUserByLoginUrl, getUserByUUIDUrl, checkServerUrl ожидают ответ типа HttpUser (См. Список объектов), а данные получают в виде GET параметров

Метод getUserByTokenUrl ожидает ответ типа HttpUserSession (См. Список объектов)

Методы authorizeUrl, refreshTokenUrl ожидают ответ типа AuthReport (См. Список объектов)

Методы joinServerUrl,updateServerIdUrl ожидают ответ 200 в случае успеха

Метод authorizeUrl

Метод вызывается при авторизации пользователя. Тут вы должны проверить логин, пароль.

Запрос:

      {
  "login": "Gravita",
  "context": {
    "ip": "127.0.0.1"
  },
  "password": {
    "password": "qwerty",
    "type": "plain"
  },
  "minecraftAccess": true
  //если false, то в AuthReport возвращать minecraftAccessToken не требуется
}
1
2
3
4
5
6
7
8
9
10
11
12

Ответ: ((AuthReport))

Если "context" равно null, вы можете не делать проверку на факторы и сразу разрешить авторизацию. Тогда вы позволите авторизировать пользователей через консольную команду. Вы в праве не делать этого, если не хотите.

Метод refreshTokenUrl

В этом методе вы должны обновить accessToken, если используете не вечные токены. Если ваши токены вечные, вы можете не реализовывать данный метод

Запрос:

{
  "refreshToken": "REFRESH TOKEN",
  "context": {
    "ip": "127.0.0.1"
  }
}
1
2
3
4
5
6

Ответ: ((AuthReport))

Метод joinServerUrl

Используется, когда пользователь заходит на сервер. Вы должны присвоить serverId пользователю в вашей системе, а позже, в методе checkServer сверить serverId.

Запрос:

{
  "username": "Gravita",
  "accessToken": "MINECRAFT ACCESS TOKEN",
  "serverId": "SERVER ID"
}
1
2
3
4
5

Ответ: любой JSON с кодом 200

Метод checkServerUrl

В этом методе вы должны проверить serverId с тем что лежит в базе (Было положено в joinServerUrl)

Запрос:

{
  "username": "Gravita",
  "serverId": "SERVER ID"
}
1
2
3
4

Ответ: ((HttpUser))

Метод updateServerIdUrl

В этом методе вы должны присвоить пользователю полученный serverId

Запрос:

{
  "username": "Gravita",
  "serverId": "SERVER ID"
}
1
2
3
4

Ответ: любой JSON с кодом 200

Метод getAuthDetailsUrl

Необязательный метод, который используется для указания всех возможных способов авторизации. Используется, только при реализации 2FA \ MFA

Ответ:

{
  "details": [
    {
      "type": "password"
    },
    {
      "type": "totp"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10

Подключение 2FA

Вы можете реализовать 2FA. Для начала постройте всю авторизацию без него, после чего обязательно реализуйте метод getAuthDetailsUrl

Когда authorizeUrl вызывается впервые, вы должны проверить, есть ли у пользователя подключённый 2FA. И, если подключён, вернуть ошибку "auth.require2fa". Обратите внимание, вы должны вернуть эту ошибку после того как пароль пользователя уже прошёл проверку.

Когда вы вернёте необходимость 2FA, пользователю будет предложено ввести второй фактор. Следом метод authorizeUrl будет вызван ещё раз, однако запрос будет выглядеть немного иначе:

      {
  "login": "Gravita",
  "context": {
    "ip": "127.0.0.1"
  },
  "password": {
    "firstPassword": {
      "password": "qwerty",
      "type": "plain"
    },
    "secondPassword": {
      "totp": "110011",
      "type": "totp"
    }
  },
  "minecraftAccess": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Вам будет необходимо повторно проверить правильность пароля, а так же правильность введённого кода 2FA ("totp")

Good luck ❤!