Publikowanie Twojego Pluginu

Sponge’s official plugin / mod repository, Ore, is a free and open-source project that anyone may publish their Sponge plugins or Forge mods on.

Pakowanie Twojego Pluginu

Baza danych pluginów wymaga, aby wszystkie projekty były pakowane z plikiem deskryptora `` mcmod.info`` w najwyższym poziomie pliku JAR. Plik ten służy do automatycznego wnoszenia ważnych szczegółów dotyczących Twojego projektu, w celu ułatwienia procesu przesyłania. Baza danych pluginów odrzuci twoją wtyczkę, jeśli plik nie zostanie znaleziony w JAR. Na szczęście API Sponge posiada wbudowany procesor przypisywania, który tworzy plik automatycznie, podczas kompilacji, za pomocą przypisu `` @ Plugin``, który prawdopodobnie już utworzyłeś w głównej klasie wtyczki.

Informacja

W celu uzyskania większej ilości informacji na temat tworzenia i kompilacji twojego pierwszego pluginu, zobacz Główna Klasa Pluginu

For reference, here is a sample mcmod.info file:

[
    {
        "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"
        ]
    }
]

At the very least, each Ore project must have the modid, name and, version fields completed.

Signing your Plugin

Ze względów bezpieczeństwa, baza danych pluginów wymaga, aby każdy plik pluginu (ZIP albo JAR) został przesłany z osobnym podpisem Pretty Good Privacy (PGP) dla publicznego klucza, który jest powiązany z e-mailem, przez, którego zarejestrowałeś się do serwisu Sponge. Ten cyfrowy podpis gwarantuje, że każdy plik przesłany przez użytkownika został celowo przesłany przez rzeczywistego posiadacza konta.

Informacja

Podpis cyfrowy certyfikuje i wskazuje czas dokumentu. Jeśli dokument zostanie później w jakikolwiek sposób zmodyfikowany, weryfikacja podpisu zakończy się niepowodzeniem. Podpis cyfrowy może służyć temu samemu celowi, co odręczny podpis z dodatkową korzyścią, że jest odporny na manipulacje. Na przykład dystrybucja źródeł GnuPG jest podpisywana, aby użytkownicy mogli zweryfikować, czy kod źródłowy nie został zmodyfikowany, ponieważ został spakowany.

In order to sign your plugin, you must first download a PGP compliant software program, such as GnuPG (GPG). GPG is available for all major platforms and the binaries can be downloaded here.

Po zainstalowaniu GPG i wygenerowaniu pierwszego klucza publicznego, musisz dodać klucz do swojego konta. Aby to zrobić, możesz przejść do swojego profilu i kliknąć symbol klucza obok swojego awatara.

PGP public key 1

Zostaniesz poproszony o wprowadzenie swojego klucza w polu tekstowym. Musisz być pewnym, że wpiszesz klucz w całości, w innym wypadku potwierdzenie zgodności klucza nie powiedzie się.

PGP public key 2

Na koniec musisz podpisać swoją wbudowaną wtyczkę swoim prywatnym kluczem przesłanego klucza publicznego. Musisz tylko podpisać plik, który przesyłasz: na przykład, jeśli przesyłasz ZIP z załączonym JAR wtyczki, wtedy tylko ZIP musi (i powinien być) podpisany. Najprostszym sposobem podpisania pliku, który zamierzasz przesłać, jest wykonanie następującego polecenia GPG.

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

Informacja

If you’re using build manager such as Gradle or Maven, there is 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.

Przesyłanie Twojego Pluginu

Gdy plik JAR wtyczki jest spakowany z plikiem deskryptora `` mcmod.info` w najwyższym poziomie i podpisany kluczem prywatnym PGP, twoja wtyczka jest gotowa do wgrania! Aby utworzyć projekt w Ore, musisz mieć aktywne konto Sponge. Naciśnięcie przycisku „Zarejestruj się” w prawym górnym rogu przeniesie Cię do odpowiedniej strony, aby ją utworzyć. Jeśli masz już konto, po prostu naciśnij przycisk „Zaloguj się” w prawym górnym rogu, aby zalogować się do Ore.

Po zalogowaniu przejdź do swojego awatara i wybierz opcję „Nowy” w rozwijanym menu lub naciśnij klawisz „C”.

Podczas przesyłania kreator tworzenia najpierw poprosi o przesłanie głównego pliku do przesłania, a następnie o oddzielny podpis.

Konfigurowanie twojego projektu na Ore

Po przesłaniu wtyczki otrzymasz kilka ustawień, które pozwolą Ci skonfigurować twój projekt. Nie martw się, wszystko to można później zmienić w panelu ustawień. Po skonfigurowaniu projektu będziesz mógł zaprosić użytkowników Sponge do udziału w projekcie. Każdy użytkownik zarejestrowany na forum może zostać zaproszony do projektu, nawet jeśli nigdy nie zalogował się do Ore. Po utworzeniu projektu zaproszeni użytkownicy otrzymają powiadomienie i będą mogli zaakceptować lub odrzucić zaproszenie. Członkowie projektu nie będą widoczni publicznie, dopóki zaproszenie nie zostanie zaakceptowane.

Istnieją obecnie trzy grupy, które możesz przypisać do członków projektu: Deweloper,` Edytor` i Wsparcie. Użytkownikowi, który utworzył projekt, zostanie przypisany „Właściciel”, który ma nieograniczony dostęp do projektu. Oto krótki opis tego, co każda grupa może zrobić w ramach projektu.

Właściciel

Maksymalnie jeden właściciel do projektu jest niezbywalny (na razie) i jest jedyną grupą, która może przydzielać role innym członkom.

Deweloperzy

Deweloperzy mogą tworzyć/edytować kanały zwolnień, strony i tworzyć/edytować wersje.

Redaktor

Edytorzy mogą edytować strony.

Wsparcie

Wsparcie nie może nic zrobić, tylko sposób pokazania, że członek jest częścią projektu.