forked from Chachigo/FamilyBot
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconfig-template.yml
More file actions
71 lines (64 loc) · 3.79 KB
/
config-template.yml
File metadata and controls
71 lines (64 loc) · 3.79 KB
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# FamilyBot/config-template.yml
# --- Discord Bot Configuration ---
discord:
api_key: "" # REQUIRED: Your Discord Bot Token. Get this from discord.com/developers/applications -> Bot -> Reset Token.
admin_id: 00000000000000000 # REQUIRED: Your Discord User ID (SteamID64) to receive admin DMs for errors/notifications.
# --- Free Games Plugin Configuration (Epic, Steam, GOG, Reddit, etc.) ---
free_epicgames:
channel_id: 00000000000000000 # REQUIRED: Discord Channel ID where free game announcements will be sent. This channel will now also include free game announcements from Reddit (e.g., Steam, GOG, Itch.io).
# --- Steam Family Plugin Configuration ---
steam_family:
family_id: 000000 # REQUIRED: Your Steam Family Group ID. Get this from steamapi.xpaw.me after getting your Steamworks API Key.
channel_id:
new_game: 00000000000000000 # REQUIRED: Discord Channel ID for new Steam Family game notifications.
wishlist: 00000000000000000 # REQUIRED: Discord Channel ID for shared wishlist updates.
user_id:
# REQUIRED: Map Steam User IDs (SteamID64) to friendly names for your family members.
# The SteamID64 must be a string (enclosed in quotes).
# You can add as many entries as needed.
#
# Two formats are supported:
#
# 1. Simple format (friendly name only):
# "76561198000000001": "User1Name"
#
# 2. Extended format (with optional discord_id for per-user commands like !deals):
# "76561198000000002":
# name: "User2Name"
# discord_id: 123456789012345678
#
# The discord_id field is optional but enables commands like !deals to work
# for config-driven members. To find a Discord user's ID, enable Developer Mode
# in Discord settings, then right-click the user and select "Copy User ID".
#
# Examples:
"00000000000000001": "User1Name"
"00000000000000002":
name: "User2Name"
# discord_id: 123456789012345678 # Optional: uncomment and add Discord ID
steamworks_api_key: "" # REQUIRED: Your Steamworks Web API Key. Get this from steamcommunity.com/dev/apikey.
# Used for GetOwnedGames, GetWishlist, GetSharedLibraryApps.
itad_api_key: "" # REQUIRED: IsThereAnyDeal.com API Key. Get this from isthereanydeal.com/apps/my/.
websocket_server_ip: "127.0.0.1" # OPTIONAL: IP address for the bot's internal WebSocket server.
# Use "127.0.0.1" for local development. Change if deploying to a different machine.
# --- Cache TTL Configuration (Hours) ---
cache_ttl_hours:
family_library: 1 # Family shared library cache (default: 1 hour)
wishlist: 2 # Wishlist cache (default: 2 hours)
game_details: 168 # Game details cache including current prices (default: 168 hours / 1 week)
itad_prices: 336 # ITAD historical low prices cache (default: 336 hours / 14 days)
# Note: Historical low prices rarely go up, so longer TTL is safe.
# --- Token Sender Configuration ---
token_sender:
token_save_path: "tokens" # Directory where Steam tokens are saved
browser_profile_path: "FamilyBotBrowserProfile" # Browser session for token extraction
update_buffer_hours: 24 # Hours before token expiry to trigger a refresh
# --- Help Message Plugin Configuration ---
help_message:
channel_id: 00000000000000000 # REQUIRED: Discord Channel ID where the bot's help message will be posted/updated.
# --- Web UI Configuration ---
web_ui:
enabled: true # OPTIONAL: Enable/disable the web UI (default: true)
host: "127.0.0.1" # OPTIONAL: Host to bind the web server to (default: 127.0.0.1)
port: 8080 # OPTIONAL: Port for the web server (default: 8080)
default_theme: "default" # OPTIONAL: Default Bootswatch theme (default, darkly, flatly, etc.)