Update README.md for new version

This commit is contained in:
Rim 2023-12-25 09:11:59 -05:00
parent e1d5abea1b
commit a41ccd0e15
2 changed files with 19 additions and 18 deletions

View File

@ -7,12 +7,16 @@ Get every single statistic Call of Duty <u>***tracks***</u> in one place, under
> To see an example, look in `/examples/` > To see an example, look in `/examples/`
## Table of Contents ## Table of Contents
- [**Features**](#features) - [Features](#features)
- [**Prerequisites**](#prerequisites) - [Prerequisites](#prerequisites)
- [**Installation**](#installation) - [Installation](#installation)
- [**Obtaining your ACT\_SSO\_COOKIE**](#obtaining-your-act_sso_cookie) - [Using the Latest Release **(Easiest)**](#using-the-latest-release-easiest)
- [**Command Line Arguments**](#command-line-arguments) - [Cloning the Repository](#cloning-the-repository)
- [**Sorting**](#sorting) - [Obtaining your ACT\_SSO\_COOKIE](#obtaining-your-act_sso_cookie)
- [Obtaining Your userInfo.json File](#obtaining-your-userinfojson-file)
- [Command Line Arguments](#command-line-arguments)
- [Command Examples](#command-examples)
- [Sorting](#sorting)
## Features ## Features
- Instantly download detailed statistics for any player, including ***Lifetime Statistics***, ***Match Statistics*** and ***season_loot*** - Instantly download detailed statistics for any player, including ***Lifetime Statistics***, ***Match Statistics*** and ***season_loot***
@ -25,18 +29,18 @@ Get every single statistic Call of Duty <u>***tracks***</u> in one place, under
## Prerequisites ## Prerequisites
- Call of Duty Account - Call of Duty Account
- Account API security settings set to open - Account API security settings set to open
- `Python 3.x` *(optional)* - `Python 3.x` *(optional)* (Tested with Python 3.9.13)
- A Web Browser *(Tested with Chromium)* - A Web Browser *(Tested with Chromium)*
- ~~[Curl](https://curl.se/download.html) ***(Installed by default on Windows)***~~ - ~~[Curl](https://curl.se/download.html) ***(Installed by default on Windows)***~~
## Installation ## Installation
#### Using the Latest Release **(EASIEST)** #### Using the Latest Release **(Easiest)**
- Navigate to the latest release and download `get_cod_stats.exe` - Navigate to the latest release and download `get_cod_stats.exe`
- Open a command line of your choise, navigate to the directory using `cd` and follow examples below - Open a command line of your choise, navigate to the directory using `cd` and follow examples below
``` ```
cd "C:\Users\John\Desktop\detailed-cod-tracker" cd "C:\Users\John\Desktop\detailed-cod-tracker"
get_cod_stats.exe [-h] -p PLAYER_NAME [-a] [-sl] [-i] [-m] [-c] [-sm] [-csd] [-cmd] get_cod_stats.exe [-h] [-p PLAYER_NAME] [-a] [-sl] [-id] [-m] [-i] [-f] [-e] [-cp] [-ca] [-s] [-c] [-sm] [-csd] [-cmd] [-cff] [-cef]
``` ```
#### Cloning the Repository #### Cloning the Repository
@ -50,18 +54,15 @@ get_cod_stats.exe [-h] -p PLAYER_NAME [-a] [-sl] [-i] [-m] [-c] [-sm] [-csd] [-c
Cookies --> https://www.callofduty.com/ --> ACT_SSO_COOKIE Cookies --> https://www.callofduty.com/ --> ACT_SSO_COOKIE
- Enter the value when prompted - Enter the value when prompted
## Obtaining your userInfo.json (Develop Branch ONLY) ## Obtaining Your userInfo.json File
- For some reason, Activision broke the userInfo API URL which in turn, broke the API Wrapper's logic to obtain certain user information. Unfortunately, this also means we also cannot use Curl. Follow the steps below if you wish to obtain General Info, friendFeed, eventFeed, Cod Point Balance, Connected Accounts, and Account Settings. - For some reason, Activision broke the userInfo API URL which in turn, broke the API Wrapper's logic to obtain certain user information. Unfortunately, this also means we also cannot use Curl. Follow the steps below if you wish to obtain General Info, friendFeed, eventFeed, Cod Point Balance, Connected Accounts, and Account Settings.
- This feature is only available on the `develop` branch.
1. Clone the repository, `git clone https://github.com/Ahrimdon/detailed-cod-tracker.git && cd detailed-cod-tracker` 1. Clone the repository, `git clone https://github.com/Ahrimdon/detailed-cod-tracker.git && cd detailed-cod-tracker`
2. Run the setup using `python setup.py` 2. Obtain your [*ACT_SSO_COOKIE*](#obtaining-your-act_sso_cookie)
3. Switch to the `develop` branch using `git checkout develop` 3. Go to `https://profile.callofduty.com/cod/userInfo/{ACT_SSO_COOKIE}` and copy the contents into `userInfo.json` in the repo's directory
4. Obtain your [*ACT_SSO_COOKIE*](#obtaining-your-act_sso_cookie) > *Note:* Create the `userInfo.json` file manually
5. Go to `https://profile.callofduty.com/cod/userInfo/{ACT_SSO_COOKIE}` and copy the contents into `userInfo.json` in the repo's directory 4. In the newly created `userInfo.json`, delete "*userInfo(*" and "*);*" at the beginning and end of the file. Alternatively, you can find and replace using the regular expression inside `sanitize_userInfo_regex.txt`
> *Note:* Create the `userInfo.json` file manually 5. Run `get_cod_stats.py` using the `-a` argument (e.g. `python get_cod_stats.py -p Ahrimdon -a`)
6. In the newly created `userInfo.json`, delete "*userInfo(*" and "*);*" at the beginning and end of the file. Alternatively, you can find and replace using the regular expression inside `clean_userInfo_regex.txt`
7. Run `get_cod_stats.py` using the `-a` argument (e.g. `python get_cod_stats.py -p Ahrimdon -a`)
If done correctly, this should return the extra API information. If done correctly, this should return the extra API information.