misiektoja/lol_monitor
GitHub: misiektoja/lol_monitor
Stars: 20 | Forks: 2
# lol_monitor
-r "your_riot_api_key"
Or if you installed [manually](#manual-installation):
python3 lol_monitor.py -r "your_riot_api_key"
To get the list of all supported command-line arguments / flags:
lol_monitor --help
## Configuration
### Configuration File
Most settings can be configured via command-line arguments.
If you want to have it stored persistently, generate a default config template and save it to a file named `lol_monitor.conf`:
lol_monitor --generate-config > lol_monitor.conf
Edit the `lol_monitor.conf` file and change any desired configuration options (detailed comments are provided for each).
### Riot API Key
Get the development Riot API key valid for 24 hours here: [https://developer.riotgames.com](https://developer.riotgames.com)
It is recommended to apply for persistent personal or production Riot API key here: [https://developer.riotgames.com/app-type](https://developer.riotgames.com/app-type)
It takes few days to get the approval.
Provide the `RIOT_API_KEY` secret using one of the following methods:
- Pass it at runtime with `-r` / `--riot-api-key`
- Set it as an [environment variable](#storing-secrets) (e.g. `export RIOT_API_KEY=...`)
- Add it to [.env file](#storing-secrets) (`RIOT_API_KEY=...`) for persistent use
Fallback:
- Hard-code it in the code or config file
If you store the `RIOT_API_KEY` in a dotenv file you can update its value and send a `SIGHUP` signal to the process to reload the file with the new API key without restarting the tool. More info in [Storing Secrets](#storing-secrets) and [Signal Controls (macOS/Linux/Unix)](#signal-controls-macoslinuxunix).
### SMTP Settings
If you want to use email notifications functionality, configure SMTP settings in the `lol_monitor.conf` file.
Verify your SMTP settings by using `--send-test-email` flag (the tool will try to send a test email notification):
lol_monitor --send-test-email
### Storing Secrets
It is recommended to store secrets like `RIOT_API_KEY` or `SMTP_PASSWORD` as either an environment variable or in a dotenv file.
Set environment variables using `export` on **Linux/Unix/macOS/WSL** systems:
export RIOT_API_KEY="your_riot_api_key"
export SMTP_PASSWORD="your_smtp_password"
On **Windows Command Prompt** use `set` instead of `export` and on **Windows PowerShell** use `$env`.
Alternatively store them persistently in a dotenv file (recommended):
RIOT_API_KEY="your_riot_api_key"
SMTP_PASSWORD="your_smtp_password"
By default the tool will auto-search for dotenv file named `.env` in current directory and then upward from it.
You can specify a custom file with `DOTENV_FILE` or `--env-file` flag:
lol_monitor --env-file /path/.env-lol_monitor
You can also disable `.env` auto-search with `DOTENV_FILE = "none"` or `--env-file none`:
lol_monitor --env-file none
As a fallback, you can also store secrets in the configuration file or source code.
## Usage
### Monitoring Mode
To monitor specific user activity, just type player's LoL Riot ID & region as command-line arguments (`riot_id_name#tag` and `region` in the example below):
lol_monitor
If you have not set`RIOT_API_KEY` secret, you can use `-r` flag:
lol_monitor -r "your_riot_api_key"
LoL Riot ID consists of Riot ID game name (`riot_id_name` in the example above) and tag line (`#tag`).
For the `region` you need to use the short form of it. You can find the list below:
| Region short form | Description |
| ----------- | ----------- |
| eun1 | Europe Nordic & East (EUNE) |
| euw1 | Europe West (EUW) |
| tr1 | Turkey (TR1) |
| ru | Russia |
| na1 | North America (NA) - now the sole NA endpoint |
| br1 | Brazil (BR) |
| la1 | Latin America North (LAN) |
| la2 | Latin America South (LAS) |
| jp1 | Japan (JP) |
| kr | Korea (KR) |
| sg2 | Southeast Asia (SEA) - Singapore, Malaysia, Indonesia (+ Thailand & Philippines since Jan 9, 2025) |
| tw2 | Taiwan, Hong Kong & Macao (TW/HK/MO) |
| vn2 | Vietnam (VN) |
| oc1 | Oceania (OC) |
By default, the tool looks for a configuration file named `lol_monitor.conf` in:
- current directory
- home directory (`~`)
- script directory
If you generated a configuration file as described in [Configuration](#configuration), but saved it under a different name or in a different directory, you can specify its location using the `--config-file` flag:
lol_monitor --config-file /path/lol_monitor_new.conf
The tool runs until interrupted (`Ctrl+C`). Use `tmux` or `screen` for persistence.
You can monitor multiple LoL players by running multiple instances of the script.
The tool automatically saves its output to `lol_monitor_.log` file. It can be changed in the settings via `LOL_LOGFILE` configuration option or disabled completely via `DISABLE_LOGGING` / `-d` flag.
### Listing Mode
There is also another mode of the tool which prints and/or saves the recent matches for the user (`-l` flag). You can also add `-n` to define how many recent matches you want to display/save; by default, it shows the last 2 matches:
lol_monitor -l -n 25
You can also define the range of matches to display/save by specifying the minimal match to display (`-m` flag). So for example, to display recent matches in the range of 20-50:
lol_monitor -l -m 20 -n 50
If you specify the `-b` flag (with a CSV file name) together with the `-l` flag, it will not only display the recent matches, but also save them to the specified CSV file. For example, to display and save recent matches in the range of 5-10 for the user:
lol_monitor -l -m 5 -n 10 -b lol_games_riot_id_name.csv
### Email Notifications
To enable email notifications when user's playing status changes:
- set `STATUS_NOTIFICATION` to `True`
- or use the `-s` flag
lol_monitor -s
To disable sending an email on errors (enabled by default):
- set `ERROR_NOTIFICATION` to `False`
- or use the `-e` flag
lol_monitor -e
Make sure you defined your SMTP settings earlier (see [SMTP settings](#smtp-settings)).
Email notifications are sent in both plain text and HTML formats for better readability. The HTML format includes enhanced formatting with bold text for important information and properly structured match details.
Example email:
-b lol_games_riot_id_name.csv
The file will be automatically created if it does not exist.
The CSV file includes the following columns:
- `Match Start`, `Match Stop`, `Duration`
- `Game Mode` - The game mode (e.g., "CLASSIC", "ARAM", "URF")
- `Victory` - Win or loss
- `Kills`, `Deaths`, `Assists`
- `Champion` - Champion name
- `Level` - Champion level achieved
- `Role` - Player role (e.g., "DUO_CARRY", "JUNGLE")
- `Lane` - Lane played (e.g., "TOP", "MIDDLE", "BOTTOM")
- `Team 1`, `Team 2` - Team member lists
If you have CSV files from older versions (v1.7.2 or earlier) that use the old format, you can convert them using the [CSV format conversion tool](#utility-tools).
### Check Intervals
If you want to customize polling intervals, use `-k` and `-c` flags (or corresponding configuration options):
lol_monitor -k 60 -c 120
* `LOL_ACTIVE_CHECK_INTERVAL`, `-k`: check interval when the user is in a game (seconds)
* `LOL_CHECK_INTERVAL`, `-c`: check interval when the user is NOT in a game (seconds)
### Signal Controls (macOS/Linux/Unix)
The tool has several signal handlers implemented which allow to change behavior of the tool without a need to restart it with new configuration options / flags.
List of supported signals:
| Signal | Description |
| ----------- | ----------- |
| USR1 | Toggle email notifications when user's playing status changes (-s) |
| TRAP | Increase the check timer for player activity when user is in game (by 30 seconds) |
| ABRT | Decrease check timer for player activity when user is in game (by 30 seconds) |
| HUP | Reload secrets from .env file |
Send signals with `kill` or `pkill`, e.g.:
pkill -USR1 -f "lol_monitor "
As Windows supports limited number of signals, this functionality is available only on Linux/Unix/macOS.
### Coloring Log Output with GRC
You can use [GRC](https://github.com/garabik/grc) to color logs.
Add to your GRC config (`~/.grc/grc.conf`):
# monitoring log file
.*_monitor_.*\.log
conf.monitor_logs
Example:
grc tail -F -n 100 lol_monitor_.log
### Utility Tools
The project includes utility scripts in the `tools/` directory for working with CSV match history files:
#### CSV Format Converter
The `lol_convert_csv_format.py` script converts CSV files from the old format (used by lol_monitor <=v1.7.2) to the new format (used by >=v1.8).
**Old format columns:**
`Match Start`, `Match Stop`, `Duration`, `Victory`, `Kills`, `Deaths`, `Assists`, `Champion`, `Team 1`, `Team 2`
**New format columns:**
`Match Start`, `Match Stop`, `Duration`, `Game Mode`, `Victory`, `Kills`, `Deaths`, `Assists`, `Champion`, `Level`, `Role`, `Lane`, `Team 1`, `Team 2`
**Usage:**
python3 tools/lol_convert_csv_format.py input.csv [-o output.csv]
If `-o` is not specified, the input file will be overwritten with the converted format. Missing values are filled with "N/A".
#### Match History Comparison Tool
The `lol_compare_csvs.py` script compares two League of Legends match history CSV files and determines whether they likely belong to the same player. It analyzes multiple features including:
- Champion pool similarity
- KDA profile (mean and standard deviation)
- Win rate similarity
- Average match duration
- Time-of-day playing patterns
- Teammate overlap
- Role and lane preferences
- Average champion level
- Game mode preferences
- Temporal overlap detection
**Usage:**
python3 tools/lol_compare_csvs.py file1.csv file2.csv [--limit N] [--json] [--pretty] [--no-overlap-check] [--max-overlaps N|all]
**Options:**
- `--limit N`: Limit number of matches analyzed from the top of each file
- `--json`: Output results in JSON format
- `--pretty`: Pretty-print JSON output
- `--no-overlap-check`: Skip temporal overlap analysis (faster, but less comprehensive)
- `--max-overlaps N|all`: Maximum number of temporal overlaps to display (default: 5, use 'all' to show all)
**Requirements:** `pandas` (install with `pip install pandas`)
The script outputs a similarity score (0-100) with a verdict indicating the likelihood that both CSV files represent the same player. Use `--json` for programmatic output or `--pretty` for formatted JSON.
## Change Log
See [RELEASE_NOTES.md](https://github.com/misiektoja/lol_monitor/blob/main/RELEASE_NOTES.md) for details.
## License
Licensed under GPLv3. See [LICENSE](https://github.com/misiektoja/lol_monitor/blob/main/LICENSE).
