Publikowanie Twojego Pluginu
Oficjalne repozytorium pluginów/modów Sponge’a, Ore, jest darmowym i otwartoźródłowym projektem gdzie każdy może opublikować swój plugin Sponge lub mod Forge.
Pakowanie Twojego Pluginu
Ore wymaga aby każdy projekt był spakowany z plikiem mcmod.info znajdującym się na najwyższym poziomie w Twoim pliku JAR. Ten plik używany jest do automatycznego odczytywania ważnych informacji o Twoim projekcie aby uczynić proces przesyłania prostrzym. Jeśli Twój Jar nie będzie zawierał tego pliku, Ore odrzuci Twój plugin. Na szczęście, SpongeAPI ma wbudowany procesor adnotacji, który utworzy dla Ciebie taki plik automatycznie podczas kompilacji, używając adnotacji @Plugin, którą za pewne użyłeś już w swojej głównej klasie pluginu.
Informacja
W celu uzyskania większej ilości informacji na temat tworzenia i kompilacji twojego pierwszego pluginu, zobacz Główna Klasa Pluginu
Dla odniesienia, oto przykładowy plik 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]"
]
}
]
Każdy projekt Ore musi posiadać wypełnione pola modid, name oraz version.
Przesyłanie Twojego Pluginu
Jeśli plik JAR Twojego pluginu został spakowany z plikiem mcmod.info na najwyższym poziomie, oznacza to że Twój plik jest gotowy do przesłania! Aby utworzyć projekt na Ore, musisz mieć aktywne konto na Sponge. Klikając przycisk „Sing up” w prawym górnym rogu, przeniesie Cię na odpowednią stronę do utworzenia konta. Jeśli posiadasz już konto, możesz zalogować się do Ore klikając przycisk „Log in” w prawym górnym rogu strony.
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.
Dokumentowanie swojego projektu stronami
Aby udokumentować swój plugin, Ore oferuje kreator stron. Domyślnie na start otrzymujesz stronę domową «Home» kiedy utworzysz swój nowy projekt. Aby dodać nowe strony, możesz nacisnąć ikonę «+» w sekcji Pages po prawej stronie ekranu; jeśli to zrobisz otworzone zostanie okno, w którym będziesz mógł wybrać nazwę oraz nadrzędną stronę (dodawanie strony na stronie domowej «Home» nie jest możliwe). Jeśli wybierzesz opcję «<None>», strona stanie się stroną główną do której będziesz mógł dodawać podstrony. Jeśli wbierzesz dodanie jej do innej strony, będzie ona widoczna kiedy strona główna zostanie rozszeżona. Aby dokumentować swoje strony możesz użyć CommonMark.
Linkowanie stron
Jeśli masz następującą strukturę swoich stron:
Strona główna
- Komendy
Użytkownik
Administrator
- Ustawienia
Konfiguracja
Zezwolenia
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.
Informacja
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
Informacja
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.
Wymaga zmian
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.
Wymaga zatwierdzenia
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.
