config.example.yaml

config:
  # Essential
  # Text command prefix
  prefix: "!"
  # Server ID for main UWCS server
  UWCS_discord_id: 123
  # Roles IDs that permit exec commands
  UWCS_exec_role_ids: [1234]
  # Token for Discord API from https://discord.com/developers/applications
  discord_token: discord_token
  # Database URL, can use other providers such as SQLite
  database_connection: "postgresql+psycopg://apollo:apollo@localhost/apollo"
  # Secret key used to encrypt DB
  db_secret_key: secret_key

  # Optional (only needed for a specific function)
  # Channel for welcome messages
  UWCS_welcome_channel_id: 123
  # Role channel mentioned in the welcome message
  UWCS_roles_channel_id: 123
  # Channel for the channel movement checker
  UWCS_exec_spam_channel_id: 1234
  # IRC bridge bot ID
  UWCS_discord_bridge_bot_id: 1337
  # API Key for chatgpt integration
  openai_api_key: openai
  # Whether to include usernames as part of a prompt
  ai_include_names: True
  # Channels that chat isn't chat rate limited on
  ai_chat_channels: [123]
  # Initial priming prompt for chatgpt
  ai_system_prompt: |
    You are Apollo, a Discord Bot in the University of Warwick Computing Society Discord.
  # API key for access to apollo's container runtime
  portainer_api_key: portainer
  # Liege Chancellor User ID
  liege_chancellor_id: 1234
  # Summarise Use Limit
  summarise_limit: 3
  # Summarise Cooldown Period (minutes)
  summarise_cooldown: 10
  # whether to load general.txt and markov chains
  markov_enabled: False

  # Configuration
  # Level of messages logged to file
  log_level: WARNING
  # Whether to log SQL as well
  log_sql: False
  # How long do users have to wait to set karma again
  karma_cooldown: 900
  # Time (sec) between polling for reminders
  reminder_search_interval: 10
  # Time (sec) between polling for channel reordering
  channel_check_interval: 60
  # Time (sec) between polling for announcements
  announcement_search_interval: 60
  # Whether announcements should post via a Webhook to appear like the user
  announcement_impersonate: True
  # URL for Pyromaniac (code execution backend)
  pyromanaic_url: null

  # Unused
  # (not actively used) Role to give to authenticated UWCS members
  UWCS_member_role_id: 2674
  # (not actively used) Key for UWCS API to auth UWCS members
  UWCS_api_token: api_token
  slicer_path: /path/to/prusa-slicer
  printer_file_root: /path/to/print/files