Steam

Steam is a digital distribution platform developed by Valve Corporation for purchasing and playing video games. Protocol Launcher allows you to generate deep links to interact with Steam client, such as launching games, opening store pages, managing friends, and more.

Usage

There are two ways to use this library:

• On-Demand import from subpaths enables tree-shaking and keeps bundles small.
• Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand

Recommended. Optimized for production.

Full Import

Convenient. Good for quick scripts.

Open Steam

On-Demand

import { open } from 'protocol-launcher/steam'

const url = open()

Open Steam

Open URL

Opens URL in the system's default web browser.

On-Demand

import { openUrl } from 'protocol-launcher/steam'

const url = openUrl({
  url: 'https://store.steampowered.com/',
})

Open URL in Browser

Open Store Page

Opens up the store for an app.

On-Demand

import { store } from 'protocol-launcher/steam'

const url = store({
  id: 730,
})

Open CS:GO Store Page

Launch Game

Runs an application. It will be installed if necessary.

On-Demand

import { launch } from 'protocol-launcher/steam'

const url = launch({
  id: 730,
  args: '-windowed',
})

Launch CS:GO

Install Application

Installs an application.

On-Demand

import { install } from 'protocol-launcher/steam'

const url = install({
  id: 8230,
})

Install Application

Uninstall Application

Deletes the specified app's cache files.

On-Demand

import { uninstall } from 'protocol-launcher/steam'

const url = uninstall({
  id: 8230,
})

Uninstall Application

Validate Local Files

Validates the local files of an app.

On-Demand

import { validate } from 'protocol-launcher/steam'

const url = validate({
  id: 730,
})

Validate CS:GO Files

Friends Actions

Opens Friends window with optional action.

On-Demand

import { friends } from 'protocol-launcher/steam'

// Add a friend
const url = friends({
  action: 'add',
  id: '12345678',
})

Add Friend

On-Demand

import { friends } from 'protocol-launcher/steam'

// Send a message
const url = friends({
  action: 'message',
  id: '12345678',
})

Send Message

On-Demand

import { friends } from 'protocol-launcher/steam'

// Set status to online
const url = friends({
  action: 'status/online',
})

Set Status Online

Open Settings

Opens Steam settings page.

On-Demand

import { settings } from 'protocol-launcher/steam'

const url = settings({
  page: 'downloads',
})

Open Downloads Settings

Open Component

Opens a Steam window/component.

On-Demand

import { openComponent } from 'protocol-launcher/steam'

const url = openComponent({
  component: 'bigpicture',
})

Open Big Picture

On-Demand

import { openComponent } from 'protocol-launcher/steam'

const url = openComponent({
  component: 'console',
})

Open Console

Navigation

Opens a Steam navigation window without making it active.

On-Demand

import { nav } from 'protocol-launcher/steam'

const url = nav({
  component: 'downloads',
})

Navigate to Downloads

On-Demand

import { nav } from 'protocol-launcher/steam'

const url = nav({
  component: 'games/details',
  param: '730',
})

Navigate to Game Details

Connect to Server

Connects the user to the server specified by the IP.

On-Demand

import { connect } from 'protocol-launcher/steam'

const url = connect({
  ip: '192.0.2.1',
  port: 27015,
})

Connect to Server

On-Demand

import { connect } from 'protocol-launcher/steam'

const url = connect({
  ip: '192.0.2.1',
  port: 27015,
  password: 'secret',
})

Connect to Server with Password

Exit Steam

Exits the Steam application.

On-Demand

import { exit } from 'protocol-launcher/steam'

const url = exit()

Exit Steam

App News

Opens up the news page for an app.

On-Demand

import { appNews } from 'protocol-launcher/steam'

const url = appNews({
  id: 730,
})

View CS:GO News

Game Properties

Opens the properties for the specified game.

On-Demand

import { gameProperties } from 'protocol-launcher/steam'

const url = gameProperties({
  id: 730,
})

Open Game Properties

Controller Config

Opens the controller configurator (Steam Input) for the specified game.

On-Demand

import { controllerConfig } from 'protocol-launcher/steam'

const url = controllerConfig({
  id: 730,
})

Configure Controller

Backup

Opens up the Backup Wizard and checks the specified application.

On-Demand

import { backup } from 'protocol-launcher/steam'

const url = backup({
  id: 730,
})

Backup Game

Support

Launches the Steam Support utility.

On-Demand

import { support } from 'protocol-launcher/steam'

const url = support({
  params: '730',
})

Open Support

Named Pages

Opens a special, named web pages in Steam.

On-Demand

import { url } from 'protocol-launcher/steam'

const url = url({
  page: 'Store',
})

Open Store

On-Demand

import { url } from 'protocol-launcher/steam'

const url = url({
  page: 'SteamWorkshop',
})

Open Steam Workshop

On-Demand

import { url } from 'protocol-launcher/steam'

const url = url({
  page: 'StoreAppPage',
  param: '730',
})

Open Store App Page