From ba5197d4437854ca4c43c10566feb31d382f9b0b Mon Sep 17 00:00:00 2001 From: Jylpah Date: Wed, 8 Jul 2020 22:36:53 +0300 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++++++++++++------ 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index af2fc83..5d23c5e 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Python scripts to analyze WoT Blitz replays and stats. All the scripts require [ ### Replays * [upload_wotb_replays.py](upload_wotb_replays.py): An asynchronous replay uploader. -* [analyze_wotb_replays.py](analyze_wotb_replays.py): A tool to calculate statistics of a set of replays. Upload the replays first with [upload_wotb_replays.py](upload_wotb_replays.py) and then calculate the statistics. +* [analyze_wotb_replays.py](analyze_wotb_replays.py): A tool to calculate statistics of a set of replays. **Upload the replays first** with [upload_wotb_replays.py](upload_wotb_replays.py) and then calculate the statistics. ### Tank data * [get_tankopedia.py](get_tankopedia.py): Get the lastest tankopedia data from wotinspector.com. The script fetches only a limited set of data. You may edit to your needs. @@ -19,16 +19,42 @@ Python scripts to analyze WoT Blitz replays and stats. All the scripts require [ ### Quick instructions 1. Install [Python 3.8](https://www.python.org/downloads/) on to your computer/laptop -1. Download all the files including the [maps.json](maps.json) and [tanks.json](tanks.json) files. The recommended way to do this is to use [GitHub Dekstop](https://desktop.github.com/) or do _git pull_ -1. Install the required Python modules: motor, aiohttp, aioconsole, aiofiles, aiosqlite, beautifulsoup4, lxml, xmltodict, progress - +2. Install the required Python modules: motor, aiohttp, aioconsole, aiofiles, aiosqlite, beautifulsoup4, lxml, xmltodict, progress ``` # Remember to run the command with a Python interpreter >= 3.7 python -m pip install motor aiohttp aioconsole aiofiles aiosqlite beautifulsoup4 lxml xmltodict progress ``` +3. Download all the files including the [maps.json](maps.json) and [tanks.json](tanks.json) files. A recommened way is to install [GitHub Desktop](https://desktop.github.com/) and clone the repository via _git_. This makes it easy to receive the updates. -4. Upload your replays. Run _python.exe .\upload_wotb_replays.py --help_ (Windows) or _./upload_wotb_replays.py --help_ (Linux) -5. Analyze replays. Run _python.exe .\analyze_wotb_replays.py --help_ (Windows) or _./analyze_wotb_replays.py --help_ (Linux) +4. Upload your replays. +``` +# Windows +# Check the options +python.exe .\upload_wotb_replays.py --help + +# Syntax +python.exe .\upload_wotb_replays.py REPLAY_FILE.wotbreplay + +# example +python.exe .\upload_wotb_replays.py 20200223_0122__jylpah_T-54_grossberg.wotbreplay + +# Linux +./upload_wotb_replays.py --help +``` +5. Analyze replays. +``` +# Windows +python.exe .\analyze_wotb_replays.py --help + +# Syntax +python.exe .\analyze_wotb_replays.py REPLAY_FILE.wotbreplay.json + +# Example +python.exe .\analyze_wotb_replays.py 20200223_0122__jylpah_T-54_grossberg.wotbreplay.json + +# Linux +./analyze_wotb_replays.py --help +``` ### Blitz releases