Skip to content

Commit 1e243bd

Browse files
committed
feat: add readme
1 parent e2cdea8 commit 1e243bd

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Factorio <-> Telegram Bridge
2+
3+
This bridge uses RCON to forward messages from Telegram to Factorio and Factorio's console log file to forward messages from Factorio to Telegram
4+
5+
## Usage
6+
To use the program, you need to set some required options/environment variables:
7+
```
8+
Option Env var Description
9+
-t, --telegram-token TELEGRAM_TOKEN Telegram bot token
10+
-c, --telegram-chat-id TELEGRAM_CHAT_ID Telegram chat id
11+
-h, --factorio-rcon-host FACTORIO_RCON_HOST Factorio RCON host
12+
-p, --factorio-rcon-password FACTORIO_RCON_PASSWORD Factorio RCON password
13+
-l, --factorio-log-file FACTORIO_LOG_FILE Factorio console log file
14+
```
15+
16+
### Factorio Friday Facts
17+
18+
When `--fff file_path` option is set, the bridge will check for new FFFs and send them to both chats. The file contains the latest title of the Factorio Friday Facts post in order to send the info about the FFF only once.
19+
20+
```
21+
Option Env var Description
22+
--fff FFF Factorio Friday Facts Cache File. If set, the bridge will check for new FFFs and send them to the chat [env: FFF=]
23+
```

0 commit comments

Comments
 (0)