Steam installation

Steam installation — Information about the Steam installation

Functions

Properties

gchar * bin32-path Read / Write / Construct Only
gchar * data-path Read / Write / Construct Only
gchar * install-path Read / Write / Construct Only
SrtSteamIssues issues Read / Write / Construct Only
gchar * steamscript-path Read / Write / Construct Only
gchar * steamscript-version Read / Write / Construct Only

Types and Values

Object Hierarchy

    GFlags
    ╰── SrtSteamIssues
    GObject
    ╰── SrtSteam

Includes

#include <steam-runtime-tools/steam-runtime-tools.h>

Description

SrtSteamIssues represents problems encountered with the Steam installation.

Functions

srt_steam_get_issues ()

SrtSteamIssues
srt_steam_get_issues (SrtSteam *self);

Return the problems found in self .

Parameters

self

The SrtSteam object

 

Returns

A bitfield containing problems, or SRT_STEAM_ISSUES_NONE if no problems were found


srt_steam_get_install_path ()

const char *
srt_steam_get_install_path (SrtSteam *self);

Parameters

self

The SrtSteam object

 

Returns

The absolute path to the Steam installation, which is valid as long as self is not destroyed.

[nullable][type filename]


srt_steam_get_data_path ()

const char *
srt_steam_get_data_path (SrtSteam *self);

Used to return the absolute path to the Steam data directory, which is usually the same as srt_steam_get_install_path, but may be different while testing a new Steam release.

Parameters

self

The SrtSteam object

 

Returns

The absolute path to the Steam data directory, which is valid as long as self is not destroyed.

[nullable][type filename]


srt_steam_get_bin32_path ()

const char *
srt_steam_get_bin32_path (SrtSteam *self);

Parameters

self

The SrtSteam object

 

Returns

The absolute path to ubuntu12_32, which is valid as long as self is not destroyed.

[nullable][type filename]


srt_steam_get_steamscript_path ()

const char *
srt_steam_get_steamscript_path (SrtSteam *self);

Return the absolute path to the script used to launch Steam, if known. If the application using this library was not run as a child process of the Steam client, then this will usually be NULL.

This will usually be /usr/bin/steam for the packaged Steam launcher released by Valve, /app/bin/steam for the Flatpak app, or either /usr/bin/steam or /usr/games/steam for third-party packaged versions of the Steam client.

Parameters

self

The SrtSteam object

 

Returns

A filename valid as long as self is not destroyed, or NULL.

[type filename][nullable]


srt_steam_get_steamscript_version ()

const char *
srt_steam_get_steamscript_version (SrtSteam *self);

Return the version of the script used to launch Steam, if known. If the application using this library was not run as a child process of the Steam client, then this will usually be NULL.

Typical values look like 1.0.0.66 for the packaged Steam launcher released by Valve, 1.0.0.66-2/Debian for recent Debian packages, or NULL for older Debian/Ubuntu packages. Future Ubuntu packages might produce a string like 1.0.0.66-2ubuntu1/Ubuntu.

Parameters

self

The SrtSteam object

 

Returns

A filename valid as long as self is not destroyed, or NULL.

[type filename][nullable]

Types and Values

SRT_STEAM_ISSUES_INTERNAL_ERROR

#define SRT_STEAM_ISSUES_INTERNAL_ERROR SRT_STEAM_ISSUES_UNKNOWN

enum SrtSteamIssues

A bitfield with flags representing problems with the Steam installation, or SRT_STEAM_ISSUES_NONE (which is numerically zero) if no problems were detected.

In general, more bits set means more problems.

Members

SRT_STEAM_ISSUES_UNKNOWN

A generic internal error occurred while trying to detect the status of the Steam installation, or, while reading a report, either an unknown issue flag was encountered or the Steam issues field was missing

 

SRT_STEAM_ISSUES_CANNOT_FIND

Unable to find the Steam installation, either via its canonical symlink ~/.steam/root or various fallback methods. See srt_system_info_dup_steam_installation_path().

 

SRT_STEAM_ISSUES_DOT_STEAM_STEAM_NOT_SYMLINK

~/.steam/steam is not a symbolic link to Steam data, which for example can happen if Steam was installed on a system with <https://bugs.debian.org/916303>. See srt_system_info_dup_steam_data_path().

 

SRT_STEAM_ISSUES_CANNOT_FIND_DATA

Unable to find the Steam data, either via its canonical symlink ~/.steam/steam or various fallback methods. Steam is unlikely to work in this situation. See srt_system_info_dup_steam_data_path().

 

SRT_STEAM_ISSUES_DOT_STEAM_STEAM_NOT_DIRECTORY

~/.steam/steam is neither a directory nor a symbolic link to a directory. Steam is unlikely to work in this situation. See srt_system_info_dup_steam_data_path().

 

SRT_STEAM_ISSUES_DOT_STEAM_ROOT_NOT_SYMLINK

~/.steam/root is not a symbolic link to the Steam installation. See srt_system_info_dup_steam_installation_path().

 

SRT_STEAM_ISSUES_DOT_STEAM_ROOT_NOT_DIRECTORY

~/.steam/root is neither a directory nor a symbolic link to a directory. Steam is unlikely to work in this situation. See srt_system_info_dup_steam_installation_path().

 

SRT_STEAM_ISSUES_STEAMSCRIPT_NOT_IN_ENVIRONMENT

The environment STEAMSCRIPT is not set. Probably it's safe to be considered a minor issue.

 

SRT_STEAM_ISSUES_MISSING_STEAM_URI_HANDLER

There isn't a default desktop application that can handle steam: URIs.

 

SRT_STEAM_ISSUES_UNEXPECTED_STEAM_URI_HANDLER

The default Steam URI handler executable is either not what we expected or is different from the one STEAMSCRIPT points to.

 

SRT_STEAM_ISSUES_UNEXPECTED_STEAM_DESKTOP_ID

The default Steam desktop application ID is not what we expected.

 

SRT_STEAM_ISSUES_UNEXPECTED_STEAM_COMPAT_CLIENT_INSTALL_PATH

If the environment STEAM_COMPAT_CLIENT_INSTALL_PATH is set, its realpath() is not the equivalent of ~/.steam/root.

 

SRT_STEAM_ISSUES_NONE

There are no problems

 

Property Details

The “bin32-path” property

  “bin32-path”               gchar *

Absolute path to `ubuntu12_32`.

Flags: Read / Write / Construct Only

Default value: NULL


The “data-path” property

  “data-path”                gchar *

Absolute path to the Steam data directory, which is usually the same as install-path, but may be different while testing a new Steam release.

Flags: Read / Write / Construct Only

Default value: NULL


The “install-path” property

  “install-path”             gchar *

Absolute path to the Steam installation.

Flags: Read / Write / Construct Only

Default value: NULL


The “issues” property

  “issues”                   SrtSteamIssues

Problems with the steam installation.

Flags: Read / Write / Construct Only


The “steamscript-path” property

  “steamscript-path”         gchar *

Absolute path to the bootstrapper script used to launch Steam.

Flags: Read / Write / Construct Only

Default value: NULL


The “steamscript-version” property

  “steamscript-version”      gchar *

Version of the bootstrapper script used to launch Steam.

Flags: Read / Write / Construct Only

Default value: NULL