Literaki to dwu-osobowa gra, która polega na zgadywaniu przysłowia z wylosowanej kategorii. Pierwsza osoba, która otworzy grę musi poczekać na dołączenie drugiego gracza. W zależności od postępów dostaje odpowiednie komunikaty:
Gdy dwóch graczy pomyślnie połączy się ze sobą, to tworzona jest między nimi nowa rozgrywka:
Na górze strony mamy belkę z dwiema informacjami - aktualnie rozgrywającą osoba i wylosowaną kategorią. Na środku strony mamy zakryte litery hasła, które w trakcie zgadywania będą systematycznie odsłaniane.
Na dole znajduje się belka z miejscem do wysyłania literek do przysłowia, informację o aktualnej rundzie oraz pole do wysyłania wiadomości do naszego rywala. Każdy gracz może od razu odgadnąć hasło, wpisując całe przysłowie zamiast pojedynczego znaku. Gdy hasło zostanie zgadnięte to każdy gracz dostaję o tym informację.
Dodatkowym udogodnieniem pozwalającym na komunikację między uczestnikami gry jest chat. Po wysłaniu naszej wiadomości do drugiego gracza, jest ona wyświetlana w polu po prawej stronie wraz z informacją o nadawcy i czasem wysłania.
- Backend napisany jest w Pythonie, dlatego wymaga zainstaowanego interpretera w wersji przynajmniej
3.7
. Interpreter można pobrać stąd: https://www.python.org/downloads/ - Dodatkowo, potrzebujemy zainstalowanej biblioteki
websockets
. Zainstalujemy ją komendą:
pip install websockets
- Frontend napisany został w React.js. Wymagany jest zaintalowany serwer node.js wraz z npm: https://nodejs.org/en/download/. Dodatkowo musimy mieć zainstalowanego w systemie
yarna
: https://yarnpkg.com/ - Aby zainstalować wszystkie zależności, przechodzimy do katalogu
frontend
i wykonujemy komendęyarn install
:
cd frontend
yarn install
- Backend (serwer) - serwer uruchomimy komendą
python run.py
- Frontend (klient) - aby uruchomić klienta, przechodzimy do folderu
frontend
i wykonujemy polecenieyarn start
:
cd frontend
yarn start
- Istnieje możliwość uruchomienia całości jedną komendą. Na windowsie będzie to:
run.bat