Document Steamworks build and API policy

Author: raub

BUILD.md

@@ -1,6 +1,8 @@
 # Building
 
 The Steamworks SDK is not committed and is not shipped in the npm package.
+This follows the Node3D private third-party build input policy recorded in
+[ADR 0014](../../docs/adr/0014-private-third-party-build-inputs.md).
 Maintainer builds expect an unpacked SDK at:
 
 ```text
@@ -14,6 +16,10 @@ The folder should contain the normal Steamworks layout:
 .sdk/sdk/redistributable_bin
 ```
 
+The private archive should be trimmed to those build and runtime inputs.
+Steamworks SDK folders such as `tools` and `steamworksexample` are not needed
+for addon builds.
+
 To hydrate that folder in CI, upload a private `steamworks-sdk.gz` archive and
 set:
 

README.md

@@ -43,23 +43,31 @@ for (const event of update()) {
 The initial binding covers lifecycle, callback pumping, basic app/user helpers,
 auth tickets, DLC metadata, and user stats/achievements.
 
+Methods are grouped by Steamworks interface rather than exported as one flat
+module. This keeps names close to Valve's API documentation and avoids a second
+Node3D-specific taxonomy for the full Steamworks surface.
+
 `steam`:
 
 - `steam.restartAppIfNecessary(appId)`
 - `steam.initEx()`
-- `init()`
 - `steam.shutdown()`
 - `steam.isSteamRunning()`
 - `steam.runCallbacks()`
-- `update()`
 - `steam.releaseCurrentThreadMemory()`
 
+Top-level helpers:
+
+- `init()` - calls `steam.initEx()` and throws when initialization fails.
+- `update()` - calls `steam.runCallbacks()` and then `callbacks.pollCallbacks()`.
+
 `callbacks`:
 
 - `callbacks.pollCallbacks()`
 
 `user`:
 
+- `user.getHSteamUser()`
 - `user.getSteamId()`
 - `user.isLoggedOn()`
 - `user.getAuthSessionTicket()`
@@ -73,12 +81,19 @@ auth tickets, DLC metadata, and user stats/achievements.
 - `utils.getServerRealTime()`
 - `utils.getSteamUiLanguage()`
 - `utils.isOverlayEnabled()`
+- `utils.isSteamInBigPictureMode()`
 
 `apps`:
 
 - `apps.isSubscribed()`
+- `apps.isSubscribedApp(appId)`
 - `apps.isDlcInstalled(appId)`
+- `apps.isAppInstalled(appId)`
+- `apps.getCurrentGameLanguage()`
+- `apps.getAvailableGameLanguages()`
+- `apps.getDlcCount()`
 - `apps.getDlcDataByIndex(index)`
+- `apps.getAppInstallDir(appId)`
 
 `userStats`:
 
@@ -91,10 +106,22 @@ auth tickets, DLC metadata, and user stats/achievements.
 - `userStats.clearAchievement(name)`
 - `userStats.storeStats()`
 - `userStats.resetAllStats(achievementsToo)`
+- `userStats.getNumAchievements()`
+- `userStats.getAchievementName(index)`
+- `userStats.getAchievementDisplayAttribute(name, key)`
 - `userStats.getAchievementAndUnlockTime(name)`
 
-`update()` runs Steam callbacks and returns queued typed callback payloads such
-as `userStatsReceived`, `userStatsStored`, and `userAchievementStored`.
+`steam.runCallbacks()` maps to `SteamAPI_RunCallbacks`.
+`callbacks.pollCallbacks()` drains the Node3D callback queue.
+`update()` does both and returns queued typed callback payloads:
+
+- `userStatsReceived`: `{ gameId, userId, result }`
+- `userStatsStored`: `{ gameId, result }`
+- `userAchievementStored`: `{ gameId, name, currentProgress, maxProgress }`
+- `authSessionTicketResponse`: `{ result, currentProgress }`
+
+Steam IDs and game IDs are exposed as branded strings because Steamworks uses
+64-bit identifiers that should not be rounded through JavaScript numbers.
 
 ## Steamworks SDK Notice