War in Tunnels

War in Tunnels – to terminalowa gra typu RTS (real‑time strategy) rozgrywająca się pod ziemią. Gra wykorzystuje bibliotekę ratatui do budowy interfejsu tekstowego oraz rodio do odtwarzania ścieżek dźwiękowych. Projekt jest skonfigurowany jako Nix Flake, co ułatwia zarządzanie zależnościami, budowanie wersji produkcyjnej oraz deweloperskiej.

Funkcjonalności

• Tekstowy interfejs użytkownika z podziałem na menu, podgląd mapy i panel boczny.
• Różne tryby gry (np. Last‑Man‑Standing).
• Skalowanie mapy i poziom przybliżenia UI.
• Wsparcie dla kilku zestawów perków.
• Konfigurowalne zasoby startowe (drewno, żelazo) oraz limit jednostek.
• System punktów doświadczenia i limitu punktów umiejętności.
• Odtwarzanie ścieżek dźwiękowych (możliwość wyciszenia lub wyłączenia).

Wymagania

• Nix (z obsługą Flake) – do budowania i uruchamiania projektu.
• Rust 2024 edition – używany wewnątrz środowiska Nix (fenix toolchain).
• Biblioteki systemowe: alsa-lib (dla obsługi dźwięku).

Budowanie i uruchamianie

Projekt udostępnia dwa profile Flake:

• default – wersja produkcyjna (z optymalizacjami).
• develop – wersja deweloperska z dodatkowymi zależnościami i nie‑zoptymalizowanym kodem.

Przykładowe polecenia

# Budowanie wersji produkcyjnej
nix build

# Uruchomienie wersji produkcyjnej
nix run

# Budowanie wersji deweloperskiej
nix build .#develop

# Uruchomienie wersji deweloperskiej
nix run .#develop

W środowisku deweloperskim dostępny jest także shell z pre‑konfigurowanymi zmiennymi:

nix develop

Po wejściu do powłoki pojawi się informacja o wersji oraz dostępne komendy.

Opcje wiersza poleceń (CLI)

Gra korzysta z biblioteki clap – wszystkie opcje są dostępne jako flagi. Poniżej najważniejsze:

Skrót	Flaga	Domyślna wartość	Opis
-v	--view	MainMenu	Określa początkowy widok UI.
-u	--username	Player	Nazwa gracza wyświetlana w interfejsie.
-g	--game-mode	LastManStanding	Tryb rozgrywki.
-W	--map-width	42	Szerokość generowanej mapy (36‑108).
-H	--map-height	11	Wysokość mapy (11‑39).
-z	--zoom-level	Default	Poziom przybliżenia UI.
-p	--perk-deck	Silesian	Zestaw perków.
-w	--starting-wood	50	Początkowa ilość drewna (1‑150).
-i	--starting-iron	25	Początkowa ilość żelaza (1‑150).
-L	--supply-limit	99	Limit jednostek na mapie (49‑149).
-x	--xp-modifier	1.0	Mnożnik doświadczenia (0.5‑2.0).
-P	--skill-points-limit	120	Górny limit punktów umiejętności (90‑690).
-S	--soundtrack	Default	Wybór ścieżki dźwiękowej.
-D	--disable-audio	false	Wyłącza odtwarzanie dźwięku.
-m	--mute	false	Wycisza odtwarzany dźwięk.
-l	--log	false	Włącza logowanie do pliku.

Aby wyświetlić pomoc, uruchom:

cargo run -- -h

Struktura projektu

• src/main.rs – punkt wejścia, inicjalizuje terminal, wątki i główną pętlę aplikacji.
• src/lib.rs – eksportuje moduły aplikacji i CLI.
• src/app/ – logika gry, stany, widoki i obsługa klawiszy.
• src/cli.rs – definicja opcji CLI.
• Cargo.toml – zależności Rust (ratatui, clap, log, simplelog, rodio, once_cell).
• flake.nix – opis flake, zależności Nix, profile build i develop.

Dźwięk

Ścieżki dźwiękowe znajdują się w folderze soundtracks. Biblioteka rodio odtwarza je w oddzielnym wątku. Dostępne flagi pozwalają wybrać konkretną ścieżkę, wyciszyć lub całkowicie wyłączyć dźwięk.

Logowanie

Gdy flaga --log jest włączona, aplikacja zapisuje logi do pliku przy użyciu simplelog. Domyślnie logowanie jest wyłączone.