Publicar o Seu Plugin

O repositório oficial de mods/plugins do Sponge, Ore, é um projeto gratuito e de código aberto onde qualquer um pode publicar o seu plugin ou mod Sponge.

Empacotar o Seu Plugin

O Ore requer que todos os projetos sejam empacotados com um ficheiro de descrição mcmod.info na raíz do ficheiro JAR. Este ficheiro é utilizado para retirar, automaticamente, alguns detalhes do teu projeto para facilitar o processo de upload. O Ore rejeitará o teu plugin se não tiver este ficheiro no JAR. Felizmente, a SpongeAPI tem uma funcionalidade que cria este ficheiro automaticamente, durante a compilação, utilizando a anotação @Plugin que provavelmente já existe na classe main do teu plugin.

Nota

Para mais informação sobre como criar e compilar um plugin, veja Classe Main de um Plugin

Para referência, eis um exemplo do ficheiro mcmod.info:

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

No mínimo, cada projeto no Ore deve ter os campos modid, name e, version completos.

Assinar o seu Plugin

Por motivos de segurança, o Ore requer que cada plugin (ZIP ou JAR), seja enviado com uma assinatura Pretty Good Privacy (PGP) separada para uma chave pública que está associada ao email com que você se registou no Sponge. Esta assinatura digital garante que qualquer ficheiro enviado por um usuário foi enviado intencionalmente pelo verdadeiro titular da conta.

Nota

Uma assinatura digital certifica e carimba temporalmente um documento. Se, depois, o documento for alterado de qualquer maneira, a verificação da assinatura falhará. Uma assinatura digital pode ter o mesmo papel que uma assinatura manuscrita, e tem ainda o benefício de resistente a modificações ao documento. A distribuição GnuPG source, por exemplo, é assinada, de tal maneira que os usuários podem verificar que o código fonte não foi alterado desde que foi empacotado.

Para você assinar o seu plugin, deve descarregar primeiro um programa como o GnuPG (GPG). O GPG está disponível para todas as grandes plataformas e os binários podem ser descarregados aqui.

Assim que você tiver instalado o GPG e tiver gerado a sua primeira chave pública, deverá adicionar essa chave À sua conta. Para fazer isto, você pode navegar para o seu peril e clicar no símbolo que tem uma chave, perto do teu ícone.

PGP public key 1

De seguida, será pedido que insiras a tua chave numa caixa de texto. Garante que inseres todos os carateres da chave! Caso contrário, a verificação da assinatura falhará.

PGP public key 2

Finalmente, você deve assinar o seu plugin com a chave privada da chave pública que enviou antes. Você só precisa de assinar o ficheiro que está a enviar: se estiver a enviar um ZIP com um JAR incluído, só precisa de (e só deve) assinar o ZIP. A maneira mais simples de assinar o ficheiro que você quer enviar é utilizando o comando GPG seguinte.

gpg --output myplugin-1.0.0.jar.sig --detach-sig myplugin-1.0.0.jar

Nota

Se estás a usar um build manager, como o Gradle ou o Maven, há alguns plugins que podes aplicar ao teu build script que assinam os artefactos gerados de forma automática, automatizando assim este aborrecido processo. Para mais informações, visita a documentação do Gradle ou a documentação do Maven.

Enviar o teu Plugin

Assim que o ficheiro JAR do teu plugin estiver empacotado com o ficheiro descritivo mcmod.info na sua raiz e estiver assinado com a tua chave privada PGP, o teu plugin estará pronto para ser enviado para o Ore! Para criares um projeto no Ore, deves ter uma conta Sponge ativa. Podes criar uma conta carregando no botão “Sign Up” no canto superior direito de qualquer página Sponge. Se já tens uma conta, usa o botão “Log In”.

Assim que tiveres sessão iniciada, navega para o teu avatar e seleciona a opção “New” no menu que aparece, ou carrega simplesmente na tecla “C”.

Durante o processo de envio, o Ore pede primeiro o ficheiro principal de envio, e logo depois a tua assinatura separada.

Configurar o teu projeto no Ore

