config.yaml.example

# GitHub Repository Statistics Display Configuration
# Copy this file to config.yaml and update with your settings

# GitHub Personal Access Token
# Required for higher rate limits and accessing private repositories
# Create one at: https://github.com/settings/tokens
# Minimum permissions needed: public_repo (for public repos) or repo (for private repos)
github_token: "your_github_token_here"

# List of repositories to track
# Format: owner/repository-name (one per line)
repositories:
  - "octocat/Hello-World"
  - "owner/repo-name"
  # Add more repositories as needed

# Refresh interval in minutes
# How often to fetch new data from GitHub API
refresh_interval_minutes: 15

# Display configuration
display_type: terminal  # Options: terminal, character_lcd, gui, fullscreen

# Display-specific settings
display_settings:
  # For terminal display:
  width: 80
  height: 4
  
  # For GUI/Fullscreen HDMI display (unified defaults: dark blue theme, Segoe UI):
  # fullscreen: true
  # bg_color: "#0a0e27"           # Background (hex). Default: dark blue
  # text_color: "#ffffff"         # Text color (hex)
  # accent_color: "#00d4ff"       # Accent/highlight (hex). Default: cyan
  # font_family: "Segoe UI"       # Font (fallbacks: Segoe UI, Arial)
  # title_font_size: 64           # Titles
  # body_font_size: 32            # Body text
  # small_font_size: 20           # Small text / eyebrow labels
  # card_border_color: "#2a3050"  # Optional. Card border (hex). Default: derived from palette
  # divider_color: "#1e2440"      # Optional. Divider line (hex). Default: derived from palette
  # show_rotation_indicator: true # Dots showing summary vs repo. Default: true
  # transition_type: "fade"       # "none" or "fade" when rotating views. Default: fade
  
  # For character LCD (I2C mode):
  # mode: i2c
  # i2c_address: 0x27  # Default I2C address for most LCDs
  # i2c_port: 1        # I2C port (usually 1 on Raspberry Pi)
  # width: 20
  # height: 4
  
  # For character LCD (GPIO mode):
  # mode: gpio
  # pin_rs: 15
  # pin_e: 16
  # pins_data: [21, 22, 23, 24]
  # numbering_mode: BCM  # Options: BCM or BOARD
  # width: 20
  # height: 4

# Rotation configuration
rotation_enabled: true  # Enable automatic rotation through repositories
rotation_interval_seconds: 10  # How long to show each repository/summary (in seconds)
show_summary_first: true  # Show summary view first, then cycle through repos

# Cache configuration
cache_enabled: true
cache_duration_minutes: 10  # How long to cache API responses
cache_dir: .cache           # Directory to store cache files

# GitHub Container Registry Packages Configuration (optional)
# List of GitHub packages to track downloads and versions
# Format: owner/package-name or full dict with owner, name, and type
# Package types: container, npm, maven, nuget, rubygems
github_packages:
  # Simple format:
  # - "owner/package-name"
  # Full format:
  # - owner: "owner"
  #   name: "package-name"
  #   type: "container"  # Options: container, npm, maven, nuget, rubygems

# Donations Configuration (optional)
donations:
  enabled: false  # Set to true to enable donation tracking
  
  # PayPal Configuration
  # Requires PayPal API credentials (Client ID and Secret)
  # Get them from: https://developer.paypal.com/
  paypal:
    client_id: ""      # Your PayPal Client ID
    client_secret: ""  # Your PayPal Client Secret
  
  # Buy Me a Coffee Configuration
  # Note: Buy Me a Coffee doesn't have a public API for donation totals
  # This may require manual configuration or web scraping (fragile)
  buymeacoffee:
    username: ""  # Your Buy Me a Coffee username

# Metrics to display (optional - currently all available metrics are shown)
# metrics:
#   - stars
#   - forks
#   - open_issues
#   - last_commit
#   - language
#   - contributors
#   - latest_version
#   - downloads
#   - donations