STFC-Verifier/.env.example at main · ComputerEndProgram/STFC-Verifier · GitHub

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
72
73
74
75
# =============================================================================
# STFC RANK BOT - ALLIANCE RANK MANAGEMENT FOR DISCORD
# =============================================================================
# Copy this file to .env and fill in your values

# ========== DISCORD ==========
DISCORD_TOKEN=your_bot_token_here
GUILD_ID=your_guild_id_here

# ========== STFC SERVER ==========
# The server ID to verify against (e.g., 118, 106, etc.)
STFC_SERVER_ID=your_server_id_here

# ========== ROLES ==========
# Copy these role IDs from Discord (right-click role → Copy Role ID)
MEMBER_ROLE_ID=base_member_role_id_here
COMMODORE_ROLE_ID=commodore_role_id_here
ADMIRAL_ROLE_ID=admiral_role_id_here
ADMIN_ROLE_ID=admin_role_id_here

# ========== CHANNELS ==========
# Copy these channel IDs from Discord (right-click channel → Copy Channel ID)
VERIFY_CHANNEL_ID=verification_channel_id_here
LOG_CHANNEL_ID=log_channel_id_here

# ========== UPDATE SETTINGS ==========
# How often to check for rank changes (in hours)
UPDATE_CHECK_HOURS=24

# Database file path (stores player links for periodic updates)
DB_PATH=stfc_players.db

# ========== ALLIANCE ROLES (Optional) ==========
# Enable automatic alliance role assignment based on alliance tag
# If enabled, the bot will assign a role with the name matching the alliance tag (e.g., "DTB", "SITH")
# For users WITHOUT an alliance tag, the bot will assign a role named "N/A" (if it exists)
# Create Discord roles with names matching your alliances (e.g., "DTB", "SITH", "N/A", etc.)
# Set to 1 to enable, 0 to disable (default: disabled)
ENABLE_ALLIANCE_ROLES=0

# ========== LOGGING ==========
DEBUG=0
# Set DEBUG=1 for verbose logging

# =============================================================================
# ROLE HIERARCHY:
# - Agent, Operative, Premier → MEMBER_ROLE (assigned immediately)
# - Commodore → COMMODORE_ROLE (needs admin confirmation)
# - Admiral → ADMIRAL_ROLE (needs admin confirmation)
# - Alliance Tag → Role with matching tag name (optional, if ENABLE_ALLIANCE_ROLES=1)
#   * Users with alliance tag get role named after their tag (e.g., "DTB", "SITH")
#   * Users WITHOUT alliance tag get role named "N/A"
# =============================================================================
# VERIFICATION FLOW:
# 1. User submits /verify with player URL/ID and screenshot
# 2. Bot fetches player data from stfc.pro/stfc.wtf/stfc.live
# 3. Bot verifies player is on correct STFC_SERVER_ID
# 4. If alliance tag exists: nickname = [TAG] username (e.g., "[DTB] SomePlayer")
#    If NO alliance tag: nickname = username (e.g., "SomePlayerWithoutTag")
# 5. Bot assigns base role immediately
# 6. Bot assigns alliance role (if ENABLE_ALLIANCE_ROLES=1):
#    * Role with alliance tag name, or "N/A" if no alliance
# 7. If Commodore/Admiral, bot posts confirmation request to LOG_CHANNEL_ID
# 8. Admin accepts/rejects via buttons
# 9. Daily updates check for rank changes and request confirmation for ANY change
# =============================================================================
# NOTES:
# - DISCORD_TOKEN: Get from Discord Developer Portal
# - GUILD_ID: Right-click your server in Discord, select "Copy Server ID"
# - All ROLE_IDs and CHANNEL_IDs: Right-click them in Discord, select "Copy ID"
# - Create Discord roles named: "Member", "Commodore", "Admiral", "Admin"
# - Create a text channel for LOG_CHANNEL_ID (e.g., "rank-confirmations")
# - For ENABLE_ALLIANCE_ROLES: Create roles named after alliance tags (e.g., "DTB", "SITH", "N/A")
# - Users without an alliance will NOT be rejected; they can still verify!
# =============================================================================