Skip to content

Commit d39ec36

Browse files
authored
Update README.md
1 parent 7854a48 commit d39ec36

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,23 @@ activate the autostart with the following command
3232
systemctl enable DMN
3333
```
3434

35-
## Usage
35+
## Program usage
36+
37+
The program has a `Settings.json` file which contains all needed settings to change. In the following table are the options described:
38+
39+
| Option | Type | Description |
40+
|---------------------|---------------|--------------------------------------------------------------------------------|
41+
| SteamApiKey | string | The Steam Api Key you can get from https://steamcommunity.com/dev/apikey |
42+
| AutomaticRefresh | true \| false | true if the script should check automatically the mods (default: true) |
43+
| AutomaticRefreshMin | int | The time in minutes for the timer to check the mods (default: 1) |
44+
| DiscordWebHook | string | The Discord Webhook link to the text channel |
45+
| SteamCollection | true \| false | If you want to check a steam collection set this value to true (default: true) |
46+
| SteamCollectionId | int | The id of the steam collectionn |
47+
| SteamModIds | Array | If SteamCollection is false you can add here your mod ids |
48+
49+
**Be careful by changing the `SavedMods.json`. This file is a temp file for the program to save which mods are posted and when the last change was. If you want to reset the bot don´t delete this file or the content of the file. This will be a critical error! If you want to reset this file just insert `[]`**
50+
51+
## Service usage
3652

3753
Start programme manually
3854
```bash

0 commit comments

Comments
 (0)