I'm revisiting my app again after not working on it for a while, and noticed the steam overlay doesn't work, when it used to. I've tried updating to latest and even calling electronEnableSteamOverlay() but nothing happens at all when I press shift+tab. Any ideas?

Windows 10, Electron 22.1.0

client.cloud.readFile('doesnotexist.txt') returns the empty string, as if it were a real file with no contents, but it should throw instead. (Or, apropos #35, its promise should be rejected.)

Is it possible to use the Steamworks Auth API (Session Tickets)? Couldn't find anything here for it yet

https://partner.steamgames.com/doc/features/auth#client_to_backend_webapi

Thanks so much for finally taking on the task of building a modern steamworks api.

We're trying to use this library in an Electron 21-wrapped application, but have run into a compatibility issue with the new V8 memory cage as described here: https://www.electronjs.org/blog/v8-memory-cage

This causes Chromium/Electron to fatal crash whenever we're trying to for example retrieve the session ticket via the api:
[167373:1105/112515.909269:ERROR:node_bindings.cc(146)] Fatal error in V8: v8_ArrayBuffer_NewBackingStore When the V8 Sandbox is enabled, ArrayBuffer backing stores must be allocated inside the sandbox address space. Please use an appropriate ArrayBuffer::Allocator to allocate these buffers

As a result, it is impossible to use this as a node module in Electron 21 and onwards because of this. Trying to disable the sandbox either via launch parameters or sandbox: false has no effect on this setting. Apparently this issue needs to be fixed at the module level as described in the link above, where it mentions this:

This change only affects native Node modules which allocate memory outside of the V8 heap (e.g. using malloc or new) and then wrap the external memory with an ArrayBuffer. This is a fairly rare use case, but some modules do use this technique, and such modules will need to be refactored in order to be compatible with Electron 20+

I don't know enough about the internals to know how to suggest this fix in a PR, or even where to suggest it, but the end result is still that it renders this module incompatible with Electron 20+ 😞

app.commandLine.appendSwitch('in-process-gpu')
app.commandLine.appendSwitch('disable-direct-composition')

I don't see these in the Electron documentation.

In my main process I'm doing:

app.commandLine.appendSwitch("in-process-gpu");
app.commandLine.appendSwitch("disable-direct-composition");

const client = steamworks.init(480);

And in my render process I have:

// this is required for Steam Overlay to render smoothly
function tick() {
    console.log("tick");
    requestAnimationFrame(() => tick());
}
tick();

But when devtools is closed, the overlay doesn't show at all, and when devtools is open, it shows and looks ok, but I can't see the game behind it and pressing Shift+Tab again switches focus to devtools and it isn't possible to return to the main browser view. This suggests to me that devtools possibly has its own process/window that the overlay is attaching to. Any ideas?

client.achievement.activate('ACHIEVEMENT') seems to return true even if the achievement was previously activated. It would be awesome if this either a) had a way of only returning true if the achievement was newly activated, or if b) there was a way to check beforehand if the achievement had already been obtained.

Related #17

Self-explanatory.

First off I want to thank all the contributors for this awesome project! 🔥

I am working on a project were I have to be able to initialize and gracefully shut down the steamworks client during different lifecycles of my app (Electron). Lazy initialization of the client works as expected, but I am unable to see a way to call the internal shutdown function to gracefully detach from the steam process without closing the app.

I see that there is a gc (drop) function in the steamworks-rs package this project is using, but I see no way of triggering this from JS.

Any help would be appreciated! 😺

A generated documentation from the declaration files could be a great solution

It would be nice if the Github release automation would tag a release, linking to a commit, etc.

