Wtyczka WarpMarkers Bukkit

Ta wtyczka generuje plik JSON zawierający lokalizacje punktów warp z wtyczki Essentials Bukkit do użytku z różnym oprogramowaniem mapującym Minecraft. Klikając marker na mapie, wyświetlane są następujące informacje: nazwa punktu warp, kto go utworzył i kiedy, kto go ostatnio użył i kiedy. Ponadto WarpMarkers wyświetla komunikaty na żywo dla wszelkich zdarzeń związanych z punktem warp na mapie (może być wyłączone). Projekt zawiera wszystkie potrzebne pliki i instrukcje instalacyjne dla narzędzia Minecraft Overviewer map generator. Wyświetlane zdarzenia to: utworzenie punktu warp, użycie punktu warp i usunięcie punktu warp.

Żywa mapa wykorzystująca WarpMarkers znajduje się na mc.minecraftstuff.net

Zasoby

• Najnowsze stabilne wydanie
• Strona deweloperska Bukkit
• Github
• Śledzenie problemów
• Wiki

Instalacja

1. Pobierz plik ZIP
2. Wypakuj pobrany plik ZIP
3. Umieść plik WarpMarkers.jar w folderze z wtyczkami
4. Zatrzymaj i uruchom Minecraft
5. Przy pierwszym uruchomieniu WarpMarkers wygeneruje pliki konfiguracyjne potrzebne w folderze o nazwie WarpMarkers w folderze wtyczek zawierające wartości domyślne (domyślnie pliki JSON zostaną wyprowadzone do <minecraft_server_working_directory>/world/)
6. Aby dokonać zmian, zobacz sekcję konfiguracji poniżej

Konfiguracja

Poniższe opcje konfiguracyjne umożliwiające konfigurowanie samej wtyczki są dostępne w pliku <pluginfolder>/WarpMarkers/config.yml:

• interval (domyślnie 3000) jak często (w milisekundach) wtyczka powinna sprawdzać, czy trzeba wygenerować nowy plik wyjściowy
• outputFile (domyślnie world/warpmarkers.json) lokalizacja pliku JSON zawierającego wszystkie punkty warp
• updateFile: (domyślnie world/warpupdates.json) lokalizacja pliku JSON zawierającego aktualizacje punktów warp
• updateLife: (domyślnie 50000) najkrótsza ilość czasu (w milisekundach), przez którą aktualizacja powinna pozostawać w pliku JSON z aktualizacjami. Należy pamiętać, że ta wartość MUSI być większa niż wartość odświeżania ustawiona w pliku javascript-file

The following configuration options for configuring how the plugin interacts with the map are available in the WarpMarkers.js file (see the setup sections for more information about this file):

• refreshrate (default 5000) How often the script checks for an update in miliseconds, value MUST be lower than the updateLife-value set in the config.yml file
• show_notifications (default true) Set this to false to turn of all notifications (events, start, stop)
• marker_image (default "cropcircles.png") Image file used for markers
• markershadow (default "markershadow.png") Image file used for marker shadows
• warp_icon (default "warp.jpg") Icon showed in popups and notifications
• onbydefault (default true) Determines if warppoints should be shown on the map as soon as it renders, or only after the user clicks the button.
• warpmarkers_file (default "warpmarkers.json") The location of the main warpmarkers json file
• warpupdates_file (default "warpupdates.json") The location of the warpmarkers updates json file

Konfiguracja dla Minecraft Overviewer

1. Wykonaj instalację (patrz wyżej)
2. Edytuj <minecraftpluginfolder>/WarpMarkers/config.yml tak, aby plik warpmarkers.json został umieszczony w tym samym folderze co wyjście Minecraft Overviewer. Alternatywnie na GNU/Linux nie edytuj config.yml, stwórz symlink. Jeśli zmienisz nazwę pliku, musisz odzwierciedlić zmianę nazwy w pliku WarpMarkers.js.
3. Edytuj <minecraftpluginfolder>/WarpMarkers/config.yml tak, aby plik warpupdates.json został umieszczony w tym samym folderze co wyjście Minecraft Overviewer. Alternatywnie na GNU/Linux nie edytuj config.yml, stwórz symlink. Jeśli zmienisz nazwę pliku, musisz odzwierciedlić zmianę nazwy w pliku WarpMarkers.js.
4. Zatrzymaj Minecraft
5. Uruchom Minecraft
6. Skopiuj wszystkie pliki i foldery z folderu web_assets do folderu web_assets używanego przez Minecraft Overviewer.

