Начало работы

API Identica позволяет другому плагину на том же прокси читать аккаунты и сессии, реагировать на события и строить свою логику поверх Identica. На этой странице описано, как подключить зависимость и получить API во время работы, а на странице Сервисы — что с ним можно делать.

КоординатыСкопировать ссылку на раздел

Опубликованный артефакт API имеет такие координаты:

• Группа: me.whereareiam.identica
• Артефакт: api

Для плагинов-аддонов обычно подходит compileOnly или аналогичная зависимость с областью provided. Во время работы API предоставляет сама Identica.

РепозиторииСкопировать ссылку на раздел

Identica публикует артефакты релизов и сборок для разработки в публичный репозиторий Maven.

API публикуется только там. Файлы релизов и сборок для разработки содержат jar-файлы плагина и провайдеров, которые устанавливают на серверы, но не API.

Подключение зависимостиСкопировать ссылку на раздел

repositories {
    maven("https://registry.whereareiam.me/maven/packages")
}

dependencies {
    compileOnly("me.whereareiam.identica:api:1.0.0")
}

Для сборок для разработки укажите версию для разработки — репозиторий тот же.

ВерсииСкопировать ссылку на раздел

Identica публикует API в двух видах версий:

• релизные версии, например 1.0.0;
• версии для разработки, например dev-91e1b65.

На практике:

• релизные версии публикуются из релизов, отмеченных тегом;
• версии для разработки публикуются из ветки dev;
• версии для разработки имеют формат dev-<short-commit-sha>.

Если вы пишете обычный плагин-аддон, выбирайте релизные версии. Версии для разработки используйте, только если вы сознательно опираетесь на ещё не выпущенные изменения API.

JavadocСкопировать ссылку на раздел

Скачайте соответствующий артефакт javadoc из репозитория Maven или позвольте IDE подтянуть его вместе с зависимостью API.

Получение APIСкопировать ссылку на раздел

Точка входа в API — me.whereareiam.identica.IdenticaAPI. Её статические методы возвращают API запущенного экземпляра Identica, через который доступны все сервисы, нужные аддону. Identica регистрирует его при запуске и удаляет при остановке.

• IdenticaAPI.get() возвращает API и выбрасывает исключение, если Identica не запущена. Используйте его, когда ваш аддон загружается после Identica.
• IdenticaAPI.whenReady(identica -> ...) выполняет ваш код, когда Identica готова к работе: провайдеры загружены, их команды и документы на месте. Если Identica уже готова, код выполнится сразу, иначе — как только она будет готова. Используйте этот метод, чтобы запускать аддон независимо от того, когда он загружается.
• IdenticaAPI.find() возвращает Optional<IdenticaAPI> и никогда не выбрасывает исключений.

Передавайте IdenticaAPI в классы своего аддона, а не вызывайте IdenticaAPI.get() повсюду. Тогда эти классы зависят от интерфейса, который можно подменить моком в тестах.

Как ваш плагин дожидается Identica, зависит от прокси.

import com.google.inject.Inject;
import com.velocitypowered.api.plugin.Dependency;
import com.velocitypowered.api.event.Subscribe;
import com.velocitypowered.api.event.proxy.ProxyInitializeEvent;
import com.velocitypowered.api.plugin.Plugin;
import me.whereareiam.identica.IdenticaAPI;

@Plugin(
    id = "example-identica-addon",
    name = "ExampleIdenticaAddon",
    version = "1.0.0",
    dependencies = {
        @Dependency(id = "identica")
    }
)
public final class ExampleIdenticaAddon {
    @Inject
    public ExampleIdenticaAddon() {
    }

    @Subscribe
    public void onProxyInitialization(ProxyInitializeEvent event) {
        IdenticaAPI.whenReady(identica -> new ExampleAddon(identica).inspectProviders());
    }
}

Дальнейшие шагиСкопировать ссылку на раздел

• Сервисы: аккаунты, сессии, провайдеры и сервисы функций
• События: реакция на входы, сессии и изменения аккаунтов
• Написание аддона: как не пропускать чат или команды, пока игрок не вошёл