Is it possible for you to add Steam Inventory Support (found here: https://partner.steamgames.com/doc/api/ISteamInventory) Including Steam Inventory Sales

https://partner.steamgames.com/doc/features/inventory/itemstore

Thanks

client.achievement.activate('ACHIEVEMENT') does not seem to actually set the achievement as true.
I'm using the achievement ID set up in steam but when I run it but still it results in a FALSE.

Is there actually a working example? I have checked other projects using steamworks.js and none actually seem to use client.achievement.

I have also noticed I'm getting this message at start up and wonder if there is a connection.

Setting breakpad minidump AppID = myappid
SteamInternal_SetMinidumpSteamID:  Caching Steam ID:  mysteaid [API loaded no]

But I am still able to get my playername via client.localplayer.getName() so I'm not sure if the "[API loaded no]" mean anything or not.

Getting an error when steamworks tries to use /dist/osx/steamworksjs.darwin-x64.node: incompatible architecture (have 'x86_64', need 'arm64e')

Working on a macbook pro with M1 chip

also, love the work you're doing with this project - excellent alternative to greenworks

I know this is a long shot (feel free to close this issue if it's off topic), but I'm struggling to get my Electron app to launch and run properly on Steam Deck or on Manjaro Linux, the distro that Steam recommends for testing Steam Deck compatibility.

https://steamcommunity.com/groups/steamworks/discussions/0/3373782431179895116/

Steam Deck app crashes instantly running Electron app

I'm trying to make my app compatible with Steam Deck.

My app seems to work fine on Linux when I launch it directly from the console; I've tested it in Ubuntu 22 and in Manjaro 22. I cd to the directory containing my files, run ./MyGame and it launches without error.

But when I upload the game to SteamPipe and launch it via Steam, something strange happens. When I launch it on a physical Steam Deck, the button briefly turns blue and says "X STOP," but then it just immediately turns green and says "PLAY" again.

I have to assume that the app must have crashed or something? (With no error message??) But I've configured my game to log a message to the file system on the first line, as soon as it launches, and my log message doesn't get run. It's like my app never launches.

More mysteriously, when I "Switch to Desktop", open Konsole, cd to the directory containing my game, and run ./MyGame, it launches without error, just as I'd expect.

Soooo I tried running Steam on Manjaro 22. On Manjaro 22, when I click the Play button, it doesn't crash instantly, or at all. Instead, when I click Play, the button turns blue and says "X STOP" but my app window doesn't open, and no log message is displayed, for exactly 90 seconds (!!!) and then, right at the end of 90 seconds, the app window opens and the game launches and plays normally.

I can't understand at all what could be causing this behavior. As far as I can tell, there are no bugs in my code. As soon as my app ACTUALLY launches, the game starts up immediately, but the Steam launcher is either refusing to launch my app at all (on Steam Deck) or delaying launch needlessly for 90 seconds (on Manjaro).

How can I debug this issue?

(FWIW, my game is an Electron app (a giant wrapper around Google Chrome). It's designed to work great on Windows and Linux, which is part of why I picked Electron as a platform. Could this have something to do with it? I can't imagine what…???)

Any idea what could be wrong here?

This is a cool library, and I am going to use this in my game based on electron.
I want a feature is to get the installation directory of the current app.

https://partner.steamgames.com/doc/api/steam_api#SteamAPI_RestartAppIfNecessary

Checks if your executable was launched through Steam and relaunches it through Steam if it wasn't.

If one were to implement a Login with Steam solution on the server side, how would that be done? You couldn't take the client's word for it as, well, it's the client and can be exploited.

Is there any way to check the validity of a steam user's ID, username, achievements, etc. on a Node.JS server app?

I tried to include the steamworks.js module in my TypeScript-based codebase.
Unfortunately, Visual Studio Code / the Type Script Compiler complains:

Could not find a declaration file for module 'steamworks.js'.
'/[PATH_TO_MY_PROJECT]/node_modules/steamworks.js/index.js' implicitly has an 'any' type.
Try npm i --save-dev @types/steamworks.js if it exists or add a new declaration (.d.ts) file containing declare module 'steamworks.js';ts(7016)

I assume that the file client.d.ts must be referenced in package.json:

{
  "name": "steamworks.js",
  "types": "client.d.ts",
  "REST_OF_PACKAGE_JSON": "AS_USUAL"
}

See: https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html

Currently, readFile and writeFile are synchronous, but under the hood, they're doing asynchronous work. I think they should probably return promises instead.

(I bet there are others like this.)

How can I call the ClearAchievement interface？
https://partner.steamgames.com/doc/api/ISteamUserStats

It would great to be able to allow players to invite their steam friends to play with them. As far as I can tell this requires the following steam API calls:

• ISteamMatchmaking.CreateLobby
• ISteamFriends.ActivateGameOverlayInviteDialog
• ISteamMatchmaking.JoinLobby
• Various Lobby callbacks:
  • LobbyCreate_t
  • LobbyEnter_t
  • LobbyInvite_t
  • LobbyDataUpdate_t

I suspect this is an incomplete list since I haven't implemented this in another system and it is one of more complex interactions with the Steam SDK.

when on 2.15.1 there is no error

export namespace input {
  ...
  export function getActionSet(actionSetName: string): bigint
  ...
}

How can I get getActionSet's param actionSetName?

steamworks.js's API doesn't match the API of steamworks-rs or the official Steamworks C++ API. As a result, it's kinda hard to track down documentation for individual methods.

For example, client.cloud.readFile is in a cloud package, but the Steamworks API refers to it as "ISteamRemoteStorage", and steamworks-rs puts it in a struct called RemoteStorage. So if you know you want the "remote storage" functions, you just have to figure out that in steamworks.js, that means the cloud package.

Furthermore, cloud.readFile has no documentation, and steamworks-rs doesn't have a simple read_file function. As a result, the only way to learn what readFile does is to read cloud.rs, comparing and contrasting that with https://docs.rs/steamworks/latest/steamworks/struct.SteamFileReader.html#method.read_to_string and thinking about how that might correspond to https://partner.steamgames.com/doc/api/ISteamRemoteStorage#FileReadAsync

I think at least the exposed modules should map one-to-one with the modules of steamworks-rs, so, e.g. cloud.rs should be remote_storage.rs, and each function should either have hand-written documentation or should link to the documentation on https://docs.rs/steamworks/latest/steamworks/

Currently, steamworks.js only works with Electron for desktop applications. However, Tauri is an interesting alternative to Electron that offers improved security and a smaller package size. So we would like to propose an application to integrate Tauri with steamworks.js.

Tauri is a platform for building cross-platform desktop applications using web technologies such as Rust, HTML, CSS and JavaScript. It offers a secure environment by default, with sandboxing and a strong security policy. In addition, Tauri generates smaller binaries than those generated by Electron, which can be an advantage for developers looking to optimize the size of their application.

I understand that this integration may require significant changes to the steamworks.js code, but I think it's worth exploring this possibility. So I would like to ask the steamworks.js developers to look into the possibility of integrating Tauri for desktop applications.

I hope you will take this request into consideration and consider Tauri integration for desktop applications.

Helloh!

Nice project, finally something more up to date than Greenworks :)

Would it be possible to add the callback for GameOverlayActivated?
https://partner.steamgames.com/doc/api/ISteamFriends#GameOverlayActivated_t

Would be nice to be able to know whenever the overlay is opened and or closed.

According to the documentation (and the JavaScript code as well), the parameter appId should be optional.

Source: client.d.ts

Status quo:

export function init(appId: number): void

Desired state:

export function init(appId?: number): void

What I have done so far:

in index.js:

const createWindow = () => {
  // Create the browser window.
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: true,
      preload: path.join(__dirname, 'preload.js'),
    },
})

