Skip to content

README.md

Latest commit

 

History

History
99 lines (70 loc) · 2.23 KB

README.md

File metadata and controls

99 lines (70 loc) · 2.23 KB
Raw

@node-3d/steam-api

[WIP] Steamworks API bindings for Node.js.

Install

npm install @node-3d/steam-api

Published packages include prebuilt native binaries. A consumer install doesn't need a compiler or a local Steamworks SDK copy.

Example

import { steam, update, user, utils } from '@node-3d/steam-api';

const result = steam.initEx();

if (!result.ok) {
	throw new Error(`Steamworks init failed: ${result.errorMessage}`);
}

console.log('app', utils.getAppId());
console.log('user', user.getSteamId(), user.isLoggedOn() ? 'logged on' : 'offline');

for (const event of update()) {
	console.log(event);
}

API Surface

The initial binding covers lifecycle, callback pumping, basic app/user helpers, auth tickets, DLC metadata, and user stats/achievements.

steam:

  • steam.restartAppIfNecessary(appId)
  • steam.initEx()
  • init()
  • steam.shutdown()
  • steam.isSteamRunning()
  • steam.runCallbacks()
  • update()
  • steam.releaseCurrentThreadMemory()

callbacks:

  • callbacks.pollCallbacks()

user:

  • user.getSteamId()
  • user.isLoggedOn()
  • user.getAuthSessionTicket()
  • user.cancelAuthTicket(handle)

utils:

  • utils.getAppId()
  • utils.getConnectedUniverse()
  • utils.getIpCountry()
  • utils.getServerRealTime()
  • utils.getSteamUiLanguage()
  • utils.isOverlayEnabled()

apps:

  • apps.isSubscribed()
  • apps.isDlcInstalled(appId)
  • apps.getDlcDataByIndex(index)

userStats:

  • userStats.getStatInt(name)
  • userStats.getStatFloat(name)
  • userStats.setStatInt(name, value)
  • userStats.setStatFloat(name, value)
  • userStats.getAchievement(name)
  • userStats.setAchievement(name)
  • userStats.clearAchievement(name)
  • userStats.storeStats()
  • userStats.resetAllStats(achievementsToo)
  • userStats.getAchievementAndUnlockTime(name)

update() runs Steam callbacks and returns queued typed callback payloads such as userStatsReceived, userStatsStored, and userAchievementStored.

Steamworks SDK Notice

Valve's Steamworks SDK files are not part of this repository. This repository contains Node3D binding code only.

Maintainers must provide the SDK separately under Valve's Steamworks terms when building native binaries.

See BUILD.md for local and CI build setup.