[GigaTut] Piszemy pluginy z marszczybrewem

[marszczybrew]

//Estetykę poprawię po napisaniu jeszcze kliku części, chyba nie jest tak źle :P

Piszemy pluginy z marszczybrewem vol. 1 - ,,Przygotowania oraz instalacja IDE''

Pierwszym krokiem ku rozpoczęciu pisania własnych pluginów (oczywiście poza doskonaleniem znajomości Javy) jest przygotowanie środowiska pracy. Niektórzy mogą się przyczepić, że przecież „pluginy można pisać w Notatniku, a kompilować w wierszu poleceń”. Jeśli tak wolą, to proszę bardzo. Poradnik jest adresowany do osób zielonych w tym temacie i z tego powodu wszelkie „problemy” będą rozwiązywane w jak najprzystępniejszy sposób.

Pobieranie wymaganego oprogramowania

Java w wersji JDK
Pierwszą rzeczą, bez której nic nie zrobimy jest Java. Nie wystarczy standardowa wersja używana do gry w Minecrafta, musi to być JDK (ang. Java Development Kit, w wolnym tłumaczeniu „Zestaw Programistyczny Java”). Dlaczego? „Standardowa” Java, czyli JRE (ang. Java Runtime Environment, w wolnym tłumaczeniu „Środowisko Uruchomieniowe Java”) pozwala jedynie na uruchomienie gotowego kodu. My potrzebujemy kompilatora, a więc programu, który przetworzy nasz kod na kod możliwy do uruchomienia przez maszynę wirtualną Javy.
Wyżej opisane JDK jest dostępne do pobrania pod tym adresem. Wersje na Windows są oznaczone żółtą ramką, użytkownicy pozostałych systemów powinni sobie poradzić

 

 

W tym momencie powinniśmy być gotowi do przejścia do następnego kroku. Najpierw jednak upewnimy się co do poprawności instalacji. Wciśnij przyciski Windows+R (lub otwórz okienko „Uruchom…”) i wpisz w nim polecenie cmd.

Pojawi się nam na ekranie tajemnicze czarne okienko rodem z Matriksa. Jest to wiersz poleceń, można za jego pomocą kompilować i uruchamiać programy napisane w Javie. Ze względu na dość nikłą wygodę tego sposobu my będziemy korzystać z IDE (o którym więcej za chwilę). Wracając do tematu, wpisz polecenie java. Najprawdopodobniej wyskoczy coś w tym stylu, oznacza to prawidłową instalację.

Teraz kolej na sprawdzenie kompilatora, w tym celu wpisz javac.

Jeśli wyskoczyło coś takiego, zmienna środowiskowa do katalogu Javy nie istnieje w systemie. Aby to naprawić, wpisz w tym samym okienku polecenie set path=%path%;ŚCIEŻKA_DO_KATALOGU_BIN_JDK. Przykładowe polecenie będzie zatem wyglądało następująco: C:\Program Files\Java\jdk1.7.0\bin
Po wykonaniu tego polecenia wpisanie komendy javac powinno skutkować czymś takim:

Jeśli wszystko tak wygląda, możesz (wreszcie) przejść dalej J

Eclipse

Wspominałem na początku, że programy można pisać w Notatniku i kompilować w Konsoli - za pomocą wcześniej prezentowanej komendy javac Jest to jednak sposób bardzo nieefektywny. W celu uprzyjemnienia pracy będziemy wykorzystywać Eclipse, które jest jednym z kilku(nastu) dostępnych na rynku IDE. Co to jest IDE? Jest to skrót (ang. Integrated Developer Environment) oznaczający po polsku „Zintegrowane Środowisko Programistyczne”. Nie będę się rozwodził na jego funkcjami, wszystkie będziemy omawiać na bieżąco.
Pobieramy Eclipse stąd, wybieramy wersję Eclipse IDE for Java Developers. Pobrane archiwum zip wypakowujemy dokąd chcemy (ważne żeby umieć znaleźć tą lokalizację jeszcze raz w celu utworzenia skrótu na Pulpicie).

Podczas pierwszego uruchomienia pojawi się nam takie okienko:

Jest to folder, w którym będą przechowywane wszystkie nasz projekty oraz ustawienia. Po zaznaczeniu opcji „Use this as the default and do not ask again” Eclipse zapisze podaną lokalizację jako domyślną i nie będzie więcej pokazywało tego okienka (lokalizację przestrzeni roboczej wciąż będzie można zmienić w ustawieniach).
Kolejnym krokiem jest…

