Публикация плагина

Официальное хранилище Sponge для модов и плагинов, Ore, — это проект с открытым исходным кодом, в котором каждый может опубликовать свои Sponge-плагины и Forge-моды.

Упаковка плагина

Ore требует, чтобы проекты были упакованы с файловым дескриптором mcmod.info на верхнем уровне Вашего JAR-файла. Этот файл используется для автоматического определения некоторых важных деталей о Вашем проекте, чтобы упростить процесс загрузки. Ore отклонит Ваш плагин, если этот файл отсутствует в JAR. К счастью, Sponge API имеет встроенный обработчик аннотаций, который автоматически создает этот файл при компиляции с использованием аннотации @Plugin, которую Вы, вероятно, уже создали в основном классе Вашего плагина.

Примечание

Если Вы хотите информацию о создании и компиляции первого плагина, см. Основной класс плагина

Пример файла mcmod.info:

[
    {
        "modid": "my-plugin",
        "name": "MyPlugin",
        "version": "1.0.0",
        "description": "My first plugin!",
        "url": "https://spongepowered.org",
        "authorList": [
            "windy",
            "Zidane",
            "gabizou"
        ],
        "requiredMods": [
            "[email protected]",
            "[email protected]",
            "[email protected]"
        ],
        "dependencies": [
            "[email protected]",
            "[email protected]",
            "[email protected]"
        ]
    }
]

По крайней мере, каждый проект Ore должен содержать заполненные поля modid, name и version.

Загрузка плагина

После того, как JAR-файл плагина упакован с файловым дескриптором mcmod.info на верхнем уровне каталогов, ваш плагин готов к загрузке! Для создания проекта Ore у вас должна быть активная учетная запись Sponge. Нажав кнопку «Sign Up» в правом верхнем углу, вы попадете на соответствующую страницу регистрации. Если у вас уже есть учетная запись, просто нажмите кнопку «Log In» в правом верхнем углу.

После входа в систему перейдите к вашему аватару и выберите «New» в раскрывающемся меню или нажмите клавишу «C».

Во время загрузки мастер создания сначала запросит файл загрузки, а затем вашу подпись.

Настройка вашего проекта на Ore

После загрузки вашего плагина вам будут предложены некоторые параметры для настройки вашего проекта по своему усмотрению. Не беспокойтесь, все они могут быть изменены позже на панели настроек. После настройки вашего проекта вы сможете пригласить пользователей Sponge стать частью вашего проекта. Любой пользователь, зарегистрированный на форумах, может быть приглашен в проект, даже если он никогда не регистрировался в Ore. После создания вашего проекта пользователи, которых вы пригласили, получат уведомление и смогут либо принять, либо отклонить ваше приглашение. Участники проекта будут невидимы для общественности до тех пор, пока приглашение не будет принято.

На данный момент существует три группы, которые можно назначить участникам проекта: Разработчик, Редактор и Поддержка. Пользователь, создавший проект, назначается Владельцем, имеющим неограниченный доступ к проекту. Далее идёт быстрое описание о том, что может делать каждая группа в проекте.

Владелец

Единственная группа, которая может назначать роли другим участникам. Права владельца могут быть только на одном участнике, а также их нельзя передавать другим (пока что).

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

Разработчики могут создавать/редактировать каналы выпуска, страницы и создавать/редактировать версии.

Редакторы

Редакторы могут изменять страницы.

Поддержка

Поддержка ничего не может. Это способ показать, что участник является частью проекта.

Documenting Your Project With Pages

Чтобы документировать ваш плагин Ore предлагает создание страниц. По умолчанию, вы получаете домашнюю страницу при создании нового проекта. Чтобы добавить новые страницы, вы можете нажать на значок «+» в строке страниц справа от экрана. При этом откроется всплывающее окно, где вы можете выбрать имя и родительскую страницу (добавление страницы на главную страницу невозможно). Если вы выберете опцию „<None>“, то страница станет корневой страницей, на которой позже вы сможете добавить дочерние страницы. Если вы решите добавить документацию на другую страницу, то та другая страница будет показана только когда родительская страница будет расширена. Для документирования страниц вы можете использовать CommonMark.

Связывание страниц

Если ваши страницы имеют следующую древовидную структуру:

Home
Команды
- Пользователь
- Admin
Установка
- Config
- Разрешения

Если вы хотите добавить ссылку, вам нужно перейти с Домашней страницы на Страницу конфигурации, после этого в Настройках включите WikiLinks. Чтобы добавить WikiLink используйте формат [Link], таким образом на Домашней странице вы можете добавить [[Setup/Config]], это гарантированно будет преобразовано в ссылку.

Примечание

Вы также можете указать заголовок для ссылки, отделив его вертикальной чертой. К примеру, [[Title|Link]] станет ссылкой с заголовком.

Примечание

WikiLinks are only supported in Ore so if you use them on the Home-page they will not be displayed correctly on the forums. However, we still recommend using WikiLinks instead of normal links to guarantee the future working of your wiki.

Project States

When creating a new project, a banner will appear telling you your project is in a „new“ state. The new state is intended to indicated to users and admins you are still working on the setup of your project. If you have finished documenting your plugin to make it comply with the guidelines, click the „publish“ button to complete the process. However, if you don’t publish it yourself then the project will be published automatically 24 hours after its creation.

Требуются изменения

Ore staff can hide your project and request changes; the changes in question will be listed in the banner. This state will hide your project from the public; if you are done you can send your project for approval.

Требуется подтверждение

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