DOCSEARCHbyAlgolia
Submit Docs

SteamworksPy

repository·master·Indexed 42 days ago

https://github.com/philippj/steamworkspy

A Python module providing access to the Steamworks API for integrating Steam features such as achievements, stats, and workshop functionality into Python-based games. Requires the Steamworks SDK and a running Steam client to function.

Tokens
603
Snippets
0
Records
6
Agent score
5%

What's inside SteamworksPy

  1. Important usage notes for SteamworksPy

    master

    When using SteamworksPy, keep the following constraints in mind:

    • Steamworks Account: Advanced functions such as setting achievements or stats require a Steamworks account with a valid AppID.
    • Steam Overlay: The overlay only functions if the game uses OpenGL or Direct3D (D3D) and is launched directly from Steam. (Note: SteamRestart functionality is not yet implemented).
    • Python Installation: Do not use the version of Python installed via the Microsoft App Store. Use the official installer from python.org.

  2. Requirements for SteamworksPy

    master

    To use SteamworksPy, the following files must be present in your project's working directory:

    1. steam_appid.txt: A text file containing your game's AppID (or any valid AppID for which the account holds a license).
    2. steam_api library: The platform-specific binary (.dll for Windows, .so for Linux, .darwin for macOS) and the corresponding steam_api.lib.
    3. SteamworksPy library: The platform-specific binary (.dll, .so, or .darwin).

    Critical Runtime Requirement: The Steam client must be running and logged in for the library to function. If the client is not running or logged in, the library will encounter exceptions.

  3. Prerequisites for building SteamworksPy

    master

    To build the SteamworksPy libraries, you must have the Steamworks SDK source files. These files are only available to Steamworks account holders.

    1. Register for a free Steamworks account at https://partner.steamgames.com.
    2. Download the SDK (e.g., v1.47) from the Steamworks partner portal.
    3. Unpack the archive and place the files in the specific directory structure required by the repository.

  4. Configure Steamworks SDK directory structure

    master

    After downloading and unpacking the Steamworks SDK, you must move the files into the SteamworksPy/library directory as follows:

    • Move the contents of /sdk/public/steam to SteamworksPy/library/sdk/steam
    • Move the contents of /sdk/redistributable_bin/%your_os% to SteamworksPy/library (where %your_os% corresponds to your specific operating system).