summaryrefslogtreecommitdiff
path: root/README.md
blob: bf4798f16cc9a289606fb29f2d6909e649dc7e8a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Telegram bot with advanced Fortnite integration features

## Prerequesties

* python3
* Telegram bot token (see [official telegram guide](https://core.telegram.org/bots/tutorial#getting-ready), section __Obtain Your Bot Token__)
* You must be logged in with Epic Games account in web browser (required for first start)

## Running

Install all required depedencies using:

```
pip install -r requirements.txt
```

Build and execute using python environment:

```
TELEBOT_BOT_TOKEN=<bot token> python main.py
```

On first run you wil be asked for a Fortnite API token, which can be obtained by accessing [this URL](https://www.epicgames.com/id/api/redirect?clientId=3446cd72694c4a4485d81b77adbb2141&responseType=code). Note: you need to be logged to Epic Games account in browser used to access token.

## Features

 * Notify updates of Fortnite services status, useful in case of maintenance
 * Notify when your friends are playing
 * Get statistics (online and historical)

Note: friends you want to get updates about must be added to bot's Fortnite account as friends, their statistics must be opened to public.

# Available commands

* _/start_ Register your char to recieve Fortnite updates
* _/friends_ Get list of currently registered Fortnite friends
* _/stats_ Get Fortnite statistics
* _/status_ Get Fortnite services status