ExternalChat

ExternalChat

Przegląd

Ten plugin umożliwia wysyłanie wiadomości czatu ze strony internetowej. Wykorzystuje JSON do komunikacji wewnątrz i na zewnątrz świata Minecraft. Użytkownicy sieci są uwierzytelniani na serwerach Minecrafta, aby zapewnić dokładne potwierdzenie, kto wysyła wiadomości.

• Przetestowano poprawnie w CB 1.1-R6
• Przetestowano poprawnie w CB 1.2.2-Dev

Funkcje

• Wysyłanie wiadomości do klientów Minecrafta z poziomu przeglądarki
• Wysyłanie wiadomości do sieci z poziomu Minecrafta
• Bezpieczne uwierzytelnianie użytkowników sieci WWW
• Nie wymaga bazy danych
• Użytkownicy używają swojej nazwy użytkownika Minecraft i hasła

Konfiguracja

Konfiguracja wtyczki

• show_death (domyślnie: true) - Wysyła wiadomości o śmierci do sieci
• death_name (domyślnie: Humiliator) - Podczas wysyłania wiadomości o śmierci do sieci, jaka nazwa użytkownika powinna być wyświetlana
• chat_delay (domyślnie: 3000) - Liczba milisekund między sprawdzaniem nowych wiadomości
• clean_delay (domyślnie: 30000) - Liczba milisekund między sprawdzaniem, by oczyścić stare wiadomości
• clean_age (domyślnie: 45000) - Liczba milisekund, po których wiadomość uznawana jest za starą i usuwana
• chat_file (domyślnie: map/inChat.json) - Nazwa pliku używanego do odczytu i zapisu wiadomości

Konfiguracja serwera Minecraft

• Serwer Minecraft musi mieć dostęp do odczytu i zapisu do chat_file zgodnie z konfiguracją wtyczki

Konfiguracja serwera WWW

• Wersja PHP > 5.2.0, lub włączone rozszerzenia JSON
• Certyfikat SSL zainstalowany i skonfigurowany
• Uprawnienia zapisu na następujących plikach: chat_sessions, inChat.json

Konfiguracja player_chat.js

• player_chat.js: line 1 - chatRead (domyślnie: /inChat.json) - Nazwa pliku używanego do odczytu wiadomości
• player_chat.js: line 2 - chatWrite (domyślnie: /outChat.php) - Nazwa pliku używanego do zapisu wiadomości po uwierzytelnieniu
• player_chat.js: line 3 - authenticator (domyślnie: /minecraft_authenticator.php) - Nazwa pliku używanego do wysyłania żądań uwierzytelniających
• player_chat.js: line 4 - expireDays (domyślnie: 365) - Liczba dni, przez które ciasteczko powinno pozostać aktywne w przeglądarce klienta
• player_chat.js: line 5 - chatDelay (domyślnie: 3000) - Liczba milisekund między sprawdzaniem nowych wiadomości

Konfiguracja outChat.php

• outChat.php: line 2 - chatJSON (domyślnie: inChat.json) - Nazwa pliku używanego do zapisu wiadomości
• outChat.php: line 3 - sessionFile (domyślnie: chat_sessions) - Nazwa pliku używanego do odczytu i zapisu informacji o sesji
• outChat.php: line 4 - timeZone (domyślnie: America/New_York) - Specyfikacja strefy czasowej serwera (zobacz: Obsługiwane strefy czasowe PHP) dla obsługiwanych stref czasowych

Konfiguracja minecraft_authenticator.php

• minecraft_authenticator.php: line 2 - sessionFile (domyślnie: chat_sessions) - Nazwa pliku używanego do odczytu i zapisu informacji o sesji

Wymagania

• Serwer WWW musi używać SSL (chociaż nie jest to technicznie wymóg, to bardzo niezalecane jest wysyłanie informacji uwierzytelniających przez połączenie nie-SSL. Jeśli zdecydujesz się zmodyfikować te pliki, aby to umożliwić, poinformuj swoich użytkowników.)
• Jeżeli sama strona czatu nie jest ładowana poprzez HTTPS, przeglądarka klienta musi obsługiwać nagłówek Access-Control-Allow-Origin (większość przeglądarek tak). Wynika to z zasad bezpieczeństwa AJAX między domenami.
• Plik chat_sessions nie powinien być dostępny przez sieć. Serwer musi mieć możliwość odczytu i zapisu do tego pliku, ale nie powinien być wyświetlany użytkownikom świata.

Instalacja

• Aby zainstalować wtyczkę, po prostu umieść plik jar w katalogu plugins.
• Skopiuj pliki js/player_chat.js, outChat.php, minecraft_authenticator.php, inChat.json, chat_sessions oraz chat.html do swojego katalogu serwera WWW
• Ustaw uprawnienia zapisu dla serwera WWW na plikach chat_sessions i inChat.json
• Ustaw uprawnienia zapisu dla serwera Minecraft na pliku inChat.json
• Uruchom serwer CraftBukkit i czatuj.

Polecenia

• private Pozwala graczowi ustawić tryb czatu na prywatny (tj. jego wiadomości czatu nie będą publikowane w sieci).
• public Pozwala graczowi przywrócić tryb czatu do publicznego (tj. jego wiadomości czatu będą publikowane w sieci).

Bugbaj/ Known Limitations

• Plik chat.html jest dołączony wyłącznie jako przykład. Nie jest ładny i ma na celu umożliwienie integracji funkcji czatu tam, gdzie i jak chcesz.
• Wiadomości wysyłane z Minecrafta zawierające notację HTML będą wyświetlać HTML na stronie czatu. (potencjał nadużyć)
• Funkcja czatu wymaga, aby użytkownicy sieci posiadali konto Minecraft do uwierzytelnienia. Jeśli użytkownik nie ma konta premium, i tak będzie mógł czatować.

Planowana przyszłość

• Może integracja z Facebookiem
• Ogłaszanie użytkowników sieci wewnątrz Minecraft
• Escapowanie wszelkich wiadomości czatu w HTML wychodzących z Minecraft