steamworks.*

Type Library
Revision 2017.3145
Keywords steam, steamworks, achievements, leaderboard
Platforms macOS, Windows

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 Corona Simulator, but it has the following limitations/issues:

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

UserInfo