Steam Integration for Unfolded Circle Remote 2/3

Display your currently playing Steam game and online friends information directly on your Unfolded Circle Remote 2/3 with real-time updates and intelligent caching.

Features

This integration provides real-time Steam status monitoring through the Steam Web API, delivering seamless integration with your Unfolded Circle Remote for comprehensive gaming status tracking.

---

❤️ Support Development ❤️

If you find this integration useful, consider supporting development:

Your support helps maintain this integration. Thank you! ❤️

🎮 Currently Playing Game Display

• Game Title - Currently playing game name
• Steam Artwork - Official game cover art
• Real-time Detection - 30-second refresh intervals
• Playing Status - Active game indicator
• Manual Refresh - Press ON button to update

👥 Online Friends List

• Friends Count - Number of friends currently online
• Real-time Updates - 30-second refresh intervals
• Privacy Friendly - Respects Steam profile settings
• Manual Refresh - Press ON button to update

⚡ Performance & Caching

Smart Error Recovery

• Handles Steam Server Issues - Uses cached data during API outages
• Stable Display - No flickering during temporary errors
• Graceful Degradation - Falls back to last known state

Artwork Caching

• Game Images Cached - Faster loading for repeated views
• High-Resolution Logo - Official Steam SVG branding
• Reduced API Calls - Optimized network usage

API Optimization

• Intelligent Throttling - Respects Steam's 1 request/second limit
• Battery Efficient - Optimized polling intervals
• Reduced Network Usage - Smart caching reduces requests

API Requirements

• Protocol: Steam Web API
• API Key: Required from Steam developer portal
• Steam ID: 64-bit Steam ID (17 digits)
• Privacy Settings: Public or Friends Only recommended
• Rate Limits: 1 request per second maximum

Network Requirements

• Internet Access - Integration requires internet connection
• HTTPS Protocol - Steam Web API (HTTPS)
• Firewall - Must allow HTTPS traffic
• Profile Privacy - Public or Friends Only for full features

Installation

Option 1: Remote Web Interface (Recommended)

1. Navigate to the Releases page
2. Download the latest uc-intg-steam-<version>-aarch64.tar.gz file
3. Open your remote's web interface (http://your-remote-ip)
4. Go to Settings → Integrations → Add Integration
5. Click Upload and select the downloaded .tar.gz file

Option 2: Docker (Advanced Users)

The integration is available as a pre-built Docker image from Docker Hub:

Image: mase1981/uc-intg-steam:latest

Docker Compose:

services:
  uc-intg-steam:
    image: mase1981/uc-intg-steam:latest
    container_name: uc-intg-steam
    network_mode: host
    volumes:
      - </local/path>:/config
    environment:
      - UC_CONFIG_HOME=/config
      - UC_INTEGRATION_HTTP_PORT=9090
      - UC_INTEGRATION_INTERFACE=0.0.0.0
      - PYTHONPATH=/app
    restart: unless-stopped

Docker Run:

docker run -d --name uc-intg-steam --restart unless-stopped --network host -v steam-config:/config -e UC_CONFIG_HOME=/config -e UC_INTEGRATION_INTERFACE=0.0.0.0 -e UC_INTEGRATION_HTTP_PORT=9090 -e PYTHONPATH=/app mase1981/uc-intg-steam:latest

Configuration

Step 1: Get Your Steam Credentials

IMPORTANT: Before installation, you must obtain your Steam Web API Key and Steam ID.

Get Steam Web API Key:

1. Go to Steam Web API Key
2. Sign in with your Steam account
3. Enter any domain name (e.g., localhost or example.com)
4. Click "Register"
5. Copy your Steam Web API Key (keep this secure!)

Find Your Steam ID:

Method 1: Steam ID Finder (Easiest)

1. Go to SteamID.io
2. Enter your Steam profile URL or username
3. Copy your steamID64 (17-digit number starting with 765...)

Method 2: Steam Client

1. Open Steam → View → Settings → Interface
2. Check "Display Steam URL address when available"
3. Go to your Steam profile
4. Your Steam ID is the number in the profile URL

Profile Privacy Settings:

For the friends list feature to work:

1. Go to Steam → Profile → Edit Profile → Privacy Settings
2. Set "Game details" to Public or Friends Only
3. Set "Friends list" to Public or Friends Only
4. Click "Save"

Note: Private profiles will show game information but no friends data.

Step 2: Setup Integration

1. After installation, go to Settings → Integrations
2. The Steam integration should appear in Available Integrations
3. Click "Configure" to begin setup:

Configuration:

• Steam Web API Key: Enter your API key from Steam developer portal
• Steam ID (64-bit): Enter your 17-digit Steam ID
• Click Complete Setup

Connection Test:

• Integration verifies Steam API credentials
• Validates Steam profile accessibility
• Setup fails if credentials are invalid

4. Integration will create entities:
   • Steam - Now Playing: Media Player entity showing current game
   • Steam - Friends: Media Player entity showing online friends count

Using the Integration

Currently Playing Entity

The media player entity provides real-time game tracking:

• Game Information: Title and artwork when playing
• Idle State: Shows "No game detected" when not playing
• Automatic Updates: 30-second refresh intervals
• Manual Refresh: Press ON button to force update
• High-Quality Art: Official Steam game cover images

Friends Entity

The friends entity provides social status:

• Online Count: Number of friends currently online
• Automatic Updates: 30-second refresh intervals
• Manual Refresh: Press ON button to force update
• Privacy Aware: Respects Steam profile settings
• Official Branding: High-quality Steam logo

Credits

• Developer: Meir Miyara
• Steam: Valve Corporation gaming platform
• Unfolded Circle: Remote 2/3 integration framework (ucapi)
• Protocol: Steam Web API
• Community: Testing and feedback from UC community

License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) - see LICENSE file for details.

Legal Disclaimers

Third-Party Service Integration

This integration is an independent, unofficial project that interfaces with Steam's publicly available Web API. This project is:

• NOT sponsored, endorsed, or affiliated with Valve Corporation or Steam
• NOT an official Steam product or service
• Developed independently using Steam's public Web API documentation

Intellectual Property

• Steam is a trademark of Valve Corporation
• All Steam-related trademarks, service marks, and logos are the property of Valve Corporation
• This project claims no ownership of Steam's intellectual property
• Game artwork and information accessed through the API remain the property of their respective copyright holders

API Usage and Terms

• Users must comply with Steam's Web API Terms of Use
• This integration requires users to obtain their own Steam Web API Key
• Usage is subject to Steam's rate limiting and API policies
• Users are responsible for their own API key security

User Responsibilities

By using this integration, you acknowledge that:

• You are responsible for obtaining and securing your own Steam Web API key
• You are responsible for complying with Steam's terms of service
• You use this software at your own risk
• The developer is not liable for any account restrictions or consequences
• You must respect other users' privacy settings

Data and Privacy

• This integration does not store, collect, or transmit personal data beyond what is necessary for API functionality
• Steam API keys are stored locally on your device
• No user data is shared with third parties
• Configuration remains on your local device
• Users should review Steam's privacy policy for information about data handled by Steam's services

For questions about Steam's services, terms, or policies, please contact Valve Corporation directly.

Support & Community

• GitHub Issues: Report bugs and request features
• UC Community Forum: General discussion and support
• Developer: Meir Miyara
• Steam Support: Official Steam Support

---

Made with ❤️ for the Unfolded Circle and Steam Communities

Thank You: Meir Miyara