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": [
            "[email protected]",
            "[email protected]",
            "[email protected]"
        ],
        "dependencies": [
            "[email protected]",
            "[email protected]",
            "[email protected]"
        ]
    }
]

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

Cargando su complemento

Once your plugin’s JAR file is packaged with an mcmod.info descriptor file in the top-level, it is ready for uploading! To create a project on Ore, you must have an active Sponge account. Hitting the «Sign up» button in the top-right corner will take you to the appropriate page to create one. If you already have an account, just hit the «Log in» button in the top-right corner to log into 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.