steamworks.*

Overview

The Steamworks plugin is intended for desktop games uploaded to Steam. It is used to handle achievements, player stats, leaderboards, and to show in-app overlays.

Gotchas

The Steamworks plugin can be used in the Solar2D Simulator, but it has the following limitations/issues:

• On Mac, Steam overlays will not appear unless Solar2D Simulator is launched from the Steam client and a system preference is set. See the Overlay Troubleshooting guide for more details.
• On Windows, overlays will not display correctly when using a device skin. You should simulate with a borderless window instead.
• You must exit the Solar2D Simulator application when testing with a different Steam AppID.
• Exiting the Steam client will automatically terminate the Solar2D Simulator application if you load the Steamworks plugin at least once.

Project Settings

To use this plugin, add an entry into the plugins table of build.settings. When added, the build server will integrate the plugin during the build phase.

settings =
{
    plugins =
    {
        ["plugin.steamworks"] =
        {
            publisherId = "com.coronalabs"
        },
    },
}

You must also add the AppID assigned to your application by Steam into your config.lua file:

application =
{
    steamworks =
    {
        appId = "YOUR_APP_ID"
    },
}

Syntax

local steamworks = require( "plugin.steamworks" )

Functions

Properties

Events

Types