7. Dodaj następujące trzy linie do pliku index.html w folderze web_assets używanego przez Minecraft Overviewer. Dodaj je bezpośrednio przed znacznikiem </head>:

   • <link rel="stylesheet" type="text/css" href="css/gritter.css" />
   • <script type="text/javascript" src="js/jquery.gritter.js"></script>
   • <script type="text/javascript" src="WarpMarkers.js"></script>

8. W tym samym pliku dodaj ;warpmarkers.init(); do zdarzeń onload w tagu docelowym. Innymi słowy zamień <body onload="overviewer.util.initialize()"> na <body onload="overviewer.util.initialize();warpmarkers.init();">

9. Uruchom Minecraft Overviewer i wszystko powinno działać

Konfiguracja dla Pigmap

TODO. Wkrótce.

Historia wersji

• 15 września 2011 - Wersja - 1.0.2

  • Naprawa błędu: WarpMarkers nadal nie były ładowane, jeśli Essentials nie uruchamiało się przy starcie zamiast nasłuchiwania Essentials.

• 13 września 2011 - Wersja - 1.0.1

  • Sprawdza uprawnienia przed generowaniem zdarzeń. Dzięki temu unika się fałszywych zdarzeń, jeśli użytkownik nie ma odpowiednich uprawnień.
  • Sprawdza, czy polecenie nie zostało wyłączone w konfiguracji Essentials przed generowaniem zdarzeń. Dzięki temu unika się fałszywych zdarzeń, gdy użytkownik próbuje użyć wyłączonego polecenia.
  • Jeśli Essentials nie jest uruchomiony, WarpMarkers będzie teraz czekać na jego uruchomienie w przyszłości, zamiast kończyć z komunikatem o błędzie.
  • Teraz zawiesi i wznowi pracę, gdy Essentials będzie wyłączony i ponownie włączony.

• 12 września 2011 - Wersja 1.0.0

  • Pierwsze wydanie

Znane błędy

• Nie mamy sposobu, aby wiedzieć, czy zdarzenie wystąpi, gdy gracz wchodzi w interakcję ze znakiem przed lub po wtyczce Essentials. Oznacza to, że nie możemy sprawdzić, czy użytkownik ma wystarczające kredyty jeśli znak Warp kosztuje kredyty do użycia. To może prowadzić do fałszywych zdarzeń wyświetlanych na mapie, gdy użytkownik nie ma wystarczających kredytów, kliknie w znak.

Planowane

• Dodanie plików i instrukcji dotyczących używania WarpMarkers z Pigmap oraz perhaps innym oprogramowaniem mapującym
• Dodanie wsparcia dla Warpx0r i innych podobnych wtyczek
• Implementacja /setwarpdiscription (z uprawnieniami), które będzie wyświetlać na mapie

Budowanie

1. Rozpakuj plik ZIP lub sklonuj projekt (git clone git@github.com:deadcyclo/WarpMarkers.git)
2. Utwórz podkatalog o nazwie lib
3. Pobierz plik .jar Craftbukkit i umieść go w katalogu lib
4. Jeśli inna wersja, zmień nazwę na craftbukkit-0.0.1-SNAPSHOT.jar
5. Pobierz plik .jar Essentials i umieść go w katalogu lib
6. Jeśli inna wersja, zmień nazwę na Essentials.jar
7. Pobierz plik JSON simple .jar i umieść go w katalogu lib
8. Jeśli inna wersja, zmień nazwę na json_simple-1.1.jar
9. Utwórz plik plugin.yml dla projektu
10. W katalogu głównym uruchom make (lub make WarpMarkers.jar lub make WarpMarkers.zip)

Wkład

1. Forkuj projekt.
2. Stwórz gałąź (git checkout -b my_project)
3. Zapisz zmiany (git commit -am "Dodano coś")
4. Wypchnij na gałąź (git push origin my_project)
5. Utwórz [Issue][1] z linkiem do Twojej gałęzi
6. Miłej kawy i cierpliwości

Zewnętrzne projekty używane

Powiadomienia używają gritter wtyczki jQuery autorstwa Jordana Boesch

Ikona znacznika mapy (cropcircles.png) pochodzi z Map Icons Collection project autorstwa Nicolasa Molleta

Ikona WarpMarkers warp.jgp jest przeróbką tego obrazu autorstwa Torley Olmstead

Poniższe biblioteki również były używane:

• Essentials
• JSON simple
• Craftbukkit