in preload.js:

const steamworks = require('steamworks.js')
const { contextBridge } = require('electron')
contextBridge.exposeInMainWorld('steamworks', steamworks)

Other files in the renderer thread can then reference the 'steamworks' object.

This is working so far in Electron on MacOS with some simple functions, init, setting/clearing achievements (though MacOS does not support Electron/Steam overlay, so I have not tested that yet, will test it later on a Windows dev system.) Anyone have experience with this yet?

I created a test project to test steamworks js, added a index.js file with following code:
`const sw = require("steamworks.js")

const client = sw.init(/app id/);

console.log(client.localplayer.getName());`

but when I tried to run it, received following error:
`C:\Users\samee\dev\work\grest_games\test\node_modules\steamworks.js\index.js:44
internalInit(appId)
^

Error: failed to init the steamworks API
at Object.module.exports.init (C:\Users\samee\dev\work\grest_games\test\node_modules\steamworks.
js\index.js:44:5)
at Object. (C:\Users\samee\dev\work\grest_games\test\index.js:3:19)
at Module._compile (node:internal/modules/cjs/loader:1101:14)
at Object.Module._extensions..js (node:internal/modules/cjs/loader:1153:10)
at Module.load (node:internal/modules/cjs/loader:981:32)
at Function.Module._load (node:internal/modules/cjs/loader:822:12)
at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
at node:internal/main/run_main_module:17:47 {
code: 'GenericFailure'
}`

I'm calling steamworks.init(480) in the renderer, and it works fine on first load, but then when reloading the window it calls that again and I get the error:

