greenworks

A node.js plugin to integrate with Steamworks. The plugin was developed to enable the Steam release of Greenheart Games' Game Dev Tycoon, a game powered by node-webkit. It has since been used by other projects.

API

For Game Dev Tycoon we've added support for Steam Cloud and Steam Achievements via the following five methods, based on the Steamworks SDK:

• initAPI() (synchronous call) - this one is used when the app starts. This method uses SteamAPI_Init and ISteamUserStats::RequestCurrentStats methods;
• getCloudQuota(complete(total, available), error) - is used to get steam cloud usage. Uses methods from ISteamRemoteStorage;
• saveTextToFile(fileName, content, complete, error) (asynchronous) - saves some textual data locally, but it also gets synced with steam cloud in background;
• readTextFromFile(fileName, content, complete(data), error) (asynchronous) - gets some data, previously saved using saveTextToFile(). Both readTextFromFile and saveTextToFile are using ISteamRemoteStorage;
• activateAchievement(id, complete, error) (asynchronous) - sets a user achievement, using ISteamUserStats.
• isCloudEnabled() (synchronous call) - returns true or false if the Steam cloud for the app is enabled or not
• enableCloud(enable) (synchronous call) - enable or disable the Steam cloud feature for the app

Dependencies

Before building modules you need to download Steamworks SDK (https://partner.steamgames.com/). Note that the steamworks SDK libraries and docs are only usable under license from Valve. If you fork Greenworks, don't commit any of the dependencies from the steamworks SDK to a public place.

Usage

We provide compiled versions of greenworks under releases. To use the binaries you will have to copy them alongside the steam libraries and then load the module via require.

Test

Here is a simple application, which inits steam API.

var greenworks = require('./greenworks-osx');

if (greenworks.initAPI()) {
    console.log('Steam API initalised');
}
else {
	console.log('Error initalising Steam API');
}

Build

If you want to build greenworks yourself, you need first to add redistributable_bin/ (under SDK folder) to PATH (so steam_api.lib is linked while building).

node-gyp configure
node-gyp build

If everything goes fine, it will create a folder deploy/ with node module within (greenworks-X.node, where X depends on your os. E.g. for mac it will be greenworks-osx.node). Now it's possible to use the module from a node.js application. Make sure libsteam_api dynamic library is distributed along with the application.

Troubleshooting

Possible issues while building/running:

* Library not loaded: @loader_path/libsteam_api.dylib (or .dll for windows)

That means you didn't copy this file to your app directory and it can't link it at runtime.

* SteamAPI_Init() failed; unable to locate a running instance of Steam, or a local steamclient.dll

Your steam client should be running (or you can copy the steamclient dynamic library into your app directory).

* SteamAPI_Init() failed; no appID found.

Steam can't determine for which steam application you are trying to initialise the API. Either launch the game from Steam, or put the file steam_appid.txt containing the correct appID in your app folder. steam_appid.txt should contain just your application id, nothing else.

License

Greenworks is published under the MIT license. See LICENSE file for details.

Help us improve!

Greenworks was developed to enable a minimum set of features for the Game Dev Tycoon release and could surely use more development. If you improve the project please consider opening a pull-request.