Arkadia Web Client

Przeglądarkowy klient Arkadii (MUD) z wbudowaną mapą, systemem pluginów, własnymi triggerami, edytorem skryptów oraz konfigurowalną stroną ustawień. Aplikacja działa jako PWA — można ją zainstalować na komputerze i urządzeniach mobilnych.

Struktura projektu

Katalog	Opis
src/client	Skrypt uruchamiany w kliencie Arkadii; zawiera poprawki, triggery i towarzyszące skrypty.
src/web	Aplikacja React używana jako interfejs klienta i strona ustawień.
src/shared	Wspólny kod używany zarówno przez klienta jak i interfejs webowy.
src/modules	Moduły odpowiedzialne za usługi (event bus, storage, Firebase, zarządzanie urządzeniami).
editor	Edytor pluginów oparty na Monaco Editor.
viewer	Przeglądarka logów sesji.
log-viewer	Samodzielna przeglądarka logów (oddzielny entry point).
helper	Natywna aplikacja pomocnicza (Go) — system tray, hotkeye, zarządzanie oknem.
examples	Przykładowe pluginy z serwerem deweloperskim.
docs	Dokumentacja funkcjonalności (aliasy, bindy, walka, nawigacja, pluginy i inne).
plugin-types	Definicje typów TypeScript dla API pluginów.
e2e	Testy end-to-end używające Playwright.
test	Testy jednostkowe (Vitest).
scripts	Skrypty pomocnicze do generowania danych dla projektu.
public	Zasoby statyczne, manifest PWA i ikony.

Technologie

• React 19 + TypeScript 5.8
• Vite 7 (bundler i serwer deweloperski)
• React-Bootstrap 2 / Bootstrap 5
• Monaco Editor (edytor pluginów)
• Firebase (synchronizacja danych)
• Vitest (testy jednostkowe) + Playwright (testy e2e)
• Lua-in-js (wsparcie skryptów Lua)

Instalacja

Zainstaluj zależności:

yarn install

Rozwój

Uruchom serwer deweloperski:

yarn dev

Testy

Uruchom testy jednostkowe:

yarn test

Uruchom testy end-to-end:

yarn test:e2e

Uruchom linter:

yarn lint

Budowanie

Zbuduj aplikację:

yarn build

Podgląd zbudowanej aplikacji:

yarn preview

Pluginy

Generuj typy dla API pluginów:

yarn generate:plugin-types

Zbuduj przykładowe pluginy:

yarn build:examples

Uruchom serwer deweloperski przykładów:

yarn serve:examples

Więcej informacji o systemie pluginów: docs/PLUGINS.md.

Dokumentacja

Szczegółowa dokumentacja znajduje się w katalogu docs/:

• Przegląd — ogólny opis projektu
• Aliasy — definiowanie aliasów
• Bindy — skróty klawiszowe
• Walka — system walki
• Nawigacja — poruszanie się i mapa
• Ekwipunek — zarządzanie przedmiotami
• Zioła — system ziół
• Śledzenie — śledzenie postępów
• Skróty — skróty i komendy
• Synchronizacja — synchronizacja ustawień między urządzeniami
• Pluginy — tworzenie pluginów
• Testowanie skryptów — jak testować skrypty

Licencja

MIT