Uncaught (in promise) Error: Client already initialized for app id 480

Even if I put a huge timeout here, it still errors. Works fine in main process btw.

https://partner.steamgames.com/doc/sdk/api currently links to greenworks, which links here. (That's how I found this library.)

It would be cool if Valve linked to steamworks.js instead of the unmaintained greenworks project. (It might be as easy as starting a thread on the discussion forum, and asking to be added to the official documentation.)

Very cool. I did the test. If you want to compare the files I put it in my fork.
I found this error.

File 'SteamClient.ts' replace 'ipcontry' by 'ipcountry'

return await Api.send(`/client/ipcontry` 

This I changed only here to use with NW.js

 process.cwd()

Instead of

import * as path from 'node:path'
path.resolve(__dirname

Sometimes in first run, it doesn't load the lib. However, this probably occurs only here.

error Steamworks: Setting breakpad minidump AppID = 480
error Steamworks: SteamInternal_SetMinidumpSteamID:  Caching Steam ID: [API loaded no]

Steam overlay not yet tested.

I also deleted the Steam dlls because I think sharing this is not allowed.
I know Facepunch.Steamworks shares this, but I think it's illegal.
I recommend leaving in the description the version of the dlls to download on the official website, and in which folder to put it like greenworks repo.

I also add SteamFriends.cs and SteamFriends.ts to test if I understood how it worked.
Change It was relatively easy. Calls to the API worked fine. I'll wait now to see the callbacks/events.
I still don't understand 100% of the code, but I really liked it connection js /dotnet. ^^

I would like to be able to fetch the correct controller glyphs for my application from steam input as i'm developing for the steam deck.

Hey!

Steamworks' UGC API allows for a AppID overwrite, this would be really useful to implement in steamworks.js.

I use steamworks.js to upload content to the steam workshop, and have built a workshop tool for this purpos, which can be downloaded in Steam as a tool seperately from my game.

Sadly, due to the lack of an appID overwrite in createItem, I had to init steamworks.js with the appID of my main game, and people using my tool only have the main game name set as presence.

Sincerely,
Steff

https://partner.steamgames.com/doc/api/ISteamApps

I particularly need BIsSubscribedApp so I can tell whether the user has purchased a certain DLC.

Hi! Just upgraded the library and Electron to 22, however I'm now getting an error on init calls;

Error: Failed to create napi buffer

I am new to rust / napi-rs. I am trying to see if it is possible to use the precompiled steamworks.js node binaries or build new binaries to work with nwjs, instead of electron (I am using a build service which uses nwjs.)

I have tried nwjs with the npm node files on MacOS and it seems to work fine, with various versions of nwjs.

However on Windows, I can only get electron versions of my app to work.

When I try using steamworks.js with nwjs on Windows, the app crashes when loading the steamworks node binary.

I am able to build the node binaries on Windows, but I am not sure if I need to do something specific to get it compiled for nwjs (I did add nw to devDependencies with same version as my runtime (and removed electron), but that did not seem to help. Is there a step I am missing? I have seen comments about the possibility of different native node modules requiring different compiles on node vs electron vs nwjs.

Hi there,

Love the project, so glad to see an API for Steamworks SDK for JavaScript - absolutely saved my life.

I'm trying to implement AuthTickets (I have a game that uses a remote server). I think I can implement it pretty easily (and I'm happy to put in a PR once it's done), but I wanted to ask how you build for all targets?

I can see the build puts a .node file out into /dist, but mine only does Linux, do I need to do it on all three platforms?

TIA

Hi there, big thanks for replacing greenworks. This looks like it will be way easier to use. I'm having a basic issue with steam cloud. I have my app configured in steamworks with 5mb and 10 files max. I'm trying to save a single file that is a short string.

cloud.writeFile('sp-save', 'test')

always returns false. I don't know what that means other than the write failed. I can confirm it failed by noting that

cloud.readFile('sp-save')

returns nothing. How do I troubleshoot this knowing that my app is configured correctly in steamworks?
On steamworks.js boot I do see this:

Setting breakpad minidump AppID = (my app id)
SteamInternal_SetMinidumpSteamID: Caching Steam ID: 76561197992801299 [API loaded no]

Does this mean anything?

steamClient.localplayer.getName() works, but calling
let ticket = await steamClient.auth.getSessionTicket(); never returns.

This issue happens on both Windows (see terminal log) and Linux. On some machines it started to work after some time without any obvious changes.

SteamInternal_SetMinidumpSteamID:  Caching Steam ID:  76561198[redacted] [API loaded no]
steamClient.localplayer.getName(): [redacted]

thread 'tokio-runtime-worker' panicked at 'called `Result::unwrap()` on an `Err` value: RecvError(())', src\api\auth.rs:62:40
stack backtrace:
   0:     0x7ff8ff0dc9f7 - napi_register_module_v1
   1:     0x7ff8ff0ab74b - <unknown>
   2:     0x7ff8ff0d2e91 - napi_register_module_v1
   3:     0x7ff8ff0deb6b - napi_register_module_v1
   4:     0x7ff8ff0de727 - napi_register_module_v1
   5:     0x7ff8ff0df68d - napi_register_module_v1
   6:     0x7ff8ff0df135 - napi_register_module_v1
   7:     0x7ff8ff0df07f - napi_register_module_v1
   8:     0x7ff8ff0df054 - napi_register_module_v1
   9:     0x7ff8ff172e85 - napi_register_module_v1
  10:     0x7ff8ff1730f3 - napi_register_module_v1
  11:     0x7ff8ff10fca1 - napi_register_module_v1
  12:     0x7ff8ff130ccd - napi_register_module_v1
  13:     0x7ff8ff169786 - napi_register_module_v1
  14:     0x7ff8ff16d155 - napi_register_module_v1
  15:     0x7ff8ff165a19 - napi_register_module_v1
  16:     0x7ff8ff167721 - napi_register_module_v1
  17:     0x7ff8ff0dbd1b - napi_register_module_v1
  18:     0x7ff930fe7614 - BaseThreadInitThunk
  19:     0x7ff932a426a1 - RtlUserThreadStart

Hi there!
I'm currently running into an issue with trying to access the functions in client.apps. For some reason, it doesn't seem to include those functions when I print it out, nor when I try them. I just get a client.apps is undefined. Here is an example of what I am trying to do.

  const steamworks = require('steamworks.js')
  let client

  try {
    client = steamworks.init(2233750)
  } catch (err) {
    console.log(err)
    client = null
  }

  console.log(client.apps.appBuildId())
  console.log('client', client)

As you can see in the image below, I'm not seeing apps either in that list.

Here is the error:

Version: 0.0.25
OS: Mac

Any help here? I can't seem to find documentation on it, so I can't tell if it's a bug or if it's an issue on my end. I typically think it's an issue on my end. I kind of wonder if it's due to me being on a Mac. Maybe the dist for Mac wasn't built yet?

hi, since the type defined in Dependency Library is LobbyId/SteamId, when we register the callback, the value is returned by Is there any good way to get the correct value?

I'm using Angular+electron+steamworks.js, and I've been trying for a long time, but it doesn't work properly.
The furthest I can get is the steam community overlay popping up on the page, but the mask doesn't refresh in real time, and finally when I package it as a desktop application, it doesn't work and throws an exception.

Is there a sample project I can refer to?

The published releases of steamworks.js include all platforms (windows, mac, linux), but npm run build only builds the current platform.

How do you compile steamworks.js for all platforms? Is there a command you use? What is it? (And could it be added to the README?)

I develop on Mac and as far as I can tell none of the steam overlay stuff works (shift+tab, invite dialog, or achievements), either running electron via npm starm or launching through steam. I can confirm that all of these work in windows though. I have not tested Linux yet.

Apparently steamworks.js depends on C++ redist packages, but I'm not sure where that dependency comes from. The idea of this issue is to understand this and document it.

As discuss on Discord earlier this year I would love it if callback.SteamCallback also includes MicroTxnAuthorizationResponse_t to allow developers of steamworks.js to automatically complete authorized purchases made via the Steam overlay.

https://partner.steamgames.com/doc/api/ISteamUser

In-app must be initialized through your own backend (this cannot be implemented through Steamworks SDK). More on that here: https://steamcommunity.com/dev

I already have this set up for my game (https://worldseed.eu). Without MicroTxnAuthorizationResponse_t I must optimistically guess that a initiated purchase went through and provide the user with a button to manually call FinalizeTxn: https://partner.steamgames.com/doc/webapi/ISteamMicroTxn