Pobranie Bukkit API

Postanowiłem napisać o tym tutaj, ponieważ jest ono wymagane przy każdym projekcie i w zasadzie bez niego nie mamy czego zaczynać. Pobieramy najnowszą wersję stąd. Plik ten zapiszmy w jakiejś łatwo dostępnej lokalizacji, polecam utworzenie katalogu „Biblioteki” w folderze naszej przestrzeni roboczej.
Być może zauważyliście, że pobieramy Bukkita (serwer?). Bukkit, jako Bukkit, jest modyfikacją pozwalającą na uruchamianie pluginów, zaś CraftBukkit jest tym, czego najczęściej używamy, a więc implementacją Bukkita do serwera Minecraft.

Oto koniec części pierwszej serii „Piszemy pluginy z marszczybrewem”. Kolejne spotkanie rozpoczniemy od napisania pierwszego prostego pluginu


Piszemy pluginy z marszczybrewem vol. 2 - ,,Pierwszy mikro-plugin''


Hej, w tej części napiszemy pierwszy mikro-plugin - bazę do dalszych części. Miłego czytania i owocnej pracy!


Tworzymy projekt
Po otwarciu Eclipse tworzymy nowy projekt, następnie nadajemy mu jakąś nazwę. Mój przykładowy plugin w tym poradniku będzie się nazywał HelloWorldPlugin, a to z powodu funkcji jaką będzie pełnił Ale o tym później, teraz pora na skonfigurowanie projektu. W okienku, które wyskoczy po kliknięciu „Nowy projekt” wpisujemy tylko nazwę i tak jak poniżej klikamy na „Finish”.

Dodanie Bukkit API
Mamy utworzony projekt, teraz pora na dodanie do niego Bukkit API. W tym celu w Eksploratorze po lewej stronie IDE (domyślnie) klikamy na nasz projekt (obiekt najwyżej w hierarchii, zawierający folder src oraz „Referenced Libraries”) po czym na klawiaturze wciskamy przyciski Alt+Enter. Alternatywą jest kliknięcie prawym przyciskiem myszy na projekt i wybranie opcji „Properties” z samego dołu menu kontekstowego.

W nowym okienku klikamy zakładkę „Build Path” po lewej stronie. Jest to zakładka na której możemy dodawać zewnętrzne bilbioteki, np. służące do obsługi bazy danych czy łatwiejszego dostępu do plików, itd. My w tym wypadku wybieramy zakładkę „Libraries” (u góry) i wciskamy przycisk „Add External JARs”

Wskazujemy lokalizację Bukkit API (pobieraliśmy je w pierwszej części poradnika). Teraz dodamy sobie JavaDocs do API Bukkita. JavaDocs są swego rodzaju dokumentacją Bukkita dostępną pod adresem http://jd.bukkit.org/apidocs/. Dzięki dodaniu ich do projektu przy pisaniu jakiejkolwiek metody dostarczanej przez Bukkita pod kursorem pojawi się nam mała ramka informująca co dana metoda robi, co przyjmuje jako argumenty i co zwraca po wykonaniu. Jest to bardzo pomocne w wielu sytuacjach.

Utworzenie package
Utworzymy teraz package (z ang. pakiet), w którym będą przechowywane nasze klasy. Klikamy PPM na folder src znajdujący się w naszym projekcie w oknie eksploratora.

Aktualnie istnieje kilka konwencji nazewnictwa pakietów, oto one:

• Jeśli masz swoją domenę, nazwij pakiet odwróconą domeną.
  • Na przykład: jestem-deweloperem-bukkit.com, to nazwij pakiet tak: com.jestem_deweloperem_bukkit (źródło).
  • Unikaj posługiwania się domeną, właścicielem której nie jesteś.
• Nie masz domeny? Tu masz kilka popularnych rozwiązań tej sytuacji:
  • • Stwórz konto na stronie do zarządzania kodem źródłowym, np. GitHub lub SourceForge (dla GitHuba, postępuj za wskazówkami opisanymi tutaj w celu uzyskania własnej subdomeny. Twój pakiet będzie się wtedy nazywał com.github.<nazwa_subdomeny>)
    • Użyj swojego adresu email, np. [email protected] będzie jako com.gmail.marszczybrew1

Jest jednak kilka wyrażeń, od których Twój pakiet nie możesię nazywać. Są to:

• org.bukkit
• net.bukkit
• com.bukkit
• net.minecraft
• Teraz, gdy nasz pakiet ma już swoją bazową nazwę, zakończ go nazwą swojego pluginu. W moim wypadku package będzie się nazywał com.gmail.marszczybrew1.helloworldplugin

  

  Tworzenie klasy głównej
  Teraz utworzymy klasę główną naszego pluginu oraz dodamy do niej kilka wymaganych rzeczy. Klasę tworzymy klikając PPM na nasz package i wybierając opcję New > Class. Jej nazwa może być dowolna, lecz dla przejrzystości niech będzie to nazwa naszego pluginu.

  

  W tym momencie nasza klasa powinna wyglądać następująco:

  package com.gmail.marszczybrew1.helloworldplugin;

  public class HelloWorldPlugin {

  }

  Musimy dopisać do niej kilka rzeczy, gdy skończycie powinna wyglądać tak:

  package com.gmail.marszczybrew1.helloworldplugin;

  import org.bukkit.plugin.java.JavaPlugin;

  public class HelloWorldPlugin extends JavaPlugin {

  @Override

  public void onEnable() {

  // Tu wpiszemy kod wykonywany przy uruchamianiu pluginu.

  }

  @Override

  public void onDisable() {

  // Tu z kolei znajdzie się kod wykonywany przy wyłączaniu pluginu.

  }

  }

  W tym momencie mamy bazową strukturę naszej klasy głównej, pora na jej krótkie omówienie. Pierwszą zmianą względem klasy początkowej jest dopisanie wyrażeniaextends JavaPlugin. Oznacza to tyle, że klasa rozwija JavaPlugin a tym samym dziedziczy jej właściwości i metody. Kolejną zmianą jest dodanie dwóch podstawowych metod, komentarze tłumaczą wszystko Na tym etapie klasa główna naszego pluginu jest gotowa do kompilacji, lecz aby plugin się poprawnie uruchomił musimy zrobić jeszcze kilka rzeczy. Jedną z nich jest…
  
  Tworzenie pliku plugin.yml
  Aby Bukkit mógł poprawnie załadować nasz plugin musimy dostarczyć wraz z nim plik plugin.yml. Zawiera on kilka podstawowych informacji (szczegółowy opis znajdziesz tutaj). Niezbędne do działania jest ustawienie trzech atrybutów, są to:

  name:prosta nazwa pluginu.

  main:pełna nazwa głównej klasy pluginu.

  version:wersja pluginu.

  Plik możemy utworzyć klikając PPM na projekt, i z menu New > File.

  

  Po kliknięciu na „Finish” otworzy się nam domyślny edytor plików yml (najpewniej Notatnik). Możemy go spokojnie zamknąć, a następnie:
  • Złapać go myszką w Eksploratorze po lewej
  • Przeciągnąć nad główne okno edytora (na środek)
  • Puścić klawisz myszki
  Wykonanie powyższych instrukcji poskutkuje otworzeniem pliku plugin.yml bezpośrednio w Eclipse, co pozwoli na zachowanie większego porządku na pulpicie (mniej otwartych okien). Teraz wpiszemy to absolutne minimum. W moim wypadku będzie ono wyglądało następująco:

  name: HelloWorldPlugin

  main: com.gmail.marszczybrew1.helloworldplugin.HelloWorldPlugin

  version: 0.1

  Plugin gotowy, czas na…
  
  Eksportowanie pluginu do pliku JAR
  Aktualnie posiadamy absolutne minimum wymagane do uruchomienia pluginu przez Bukkita, czyli klasę rozszerzającą JavaPlugin oraz plik plugin.yml. W celu wyeksportowania pluginu postępujcie wg. poniższych instrukcji:

  1.Kliknij PPM na projekt

  2.Wybierz opcję Export

  3.W zakładce Java wybierz pozycję JAR file

  

  4.Wypełniamy okienko wg. wzoru, zwracając uwagę na kwadraciki zaznaczenia w górnej części:

  

  5.Gotowe! Plugin gotowy do uruchomienia J

  W moim przypadku w konsoli pojawia się coś takiego:

  

  Jak się domyśliliście, plugin jak na razie nie robi nic poza napisaniem w konsoli informacji o tym, że się uruchomił. Jest to jednak baza, w kolejnej części dodamy do niego jedną, może dwie funkcje
  
  Wszystkie wesje (łącznie z najnowszą, jeszcze nie wydaną) są dostępne tutaj.

[Piotruus]

Ładnie

[NakloPropSuPL]

Dore TuT'y dzięki może się naucze i będe na tym zarabiał ;3

[Tveter]

Fajne !! Maasz odemnie LUBIĘ TO!!