diff options
| author | Dmitrii Morozov <snoopdesigns@gmail.com> | 2024-06-22 01:38:44 +0200 |
|---|---|---|
| committer | Dmitrii Morozov <snoopdesigns@gmail.com> | 2024-06-22 01:38:44 +0200 |
| commit | 428c088eeff02b2e878d9e3bac32772e843d74d9 (patch) | |
| tree | 609ffe2e7ce8bc5341402753a2a83eb5da24f3f8 | |
| parent | e30cf0345f0e2983b1c9324285dafd4724c0583f (diff) | |
Updates README
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
@@ -1,5 +1,11 @@ # 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: @@ -15,3 +21,18 @@ 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 |