diff --git a/.env.example b/.env.example index a8928d7b..eb675370 100644 --- a/.env.example +++ b/.env.example @@ -10,7 +10,7 @@ DEPOT_DOWNLOADER_CMD=~/Downloads/DepotDownloader-windows-x64 # https://github.com/deadlock-wiki/DeadlockEntityHelper # Required for parsing the game map -ENTITY_HELPER_CMD="/~Downloads/DeadlockEntityHelper.exe" +ENTITY_HELPER_CMD="~/Downloads/DeadlockEntityHelper.exe" # === DEADBOT STEPS === # Import game files from remote sources diff --git a/README.md b/README.md index 7f0c63d4..7d389f1f 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Deadbot is an open-source automation tool for extracting and processing game dat * **Data Extraction:** Downloads the latest game files by cloning the [SteamDB GameTracking-Deadlock repository](https://github.com/SteamDatabase/GameTracking-Deadlock) and using DepotDownloader for non-English localizations. * **Decompilation:** Processes raw game assets (`.vdata_c`, localization files) into structured JSON. * **Data Parsing:** Parses decompiled files to extract detailed stats for heroes, abilities, items, and NPCs. -* **Changelog Aggregation:** Fetches official patch notes and in-game "Hero Lab" changes. +* **Changelog Aggregation:** Fetches official patch notes via the Steam Web API. (Historical forum changelogs are retained locally). * **Wiki Integration:** Formats game data as JSON and changelogs into wikitext and uploads them directly to the Deadlock Wiki. @@ -86,6 +86,10 @@ The recommended way to use Deadbot is by downloading the pre-built executable. T | `STEAM_PASSWORD` | `mySteamPassword` | ❌ (For non-English parsing) | Your Steam account password. | | `OUTPUT_DIR` | `../deadlock-data/data/current` | ❌ (Defaults to `./output-data`) | Where the parsed data files will be saved. | | `DEPOT_DOWNLOADER_CMD` | `C:\Tools\DepotDownloader.exe` | ❌ (For non-English parsing) | Path to the DepotDownloader executable. | + | `WORK_DIR` | `./decompiled-data` | ❌ (Defaults to `./decompiled-data`) | Directory for temporary decompiled working files. | + | `INPUT_DIR` | `./input-data` | ❌ (Defaults to `./input-data`) | Input directory for changelogs and wiki pages. | + | `ENTITY_HELPER_CMD` | `C:\Tools\DeadlockEntityHelper.exe` | ❌ (For map parsing) | Path to the DeadlockEntityHelper executable. | + | `CLEANUP` | `false` | ❌ (Defaults to `false`) | Cleans up the temporary working directory after execution. | For a full list of all parameters, see the [Parameters](#parameters) section below. @@ -120,15 +124,15 @@ poetry run deadbot --import_files --parse | | `-n, --inputdir INPUTDIR` | Input directory for changelogs and wiki pages. | `INPUT_DIR` | | | `-o, --output OUTPUT` | Output directory for generated files. | `OUTPUT_DIR` | | | `--english-only` | Only parse English localizations. | `ENGLISH_ONLY` | -| | `--force` | Forces decompilation even if game files and workdir versions match. | | -| | `-v, --verbose` | Enable verbose logging for detailed output. | | +| | `--force` | Forces decompilation even if game files and workdir versions match. | `FORCE` | +| | `-v, --verbose` | Enable verbose logging for detailed output. | `VERBOSE` | | **Steam Config** | `--steam_username STEAM_USERNAME` | Steam username for downloading game files. | `STEAM_USERNAME` | | | `--steam_password STEAM_PASSWORD` | Steam password for downloading game files. | `STEAM_PASSWORD` | | | `--manifest_id MANIFEST_ID` | Manifest ID to download. Defaults to `latest`. Browse manifests: [SteamDB Depot 1422456](https://steamdb.info/depot/1422456/manifests/) | `MANIFEST_ID` | | **Bot Actions** | `-i, --import_files` | Import game and localization files using DepotDownloader. | `IMPORT_FILES` | | | `-d, --decompile` | Decompile Deadlock game files. | `DECOMPILE` | | | `-p, --parse` | Parse decompiled files into JSON and CSV. | `PARSE` | -| | `-c, --changelogs` | Fetch and parse both forum and local changelogs. | `CHANGELOGS` | +| | `-c, --changelogs` | Fetch and parse changelogs from the Steam Web API and local files. | `CHANGELOGS` | | | `-u, --wiki_upload` | Upload parsed data to the Wiki. | `WIKI_UPLOAD` | | | `--dry_run` | Run wiki upload in dry-run mode (no actual upload). | `DRY_RUN` | | | `--parse_map` | Parse map data. | `PARSE_MAP` | diff --git a/src/utils/parameters.py b/src/utils/parameters.py index e5c4d5b5..fd0417a7 100644 --- a/src/utils/parameters.py +++ b/src/utils/parameters.py @@ -122,7 +122,7 @@ def arg_group_action(parser): '-c', '--changelogs', action='store_true', - help='Fetch/parse forum and local changelogs. (also set with CHANGELOGS environment variable)', + help='Fetch/parse changelogs from the Steam Web API and local files. (also set with CHANGELOGS environment variable)', default=is_truthy(os.getenv('CHANGELOGS', False)), ) group_actions.add_argument(