Depois de enviares o teu plugin, ser-te-hão apresentadas algumas opções para configurares o teu projeto ao teu gosto. Não te preocupes, todas essas definições podem, mais tarde, ser alterada no painel de definições. Depois de configurares o teu projeto, poderás convidar outros utilizadores do Sponge para serem uma parte dele. Qualquer utilizador que esteja registado nos fóruns pode ser convidado para i, projeto, mesmo que nunca tenham iniciado sessão no Ore. Assim que o projeto é criado, esses utilizadores convidados receberão uma notificação e poderão aceitar ou rejeitar o teu convite. Os membros de um projeto não serão visíveis para o público até que aceitem o respetivo convite.

Neste momento, há três grupos que podes atribuir aos membros do teu projeto: “Desenvolvedor”, “Editor” e “Suporte”. O utilizador que criou o projeto terá o grupo “Dono”, e tem acesso ilimitado ao projeto. Eis uma breve explicação do que cada grupo pode fazer no projeto.

Proprietário

Cada projeto tem um e só um proprietário. Este papel não é transferível (para já), e é o único grupo que pode dar cargos a outros membros.

Desenvolvedores

Os desenvolvedores podem criar/editar release channels, páginas e criar/editar versões.

Editor

Os editores podem editar páginas.

Suporte

Os membros do suporte não podem fazer nada. Esta é meramente uma forma de mostrar que estes membros fazem parte do projeto.

Escrever Documentação para o teu Projeto com as Pages

O Ore oferece a criação de páginas para documentares o teu plugin. Por predefinição, o Ore cria-te uma página ‘Home’ quando crias um novo Projeto. Para adicionares novas páginas, podes carregar no ‘+’ na barra das páginas, na parte direita do screen; fazê-lo abrirá um pop-up onde podes escolher um nome e a página-pai (adicionar uma página na página Home não é possível). Se escolheres a opção ‘<None>’, a página será uma página de raiz, à qual poderás adicionar páginas-filhas. Se escolheres adiconá-la a outra página, esta só será mostrada quando a página-pai por expandida. Podes escrever as tuas páginas em CommonMark.

Linkar Páginas

Se tiveres a seguinte árvore de estrutura nas tuas páginas:

  • Página inicial
  • Comandos
    • User
    • Admin
  • Configuração
    • Config
    • Permissions

E tu queres adicionar um link à Home Page que aponte para a página Config, que pertence a Setup. Para isso, podes usar WikiLinks. Para adicionares um WikiLink, usa o formato [[Link]]. Ou seja, na Home Page podes escrever [[Setup/Config]] e isto será convertido num link que é garantido funcionar.

Nota

Também podes especificar um título para o link e separá-lo com o símbolo Pipe, de modo que [[Title|Link]] será um link com o título Title.

Nota

Os WikiLinks só são suportados no Ore, por isso, se os usares na Home-page, eles não serão corretamente mostrados nos fóruns. Ainda assim, recomendamos que uses WikiLinks em vez de links normais por forma a garantires que a tua wiki continua a funcionar no futuro.

Estados de Projetos

Quando crias um novo projeto, aparecerá um banner a indicar-te que o projeto está no estado ‘new’. Este estado serve para indicar aos utilizadores e administradores que ainda estás a trabalhar na configuração do teu projeto. Se já acabaste de documentar o teu plugin para que fique de acordo com as diretrizes, clica no botão ‘publish’ para completares o processo. No entanto, se não publicares manualmente o teu projeto, ele será automaticamente publicado 24 horas após a sua criação.

Precisa de alterações

A staff do Ore pode esconder o teu projeto e pedir modificações; as alterações em questão estarão listadas no banner. Este estado esconderá o teu projeto do público; se já terminaste, podes enviar o teu projeto para aprovação.

Precisa de aprovação

Neste estado, o teu projeto ainda está escondido do público enquanto se espera que um membro do staff reveja e valide as alterações que foram solicitadas. Por favor, sê paciente, os membros da staff podem estar ocupados com outras tarefas. Se o projeto for aprovado, tonar-se-á imediatamente visível novamente. Por favor, certifica-te de que realmente corriges os pontos que exigem mudanças.