WebSocketServices

WebSocketServices

To plug-in toczący się projekt ewoluujący z zamiarem zapewnienia wsparcia webowego, poprzez websockets, dla serwerów Minecraft Bukkit. Ta implementacja websockets została zaprojektowana tak, aby była lekka i prosta, redukując narzut na sam serwer gry. Klienci, którzy obsługują websockets, będą mogli wykonywać proste zapytania informacyjne, takie jak kto jest online, jaka wersja serwera jest uruchomiona, itp. Wszystkie wyniki oparte na tekście będą zwracane w prostym formacie JSON dla spójności.

Services

Usługi to metody oparte na tekście, które skrypt po stronie klienta może wywołać za pomocą wtyczki WebSocketServices, aby uzyskać więcej informacji o serwerze Minecraft. Dodatkowo każdą usługę można włączyć lub wyłączyć w zależności od preferencji użytkownika. Poniższe usługi są obecnie dostępne i mogą być rozszerzane poprzez użycie niestandardowych wtyczek:

1. Info - Informacje o serwerze, takie jak adres, MOTD, wersja, tryb gry, itp.
2. WHO - Informacje o użytkownikach obecnie online.
3. Whitelist - Informacje o osobach aktualnie znajdujących się na białej liście.
4. Plugins - Informacje o wszystkich wtyczkach uruchomionych na serwerze.
5. OfflinePlayers - Informacje o wszystkich graczach offline.
6. Player - Informacje o konkretnym graczu.

Sample site

Przykładowa implementacja skryptowania po stronie klienta działająca na tej wtyczce może być znaleziona pod adresem URL podanym poniżej. Strona działa w czystym HTML5 i JS. Należy pamiętać, że przykładowa strona wymaga przeglądarki z obsługą HTML5 i WebGL.

http://www.caffeinatedrat.com/minecraft/

Compatibility Notes

Ta wtyczka jest obsługiwana jedynie przez przeglądarki obsługujące protokół Websockets RFC 6455. Do przeglądarek należą:

• Firefox 11+
• Chrome 16+
• Safari 6+
• IE 10+

BUG NOTICE (Versions 1.1.6 and lower)

Obecnie występuje błąd w usłudze offlinePlayer, gdzie wszystkie wywołania do niej są odrzucane. To bardzo prosta naprawa i zostanie naprawiona w wersji 1.1.7. Aby naprawić problem na swoim serwerze, przejdź do pliku config.yml dla tej wtyczki i zmień offlinePlayers na offlineplayers. Musi to być wszystko napisane małymi literami, jak pokazano poniżej. Przepraszam za wszelkie niedogodności, które mogą występować w tej chwili.

services:
  ...
  offlineplayers: true
  ...

Configuration

Szczegółowe informacje o konfiguracji twoich serwerów można znaleźć tutaj.

For Non-Developers

Pakiet po stronie klienta jest dołączony do tej wtyczki w formie przykładu. Aby korzystać z pakietu po stronie klienta, będziesz musiał mieć hostowaną stronę internetową lub blog, na którym można wyświetlić informacje o serwerze.

Przykładowa implementacja bloga może być znaleziona pod http://blog.caffeinatedrat.com (przepraszam, jeśli strona nie jest osiągalna. Obecnie mam problemy z moim hostingiem).

For Developers

Dodatkowa biblioteka po stronie klienta o nazwie websocketservices.min.js jest dostępna na GitHub i dołączona do pakietu do pobrania. Ta biblioteka powinna umożliwiać najprostsze z implementacji. Jeśli wolisz coś bardziej zaawansowanego lub chcesz dopasować do swoich upodobań, proszę przeczytać niżej podane sekcje.

Client-Side Development Notes

API WebSocketServices można znaleźć w lokalizacji wiki na GitHubie, wymienionej poniżej.

https://github.com/CaffeinatedRat/WebSocketServices/wiki

Przykłady implementacji kodu można znaleźć w GitHub pod sekcją 'examples/client-side/', a także na wspomnianej powyżej stronie próbnej.

Extensions

WebSocketServices może być rozszerzony poprzez niestandardowy development. Wtyczki mogą podłączać się do serwera WebSocketServices, tworząc własny ApplicationLayer i rejestrując się za pomocą statycznej metody WebSocketServices.registerApplicationLayer(Plugin plugin, IApplicationLayer applicationLayer). Dalsze szczegóły zostaną udostępnione na wiki GitHub w najbliższej przyszłości.

Source

Kod źródłowy i dalszy rozwój wtyczki można znaleźć w poniższym repozytorium GitHub:

https://github.com/CaffeinatedRat/WebSocketServices