Skip to content

README.md

Latest commit

 

History

History
32 lines (26 loc) · 2.31 KB

README.md

File metadata and controls

32 lines (26 loc) · 2.31 KB
Raw

Node3D Steam API usage guide

The Steamworks reference defines Steam's feature semantics. These guides define how @node-3d/steam-api presents those features to Node.js: JavaScript values, promise completion, callback delivery, and convenience helpers.

Start here

  1. Lifecycle and callbacks — initialize once, pump callbacks, and await Steam call results safely.
  2. IDs and result values — branded decimal-string IDs, enum objects, boolean, and null conventions.
  3. Select the interface guide that owns the Steam operation.

Interfaces

Node3D namespace Guide Official Steamworks reference
steam, callbacks Lifecycle and callbacks Steamworks API overview
steamId Steam IDs SteamID
apps Apps ISteamApps
user User and authentication ISteamUser
utils Utilities and overlay ISteamUtils
friends Friends and presence ISteamFriends
matchmaking Lobbies ISteamMatchmaking
networking Legacy P2P networking ISteamNetworking
networking.sockets, networking.messages Modern P2P networking ISteamNetworkingSockets, ISteamNetworkingMessages
cloud Cloud files ISteamRemoteStorage
ugc Workshop and UGC ISteamUGC
userStats Stats and achievements ISteamUserStats

Every guide assumes steam.initEx() has succeeded unless it states otherwise.