README.md

@@ -1,25 +1,28 @@
 # kostky
 
 Textová (CLI) hra v kostky pro více hráčů – varianta klasického *Farkle*
-(„tisícovky“). Běží celá v terminálu a je napsaná v čistém Pythonu bez
+(„tisícovky“). Běží celá v terminálu, v Pythonu, s jedinou závislostí
-externích závislostí.
+(`tabulate` pro závěrečnou výsledkovou tabulku).
 
 ## Požadavky
 
-- Python 3.7+ (hra se spoléhá na zachování pořadí klíčů ve slovníku)
+- Python 3.9+
-- Žádné externí balíčky – používá se jen standardní knihovna
+- Závislost `tabulate` (doinstaluje se automaticky při instalaci)
-  (`random`, `os`, `re`, `csv`, `collections`, `typing`)
 
-## Spuštění
+## Instalace a spuštění
 
 ```bash
 git clone https://gitea.spacilovi.eu/david/kostky.git
 cd kostky
-python main.py
+pip install .
+kostky
 ```
 
-> Hru spouštěj z adresáře projektu – soubor `hodnoty.csv` (bodovací tabulka)
+Případně bez instalace (s nainstalovaným `tabulate`) přes `python -m kostky`,
-> se načítá relativní cestou vůči aktuálnímu adresáři.
+nebo izolovaně jako CLI nástroj přes `pipx install .`.
+
+> Pro vývoj: `pip install -e ".[dev]"` – editovatelná instalace včetně `mypy`
+> a `ruff`.
 
 ## Jak se hraje
 
@@ -31,42 +34,45 @@ python main.py
 
 ### Průběh tahu
 
-Na začátku tahu uvidíš cílové skóre, kdo je na tahu (a jeho celkové skóre)
+Na začátku tahu uvidíš, kdo je na tahu (s jeho skóre a cílem), a hod šesti
-a hod šesti kostkami s očíslovanými pozicemi:
+kostkami s písmennými pozicemi:
 
 ```
-Vítězné skóre: 10000.
+Na tahu je Anna (0/10000).
-Na tahu je Anna (0).
 1, 5, 3, 2, 6, 4
 ^  ^  ^  ^  ^  ^
-1  2  3  4  5  6
+a  b  c  d  e  f
 ```
 
 Pak zvolíš jednu z akcí:
 
 | Vstup | Akce |
 | --- | --- |
-| `pozice kostek` | Odložíš vybrané kostky k vyhodnocení (např. `1`, `34`, `123456`). Hodnoty na zvolených pozicích musí dohromady tvořit některou kombinaci z bodovací tabulky. |
+| `pozice kostek` | Odložíš vybrané kostky k vyhodnocení – písmeny (např. `a`, `cd`, `abcdef`). Hodnoty na zvolených pozicích musí dohromady tvořit některou kombinaci z bodovací tabulky. |
 | `h` | Hodíš znovu zbývajícími kostkami. Povoleno až poté, co v tomto tahu odložíš aspoň jednu bodující kombinaci. |
 | `k` | Ukončíš tah, připíšeš si nasbírané skóre a předáš tah dalšímu hráči. |
+| `exit` | Předčasně ukončíš celou hru. |
 
 Odkládat můžeš i víc kombinací po sobě – po každém vyhodnocení pokračuješ se
 zbývajícími kostkami a body se v rámci tahu sčítají.
 
-### Smůla, hot dice a výhra
+### Smůla, hot dice, vynulování a výhra
 
 - **Smůla (bust):** když čerstvý hod neobsahuje žádnou bodující kombinaci,
   o body z tohoto tahu přijdeš a tah přechází na dalšího hráče.
 - **Hot dice:** když se ti podaří odložit všech šest kostek, dostaneš čerstvý
   hod šesti kostkami a pokračuješ ve stejném tahu.
-- **Výhra:** po dokončení každého kola se kontroluje, jestli někdo dosáhl
+- **Vynulování:** tři po sobě jdoucí nulové tahy vynulují tvé celkové skóre.
-  cílového skóre. Vyhrává osamocený lídr nad limitem; při shodě na první
+  Počet aktuálních nul se vedle skóre ukazuje jako `x` / `xx`.
-  příčce se hraje dál.
+- **Výhra:** po dokončení každého kola vyhrává osamocený lídr nad cílovým
+  skóre; při shodě na první příčce se hraje dál. Na konci se vypíše výsledková
+  tabulka s pořadím všech hráčů.
 
 ## Bodování
 
-Kompletní tabulka je v souboru [`hodnoty.csv`](hodnoty.csv). Kombinace se
+Kompletní tabulka je v souboru [`kostky/hodnoty.csv`](kostky/hodnoty.csv).
-vyhodnocuje podle hodnot odložených kostek – na jejich pořadí nezáleží.
+Kombinace se vyhodnocuje podle hodnot odložených kostek – na jejich pořadí
+nezáleží.
 
 ### Stejné kostky