Publicando Su Plugin

El repositorio oficial de plugins / mod de Sponge, Ore <https://ore.spongepowered.org> _, es un proyecto gratuito y de código abierto en el que cualquiera puede publicar sus complementos de Sponge o Forge.

Empaquetando su Plugin

Ore requires any projects to be packaged with a mcmod.info descriptor file in the top-level of your JAR file. This file is used to automatically infer some important details about your project to make the upload process easier. Ore will reject your plugin if this file is missing from the JAR. Luckily, SpongeAPI has a built-in annotation processor that creates this file for you automatically, on compile, using the @Plugin annotation that you have likely already created in your plugin’s main class.

Nota

Para obtener más información sobre cómo crear y compilar su primer complemento, consulte :doc: “/ clase/plugin-plugin”

Como referencia, aquí hay un archivo de muestra `` 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"
        ]
    }
]

Por lo menos, cada proyecto Ore *debe * tener los campos `` modid``, `` name`` y, `` version`` completados.

Firmando su Plugin

Debido a problemas de seguridad, Ore requiere que cada archivo de complemento (ZIP o JAR) se cargue con una firma separada Pretty Good Privacy (PGP) <https://en.wikipedia.org/wiki/Pretty_Good_Privacy> __ para una clave pública que está asociado con el correo electrónico con el que se registró en Sponge. Esta firma digital asegura que cualquier archivo cargado por un usuario fue pensado para ser cargado por el titular de la cuenta real.

Nota

Una firma digital certifica y marca el tiempo de un documento. Si el documento se modifica posteriormente de alguna manera, la verificación de la firma fallará. Una firma digital puede servir para el mismo propósito que una firma manuscrita con el beneficio adicional de ser resistente a alteraciones. La distribución de origen de GnuPG, por ejemplo, está firmada para que los usuarios puedan verificar que el código fuente no se haya modificado desde que fue empaquetado.

A fin de poder firmar su complemento, primero debe descargar un programa de software compatible con PGP, tal como GnuPG (GPG) <https://www.gnupg.org/> __. GPG está disponible para todas las plataformas principales y los binarios se pueden descargar aquí <https://www.gnupg.org/download/index.html#sec-1-2> __.

Una vez haya instalado GPG y haya generado su primera clave pública, deberá agregar la clave a su cuenta. Para hacer esto, puede navegar a su perfil y hacer clic en el símbolo de la tecla al lado de su avatar.

PGP public key 1

You will then be prompted to enter your key into a text box. You must be sure to enter the key in its entirety or signature validation will fail.

PGP public key 2

Finalmente, debe firmar su plugin incorporado con su clave * privada * de la clave pública que cargó. Solo necesita firmar el archivo que está cargando: por ejemplo, si está cargando un ZIP con su plugin JAR incluido, solo el ZIP necesita (y solamente debe) estar firmado. La forma más fácil de firmar el archivo que desea cargar es con el siguiente comando GPG.

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

Nota

If you’re using a build manager such as Gradle or Maven, there are plugins you can apply to your build script that can sign built artifacts and automate this laborious process for you. For more information, please refer to Gradle’s documentation or Maven’s documentation.

Cargando su complemento

Una vez que el archivo JAR de su complemento está empaquetado con un archivo descriptor mcmod.info en el nivel superior y firmado con su clave privada PGP, ¡su complemento está listo para cargarse! Para crear un proyecto en Ore, Ud. debe tener una cuenta activa en Sponge. Al presionar el botón «Registrarse» en la esquina superior derecha, accederá a la página adecuada para crear uno. Si ya tiene una cuenta, simplemente presione el botón «Iniciar sesión» en la esquina superior derecha para iniciar sesión en Ore.

Una vez que haya iniciado sesión, navegue hasta su avatar y seleccione la opción «Nuevo» en el menú desplegable que aparece, o solo presione la tecla «C».

Mientras carga, el asistente de creación primero le pedirá su archivo de carga principal y luego su firma separada.

Configurando su proyecto en Ore

Después de cargar su complemento, se le mostrarán algunas configuraciones para configurar su proyecto de la manera que desee. No se preocupe, todos estos se pueden cambiar más adelante en el panel de configuración. Después de configurar su proyecto, podrá invitar a los usuarios de Sponge a formar parte de su proyecto. Cualquier usuario que esté registrado en los foros puede ser invitado a un proyecto, incluso si nunca ha iniciado sesión en Ore. Al crear su proyecto, los usuarios que ha invitado recibirán una notificación y podrán aceptar o rechazar su invitación. Los miembros del proyecto no serán visibles para el público hasta que la invitación ha sido aceptada.

Actualmente hay tres grupos a los que se pueden asignar los miembros del proyecto: Desarrollador,` Editor` y Soporte. Al usuario que creó el proyecto se le asignará el Propietario, el cual tiene acceso irrestricto al proyecto. Aquí hay un resumen rápido de lo que cada grupo puede hacer dentro de su proyecto.

Propietario

Hay un máximo de un propietario para un proyecto, no es transferible (por ahora) y es el único grupo que puede asignar roles a otros miembros.

Desarrolladores

Los desarrolladores pueden crear/editar canales de publicación, páginas y crear/editar versiones.

Editor

Los editores pueden editar páginas.

Soporte

Soporte no puede hacer nada, simplemente es una forma de mostrar que el miembro es parte del proyecto.

Documenting Your Project With Pages

To document your plugin Ore offers the creation of pages. By default, you get a “Home” page when you create your new Project. To add new pages, you can click on the “+” icon in the Pages bar on the right of the screen; doing so will open a pop-up where you can choose a name and the parent page (adding a page on the Home page is not possible). If you choose the “<None>” option the page will become a root page where you can later add child pages on. If you choose to add it to another page the page will only show when the parent page is expanded. To document your pages, you can use CommonMark.

Linking Pages

If you have the following tree structure in your pages:

  • Home
  • Comandos
    • Usuario
    • Admin
  • Configuración
    • Config
    • Permisos

And you want to add a link from the home page to the Config page in Setup you can use WikiLinks. To add a WikiLink use the format [[Link]] so on the home page you can add [[Setup/Config]] and this will get be converted to a link that is guaranteed to work.

Nota

You can also specify a title for the link and separate it with a Pipe symbol so [[Title|Link]] will become a link with the title

Nota

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.

Needs Changes

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.

Needs Approval

In this state your project is still hidden from the public while waiting for a staff member to review and validate the changes that were requested. Please be patient, the staff members might be busy with other tasks. If the project gets approved it will automatically become visible again. Please make sure to actually fix the points that require changes.