summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoremkael <emkael@tlen.pl>2021-11-22 00:19:53 +0100
committeremkael <emkael@tlen.pl>2021-11-22 00:19:53 +0100
commitc38aa21fe8b488da0e27f4e7c0d0d08ff5fca348 (patch)
treee16330b0e4048e38114a5181dc50d0943f0dc798 /README.md
parent3e1205db16fbf324daa0c8eff1364712854310f2 (diff)
Documentation updated
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 48 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7cd989c..d61363a 100644
--- a/README.md
+++ b/README.md
@@ -94,6 +94,7 @@ Zmienne środowiskowe:
* `LIGA_MYSQL_CONNECTION_OPTS`: komplet przełączników polecenia `mysql` pozwalający podłączyć się do docelowego (lokalnego) serwera MySQL
* `LIGA_BUTLER_FINISHED_ROUND`, `LIGA_BUTLER_FINISHED_SEGMENT`: opcjonalne, jeśli ustawione, docelowy turniej cofany jest tylko do zdefiniowanego momentu, a nie do samego początku (żeby nie przeliczać wszystkich rund po kolei za każdym razem)
+ * `LIGA_BUTLER_TABLE_STEP`, `LIGA_BUTLER_TEAM_STEP` i `LIGA_BUTLER_PLAYER_STEP` (opcjonalne) definiują, o ile podbijane są dla każdego kolejnego zbijanego turnieju bazodanowe ID stołów, teamów i graczy - numeracja stołów i teamów po tej operacji musi być ciągła
Plik konfiguracyjny `config.json`:
@@ -116,7 +117,7 @@ Pozostałe klucze słownika w `config.json` przyjmują następującą postać:
W takiej konfiguracji `identyfikator_turnieju` jest parametrem wywołania skryptu `butler/butler.py`, a źródłowe turnieje zbijane są w zdefiniowanej kolejności i umeiszczane w docelowej bazie danych.
-Dodatkowo, w pliku `butler/butler.py` zakładane są następujące maksymalne rozmiary turniejów źródłowych:
+Dodatkowo, w pliku `butler/butler.py` zakładane są następujące maksymalne rozmiary turniejów źródłowych, możliwe do przesłonięcia zmiennymi środowiskowymi `LIGA_BUTLER_*_STEP`:
* zmienna `TABL_STEP` (liczba stołów w turnieju): 8
* zmienna `TEAM_STEP` (liczba teamów w turnieju): 16
* zmienna `PLAYER_STEP` (liczba zawodników w turnieju): 400
@@ -147,12 +148,54 @@ Zmienna środowiskowa `LIGA_PLAYERS_DB_NAME`: nazwa bazy danych JFR Players.
Importuje `baza.csv` do bazy zawodników w stylu JFR. Nazwa bazy do importu czytana jest ze zmiennej środowiskowej `LIGA_PLAYERS_DB_NAME`.
+`make teams`
+
+Sprawdza przynależność graczy do drużyn, wg przypisania w Cezarze. Wymaga CSVki w specyficznym formacie, zawierającej ID drużyn z Cezara. Jej URL ustawia się dla `import-players.sh`, w zmiennej `LIGA_BAZA_CSV`. Mapowanie drużyn w bazach danych turniejów odbywa się przy pomocy plików `.dumps/.cezar-teams-*`.
+
+Wywołuje `dumps/check-all-teams.sh`, które pobiera z `dumps/.paid-queries` argumenty do wywołania, kolejno, `dumps/check-teams.sh TURNIEJ`.
+
`make paid`
Sprawdza status opłacenia składek wśród graczy, którzy wystąpili w turnieju teamów w danym zakresie segmentów.
Wywołuje `dumps/check-all-paid.sh`, które pobiera z `dumps/.paid-queries` argumenty do wywołania, kolejno, `dumps/check-paid.sh TURNIEJ SEGMENT_OD SEGMENT_DO`.
+`make lineups`
+
+Sprawdza poprawność lineupów oraz spójność lineupów z tabelą `butler` w turniejach.
+
+Wywołuje `dumps/check-all-lineups.sh`, które pobiera z `dumps/.paid-queries` argumenty do wywołania, kolejno, `dumps/check-lineups.sh TURNIEJ`.
+
+`make checks`
+
+Wywołuje kolejno `paid`, `teams` i `lineups`.
+
+## Strona z rozkładami
+
+Generator plików dla strony z rozkładami do publikacji przy wynikach.
+
+### Wymagania
+
+ * [deal-convert](https://github.com/emkael/deal-convert) (uwaga: Python 2.x!) wraz z podmodułami
+ * lftp, do wysyłania wygenerowanych stron
+
+### Konfiguracja
+
+Zmienne środowiskowe:
+
+ * `LIGA_BOARDS_DEAL_CONVERT_PATH` - ścieżka do `deal-converter.py`
+ * `LIGA_BOARDS_FTP_ENABLED` - włącza synchronizację przez FTP
+ * `LIGA_BOARDS_FTP_PATH` - ścieżka na serwerze zdalnym
+ * `LIGA_FTP_HOST`, `LIGA_FTP_USER`, `LIGA_FTP_PASS`
+
+Pliki JSON w `boards/config` - definiują, które pliki PBN z `boards/pbns` mają zostać przetworzone i wyświetlone na stronie. Generowane są strony dla każ∂ego z obecnych tam plików `*.json`, z osobna, przyjmując jego nazwę jako identyfikator.
+
+Szablony stron rozkładów można zdefiniować w `boards/template/IDENTYFIKATOR.html`. Do zaślepki `<!---[LOGOH]--->` wpisywana jest zawartość pliku `boards/template/IDENTYFIKATOR.logo.html.
+
+### Wywołania
+
+`make records` lub `./boards/run.sh`
+
## Play-off
Moduł zewnętrzny, generujący i wysyłający drabinki play-off.
@@ -168,9 +211,9 @@ Szczegółowa dokumentacja: [liga-playoff](https://github.com/PZBS/liga-playoff)
Zmienne środowiskowe:
- * `LIGA_PLAYOFF_FTP_HOST`
- * `LIGA_PLAYOFF_FTP_USER`
- * `LIGA_PLAYOFF_FTP_PASS`
+ * `LIGA_FTP_HOST`
+ * `LIGA_FTP_USER`
+ * `LIGA_FTP_PASS`
* `LIGA_PLAYOFF_FTP_PATH`
Dane dostępu do FTP
@@ -178,6 +221,6 @@ Dane dostępu do FTP
### Wywołanie
-`make playoff`
+`make brackets`
Wygenerowane i wysłane zostaną wszystkie drabinki zdefiniowane w `scripts/.groups` z podmodułu `playoff`.