119 lines
5.5 KiB
Markdown
119 lines
5.5 KiB
Markdown
# Politické karty
|
||
|
||
Kompletný samostatný projekt hry: Node.js server, prehliadačové rozhranie a pravidlá. Nepotrebuje npm závislosti; stačí Node.js 18 alebo novší.
|
||
|
||
## Spustenie
|
||
|
||
```bash
|
||
node server.js
|
||
```
|
||
|
||
Potom otvor `http://localhost:3000`. Port je možné zmeniť premennou prostredia `PORT`.
|
||
|
||
Alternatívne:
|
||
|
||
```bash
|
||
npm start
|
||
npm test
|
||
```
|
||
|
||
## Nasadenie na server (Docker + nginx s HTTPS)
|
||
|
||
Kontajner počúva iba na `127.0.0.1:8347`, takže z internetu je dostupný len cez nginx na tom istom serveri. Vo vnútri kontajnera beží aplikácia na porte 3000, ten však navonok viditeľný nie je.
|
||
|
||
### 1. Spusti kontajner
|
||
|
||
Skopíruj priečinok projektu na server a v ňom spusti:
|
||
|
||
```bash
|
||
docker compose up -d --build
|
||
curl http://127.0.0.1:8347/api/ping # {"ok":true}
|
||
```
|
||
|
||
Iný port: `HOST_PORT=9000 docker compose up -d` (potom zmeň aj riadok `upstream` v `deploy/nginx.conf`).
|
||
|
||
Kontajner beží ako neprivilegovaný používateľ `node`, so súborovým systémom iba na čítanie, bez Linuxových capabilities, s limitom 256 MB pamäte a 100 procesov. Pri páde sa automaticky reštartuje (`restart: unless-stopped`) a má health check na `/api/ping`.
|
||
|
||
### 2. Nastav nginx
|
||
|
||
```bash
|
||
sed -i 's/karty.example.com/tvoja.domena.sk/g' deploy/nginx.conf
|
||
sudo cp deploy/nginx.conf /etc/nginx/conf.d/politicke-karty.conf
|
||
# ak ešte nemáš certifikát:
|
||
sudo certbot certonly --webroot -w /var/www/html -d tvoja.domena.sk
|
||
sudo nginx -t && sudo systemctl reload nginx
|
||
```
|
||
|
||
`deploy/nginx.conf`:
|
||
|
||
- presmeruje HTTP na HTTPS (cesta `/.well-known/acme-challenge/` ostáva na HTTP kvôli obnove certifikátov),
|
||
- používa TLS 1.2/1.3, HTTP/2 a HSTS,
|
||
- pre `/api/events` (SSE živé aktualizácie) vypína buffering a dovoľuje hodinu otvorené spojenia; bez toho by hra zamŕzala,
|
||
- obmedzuje API požiadavky (10/s na IP, burst 30) a živé spojenia (20 na IP),
|
||
- nezapisuje `/api/events` do access logu, lebo URL obsahuje token hráča.
|
||
|
||
Poznámky:
|
||
|
||
- Cesty k certifikátu sú predvolené pre certbot (`/etc/letsencrypt/live/<doména>/`). Pri vlastnom certifikáte uprav `ssl_certificate` a `ssl_certificate_key`.
|
||
- `http2 on;` vyžaduje nginx 1.25.1 alebo novší. Na staršom nginx ten riadok zmaž a použi `listen 443 ssl http2;`.
|
||
- Súbor musí byť načítaný v kontexte `http {}` (to platí pre `conf.d/` aj `sites-enabled/`), lebo obsahuje `limit_req_zone` a `limit_conn_zone`.
|
||
|
||
### 3. Aktualizácia a správa
|
||
|
||
```bash
|
||
docker compose up -d --build # po zmene kódu
|
||
docker compose logs -f # logy
|
||
docker compose down # zastavenie
|
||
```
|
||
|
||
Reštart kontajnera ukončí všetky rozohrané hry (stav je len v pamäti).
|
||
|
||
### Limity a premenné prostredia
|
||
|
||
| Premenná | Predvolené | Význam |
|
||
| --- | --- | --- |
|
||
| `HOST_PORT` | `8347` | port na `127.0.0.1` hostiteľa (iba docker compose) |
|
||
| `PORT` | `3000` | port aplikácie vo vnútri kontajnera |
|
||
| `MAX_CLIENTS_PER_ROOM` | `64` | max. živých spojení divákov v jednej miestnosti (hráči sa pripoja vždy) |
|
||
| `MAX_CLIENTS_TOTAL` | `2000` | max. živých spojení na celom serveri |
|
||
| `ROOM_GRACE_MS` | `120000` | po koľkých ms bez jediného pripojeného hráča miestnosť zanikne (zo zoznamu zmizne hneď) |
|
||
|
||
Server má aj pevný limit 500 miestností a 20 kB na telo požiadavky.
|
||
|
||
## Herné režimy
|
||
|
||
- **Balanced** – prvý návrh úprav podľa statickej analýzy kariet. Oslabuje najextrémnejšie pasívne a okamžité efekty a posilňuje niekoľko výrazne slabých kariet.
|
||
- **Fun** – pôvodné hodnoty kariet a schopností. Multiplayerové pravidlá a časovanie celých kôl sú rovnaké v oboch režimoch.
|
||
|
||
Režim sa vyberá v hlavnom menu alebo pri vytváraní online miestnosti. Online miestnosť si ho uloží a server je autoritatívny.
|
||
|
||
## Online multiplayer
|
||
|
||
- Free-for-all pre 2 až 8 hráčov.
|
||
- Pri vytváraní miestnosti sa volí kapacita; predvolená hodnota je 6.
|
||
- Každý hráč si vyberie vlastný tím štyroch kariet. Karty sa môžu opakovať medzi tímami.
|
||
- Tvorca miestnosti (hráč 1) spustí hru tlačidlom **Spustiť hru**, keď sú pripravení aspoň dvaja hráči a každý aktuálne pripojený hráč má potvrdený tím.
|
||
- Hrá sa každý proti každému; útoky a nepriateľské schopnosti môžu cieliť na ktoréhokoľvek súpera.
|
||
- Ťahy rotujú v poradí hráčov. Vyradení hráči sa preskakujú.
|
||
- Vyhráva posledný hráč, ktorému zostala aspoň jedna karta na stole alebo v rezerve.
|
||
- Po začatí hry sa ďalší návštevníci pripájajú ako diváci.
|
||
- Stav miestností sa drží v pamäti procesu; po reštarte servera sa miestnosti stratia.
|
||
|
||
## Obrázky kariet
|
||
|
||
Obrázky sú voliteľné. Vlož ich do `public/img/` a pomenuj podľa kľúča karty, napríklad:
|
||
|
||
```text
|
||
public/img/meciar.jpg
|
||
public/img/caputova.webp
|
||
```
|
||
|
||
Podporované prípony: `.jpg`, `.jpeg`, `.png`, `.webp`, `.gif`. Dočasné obrázky možno pomenovať napríklad `meciar.kandidat.webp`; hotový `meciar.webp` má prednosť.
|
||
|
||
## Poznámky
|
||
|
||
- `public/game.js` obsahuje karty aj pravidlá a používa ho prehliadač i server.
|
||
- `server.js` implementuje miestnosti, SSE aktualizácie a serverové vyhodnocovanie akcií.
|
||
- Online server nemá používateľské účty ani databázu. Zoznam miestností je verejný a ktokoľvek môže sledovať hru ako divák. Pre verejné nasadenie používaj HTTPS a obmedzenie požiadaviek (viď [Nasadenie na server](#nasadenie-na-server-docker--nginx-s-https)). Rate limiting sťaží, ale úplne nezabráni tomu, aby niekto zaplnil všetkých 500 miestností.
|
||
- Balanced je počiatočný návrh, nie výsledok simulácií ani dlhodobého playtestovania. Číselné zmeny sú popísané v `docs/BALANCE.md`.
|