@pipelab/steamworks.js 0.7.3 → 0.9.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Gabriel Francisco Dos Santos
+Copyright (c) 2026-present Quentin GOINAUD
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,6 @@
-# steamworks.js (Community Fork)
+# Pipelab's steamworks.js
 
-> **Note**: This is an actively maintained community fork of [steamworks.js](https://github.com/CynToolkit/steamworks.js).
+> **Note**: This is an actively maintained community fork of [steamworks.js](https://github.com/ceifa/steamworks.js).
 > We're keeping the project active by reviewing and merging pending PRs and addressing issues.
 
 ## Why This Fork?
@@ -11,46 +11,42 @@
 - ✅ NW.js support improvements
 - ✅ Incorporating pending PRs from upstream
 
+This fork is maintained by [Pipelab](https://pipelab.app).
+
 ## Installation
 
 ```bash
 # npm - use our scoped package
-npm install @mikaldev/steamworks.js
+npm install @pipelab/steamworks.js
 
 # Or reference directly from GitHub
-npm install github:MikalDev/steamworks.js
+npm install github:CynToolkit/steamworks.js
 
 # For Electron/NW.js projects
-npm install github:MikalDev/steamworks.js --runtime=electron --target=27.0.0
-npm install github:MikalDev/steamworks.js --runtime=node-webkit --target=0.75.0
-
+npm install github:CynToolkit/steamworks.js --runtime=electron --target=27.0.0
+npm install github:CynToolkit/steamworks.js --runtime=node-webkit --target=0.75.0
+```
 
 [![Build Status](https://github.com/CynToolkit/steamworks.js/actions/workflows/publish.yml/badge.svg)](https://github.com/CynToolkit/steamworks.js/actions/workflows/publish.yml)
-[![npm](https://img.shields.io/npm/v/steamworks.js.svg)](https://npmjs.com/package/steamworks.js)
+[![npm](https://img.shields.io/npm/v/@pipelab/steamworks.js.svg)](https://npmjs.com/package/@pipelab/steamworks.js)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Chat](https://img.shields.io/discord/663831597690257431?label=chat&logo=discord)](https://discord.gg/H6B7UE7fMY)
 
-# Steamworks.js
+To make the steam overlay working, call the `electronEnableSteamOverlay` on the end of your `main.js` file:
 
-A modern implementation of the Steamworks SDK for HTML/JS and NodeJS based applications.
+```js
+require('@pipelab/steamworks.js').electronEnableSteamOverlay()
+```
 
-## Why
+For the production build, copy the relevant distro files from `sdk/redistributable_bin/{YOUR_DISTRO}` into the root of your build. If you are using electron-forge, look for [#75](https://github.com/CynToolkit/steamworks.js/issues/75).
 
-I used [greenworks](https://github.com/greenheartgames/greenworks) for a long time and it's great, but I gave up for the following reasons.
+# Steamworks.js
 
-* It's not being maintained anymore.
-* It's not up to date.
-* It's not context-aware.
-* You have to build the binaries by yourself.
-* Don't have typescript definitions.
-* The API it's not trustful.
-* The API implement callbacks instead of return flags or promises.
-* I hate C++.
+A modern implementation of the Steamworks SDK for HTML/JS and NodeJS based applications.
 
 ## API
 
 ```js
-const steamworks = require('steamworks.js')
+const steamworks = require('@pipelab/steamworks.js')
 
 // You can pass an appId, or don't pass anything and use a steam_appid.txt file
 const client = steamworks.init(480)
@@ -66,37 +62,6 @@ if (client.achievement.activate('ACHIEVEMENT')) {
 
 You can refer to the [declarations file](https://github.com/CynToolkit/steamworks.js/blob/main/client.d.ts) to check the API support and get more detailed documentation of each function.
 
-## Installation
-
-To use steamworks.js you don't have to build anything, just install it from npm:
-
-```sh
-$: npm i steamworks.js
-```
-
-### Electron
-
-Steamworks.js is a native module and cannot be used by default in the renderer process. To enable the usage of native modules on the renderer process, the following configurations should be made on `main.js`:
-
-```js
-const mainWindow = new BrowserWindow({
-    // ...
-    webPreferences: {
-        // ...
-        contextIsolation: false,
-        nodeIntegration: true
-    }
-})
-```
-
-To make the steam overlay working, call the `electronEnableSteamOverlay` on the end of your `main.js` file:
-
-```js
-require('steamworks.js').electronEnableSteamOverlay()
-```
-
-For the production build, copy the relevant distro files from `sdk/redistributable_bin/{YOUR_DISTRO}` into the root of your build. If you are using electron-forge, look for [#75](https://github.com/CynToolkit/steamworks.js/issues/75).
-
 
 ## How to build
 

package/callbacks.d.ts

@@ -53,4 +53,7 @@ export interface CallbackReturns {
         order_id: number | bigint
         authorized: boolean
     }
+    [client.callback.SteamCallback.GameOverlayActivated]: {
+        active: boolean
+    }
 }

package/client.d.ts

@@ -56,7 +56,8 @@ export declare namespace callback {
     P2PSessionRequest = 6,
     P2PSessionConnectFail = 7,
     GameLobbyJoinRequested = 8,
-    MicroTxnAuthorizationResponse = 9
+    MicroTxnAuthorizationResponse = 9,
+    GameOverlayActivated = 10
   }
   export function register<C extends keyof import('./callbacks').CallbackReturns>(steamCallback: C, handler: (value: import('./callbacks').CallbackReturns[C]) => void): Handle
   export class Handle {
@@ -260,6 +261,10 @@ export declare namespace overlay {
   export function activateToWebPage(url: string): void
   export function activateToStore(appId: number, flag: StoreFlag): void
 }
+export declare namespace screenshots {
+  /** Triggers the Steam overlay to take a screenshot. */
+  export function triggerScreenshot(): void
+}
 export declare namespace stats {
   export function getInt(name: string): number | null
   export function setInt(name: string, value: number): boolean

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pipelab/steamworks.js",
-    "version": "0.7.3",
+    "version": "0.9.0",
     "main": "index.js",
     "types": "index.d.ts",
     "publishConfig": {
@@ -48,4 +48,4 @@
         "type": "git",
         "url": "https://github.com/CynToolkit/steamworks.js"
     }
-}
+}