API Reference

NOTE: The content in this wiki is available to v0.5.3 and earlier versions. For official documentation on v0.6.0 or later, see docs.

The greenworks module gives you ability to access Steam APIs, a simple example:

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

if (greenworks.initAPI()) {
  console.log('Steam API has been initalized.');
} else {
  console.log('Error on initializing Steam API');
}

greenworks provides the following APIs:

• Steam Events: supported Steam events.
• Steam Info APIs: such as initAPI, activateAchievement.
• Cloud APIs: such as saveTextToFile, readTextFromFile.
• Workshop APIs: such as ugcPublish, ugcPublished, fileShare.
• Utils APIs: such as createArchive, extractArchive, move.
• Steam Authentication APIs: such as getAuthSessionTicket, cancelAuthTicket, getEncryptedAppTicket.