steamworks.js-timmy 0.1.15 → 0.1.17

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Gabriel Francisco Dos Santos
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Gabriel Francisco Dos Santos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,88 +1,7 @@
-[![Build Status](https://github.com/ceifa/steamworks.js/actions/workflows/publish.yml/badge.svg)](https://github.com/ceifa/steamworks.js/actions/workflows/publish.yml)
-[![npm](https://img.shields.io/npm/v/steamworks.js.svg)](https://npmjs.com/package/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
-
-A modern implementation of the Steamworks SDK for HTML/JS and NodeJS based applications.
-
-## Why
-
-I used [greenworks](https://github.com/greenheartgames/greenworks) for a long time and it's great, but I gave up for the following reasons.
-
-* 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++.
-
-## API
-
-```js
-const steamworks = require('steamworks.js')
-
-// You can pass an appId, or don't pass anything and use a steam_appid.txt file
-const client = steamworks.init(480)
-
-// Print Steam username
-console.log(client.localplayer.getName())
-
-// Tries to activate an achievement
-if (client.achievement.activate('ACHIEVEMENT')) {
-    // ...
-}
-```
-
-You can refer to the [declarations file](https://github.com/ceifa/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/ceifa/steamworks.js/issues/75).
-
-
-## How to build
-
-> You **only** need to build if you are going to change something on steamworks.js code, if you are looking to just consume the library or use it in your game, refer to the [installation section](#installation).
-
-Make sure you have the latest [node.js](https://nodejs.org/en/), [Rust](https://www.rust-lang.org/tools/install) and [Clang](https://rust-lang.github.io/rust-bindgen/requirements.html). We also need [Steam](https://store.steampowered.com/about/) installed and running.
-
-Install dependencies with `npm install` and then run `npm run build:debug` to build the library.
-
-There is no way to build for all targets easily. The good news is that you don't need to. You can develop and test on your current target, and open a PR. When the code is merged to main, a github action will build for all targets and publish a new version.
-
-### Testing Electron
-
-Go to the [test/electron](./test/electron) directory. There, you can run `npm install` and then `npm start` to run the Electron app.
-
-Click "activate overlay" to test the overlay.
+# steamworks.js-timmy
+
+package with added features and newer steam API
+
+yum
+
+specifically tailored for [NEODITRONIX](https://store.steampowered.com/app/3782120/NEODITRONIX/), please play it!!!!

package/callbacks.d.ts

@@ -1,56 +1,56 @@
-import client = require('./client')
-
-export const enum ChatMemberStateChange {
-    /** This user has joined or is joining the lobby. */
-    Entered,
-    /** This user has left or is leaving the lobby. */
-    Left,
-    /** User disconnected without leaving the lobby first. */
-    Disconnected,
-    /** The user has been kicked. */
-    Kicked,
-    /** The user has been kicked and banned. */
-    Banned,
-}
-
-export interface CallbackReturns {
-    [client.callback.SteamCallback.PersonaStateChange]: {
-        steam_id: bigint
-        flags: { bits: number }
-    }
-    [client.callback.SteamCallback.SteamServersConnected]: {}
-    [client.callback.SteamCallback.SteamServersDisconnected]: {
-        reason: number
-    }
-    [client.callback.SteamCallback.SteamServerConnectFailure]: {
-        reason: number
-        still_retrying: boolean
-    }
-    [client.callback.SteamCallback.LobbyDataUpdate]: {
-        lobby: bigint
-        member: bigint
-        success: boolean
-    }
-    [client.callback.SteamCallback.LobbyChatUpdate]: {
-        lobby: bigint
-        user_changed: bigint
-        making_change: bigint
-        member_state_change: ChatMemberStateChange
-    }
-    [client.callback.SteamCallback.P2PSessionRequest]: {
-        remote: bigint
-    }
-    [client.callback.SteamCallback.P2PSessionConnectFail]: {
-        remote: bigint
-        error: number
-    }
-    [client.callback.SteamCallback.GameLobbyJoinRequested]: {
-        lobby_steam_id: bigint
-        friend_steam_id: bigint
-    }
-    [client.callback.SteamCallback.MicroTxnAuthorizationResponse]: {
-        app_id: number
-        order_id: number | bigint
-        authorized: boolean
-    }
-}
+import client = require('./client')
+
+export const enum ChatMemberStateChange {
+    /** This user has joined or is joining the lobby. */
+    Entered,
+    /** This user has left or is leaving the lobby. */
+    Left,
+    /** User disconnected without leaving the lobby first. */
+    Disconnected,
+    /** The user has been kicked. */
+    Kicked,
+    /** The user has been kicked and banned. */
+    Banned,
+}
+
+export interface CallbackReturns {
+    [client.callback.SteamCallback.PersonaStateChange]: {
+        steam_id: bigint
+        flags: { bits: number }
+    }
+    [client.callback.SteamCallback.SteamServersConnected]: {}
+    [client.callback.SteamCallback.SteamServersDisconnected]: {
+        reason: number
+    }
+    [client.callback.SteamCallback.SteamServerConnectFailure]: {
+        reason: number
+        still_retrying: boolean
+    }
+    [client.callback.SteamCallback.LobbyDataUpdate]: {
+        lobby: bigint
+        member: bigint
+        success: boolean
+    }
+    [client.callback.SteamCallback.LobbyChatUpdate]: {
+        lobby: bigint
+        user_changed: bigint
+        making_change: bigint
+        member_state_change: ChatMemberStateChange
+    }
+    [client.callback.SteamCallback.P2PSessionRequest]: {
+        remote: bigint
+    }
+    [client.callback.SteamCallback.P2PSessionConnectFail]: {
+        remote: bigint
+        error: number
+    }
+    [client.callback.SteamCallback.GameLobbyJoinRequested]: {
+        lobby_steam_id: bigint
+        friend_steam_id: bigint
+    }
+    [client.callback.SteamCallback.MicroTxnAuthorizationResponse]: {
+        app_id: number
+        order_id: number | bigint
+        authorized: boolean
+    }
+}

package/dist/win64/index.js

@@ -31,7 +31,10 @@ module.exports.init = (appId) => {
     internalInit(appId)
 
     clearInterval(runCallbacksInterval)
-    runCallbacksInterval = setInterval(runCallbacks, 1000 / 30)
+    runCallbacksInterval = setInterval(() => {
+        // console.log("Running callbacks")
+        runCallbacks()
+    }, 1000 / 120)
 
     return api
 }

package/index.js

@@ -1,86 +1,89 @@
-const { platform, arch } = process
-
-/** @typedef {typeof import('./client.d')} Client */
-/** @type {Client} */
-let nativeBinding = undefined
-
-if (platform === 'win32' && arch === 'x64') {
-    nativeBinding = require('./dist/win64/steamworksjs.win32-x64-msvc.node')
-} else if (platform === 'linux' && arch === 'x64') {
-    nativeBinding = require('./dist/linux64/steamworksjs.linux-x64-gnu.node')
-} else if (platform === 'darwin') {
-    if (arch === 'x64') {
-        nativeBinding = require('./dist/osx/steamworksjs.darwin-x64.node')
-    } else if (arch === 'arm64') {
-        nativeBinding = require('./dist/osx/steamworksjs.darwin-arm64.node')
-    }
-} else {
-    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
-}
-
-let runCallbacksInterval = undefined
-
-/**
- * Initialize the steam client or throw an error if it fails
- * @param {number} [appId] - App ID of the game to load, if undefined, will search for a steam_appid.txt file
- * @returns {Omit<Client, 'init' | 'runCallbacks'>}
-*/
-module.exports.init = (appId) => {
-    const { init: internalInit, runCallbacks, restartAppIfNecessary, ...api } = nativeBinding
-
-    internalInit(appId)
-
-    clearInterval(runCallbacksInterval)
-    runCallbacksInterval = setInterval(runCallbacks, 1000 / 30)
-
-    return api
-}
-
-/**
- * @description Shuts down the steam client
- */
-module.exports.shutdown = () => { 
-    clearInterval(runCallbacksInterval)
-    nativeBinding.shutdownClient()
-    runCallbacksInterval = undefined
-}
-
-/**
- * @param {number} appId - App ID of the game to load
- * {@link https://partner.steamgames.com/doc/api/steam_api#SteamAPI_RestartAppIfNecessary}
- * @returns {boolean} 
- */
-module.exports.restartAppIfNecessary = (appId) => nativeBinding.restartAppIfNecessary(appId);
-
-/**
- * Enable the steam overlay on electron
- * @param {boolean} [disableEachFrameInvalidation] - Should attach a single pixel to be rendered each frame
-*/
-module.exports.electronEnableSteamOverlay = (disableEachFrameInvalidation) => {
-    const electron = require('electron')
-    if (!electron) {
-        throw new Error('Electron module not found')
-    }
-
-    electron.app.commandLine.appendSwitch('in-process-gpu')
-    electron.app.commandLine.appendSwitch('disable-direct-composition')
-
-    if (!disableEachFrameInvalidation) {
-        /** @param {electron.BrowserWindow} browserWindow */
-        const attachFrameInvalidator = (browserWindow) => {
-            browserWindow.steamworksRepaintInterval = setInterval(() => {
-                if (browserWindow.isDestroyed()) {
-                    clearInterval(browserWindow.steamworksRepaintInterval)
-                } else if (!browserWindow.webContents.isPainting()) {
-                    browserWindow.webContents.invalidate()
-                }
-            }, 1000 / 60)
-        }
-
-        electron.BrowserWindow.getAllWindows().forEach(attachFrameInvalidator)
-        electron.app.on('browser-window-created', (_, bw) => attachFrameInvalidator(bw))
-    }
-}
-
-const SteamCallback = nativeBinding.callback.SteamCallback
+const { platform, arch } = process
+
+/** @typedef {typeof import('./client.d')} Client */
+/** @type {Client} */
+let nativeBinding = undefined
+
+if (platform === 'win32' && arch === 'x64') {
+    nativeBinding = require('./dist/win64/steamworksjs.win32-x64-msvc.node')
+} else if (platform === 'linux' && arch === 'x64') {
+    nativeBinding = require('./dist/linux64/steamworksjs.linux-x64-gnu.node')
+} else if (platform === 'darwin') {
+    if (arch === 'x64') {
+        nativeBinding = require('./dist/osx/steamworksjs.darwin-x64.node')
+    } else if (arch === 'arm64') {
+        nativeBinding = require('./dist/osx/steamworksjs.darwin-arm64.node')
+    }
+} else {
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+let runCallbacksInterval = undefined
+
+/**
+ * Initialize the steam client or throw an error if it fails
+ * @param {number} [appId] - App ID of the game to load, if undefined, will search for a steam_appid.txt file
+ * @returns {Omit<Client, 'init' | 'runCallbacks'>}
+*/
+module.exports.init = (appId) => {
+    const { init: internalInit, runCallbacks, restartAppIfNecessary, ...api } = nativeBinding
+
+    internalInit(appId)
+
+    clearInterval(runCallbacksInterval)
+    runCallbacksInterval = setInterval(() => {
+        // console.log("Running callbacks")
+        runCallbacks()
+    }, 1000 / 120)
+
+    return api
+}
+
+/**
+ * @description Shuts down the steam client
+ */
+module.exports.shutdown = () => { 
+    clearInterval(runCallbacksInterval)
+    nativeBinding.shutdownClient()
+    runCallbacksInterval = undefined
+}
+
+/**
+ * @param {number} appId - App ID of the game to load
+ * {@link https://partner.steamgames.com/doc/api/steam_api#SteamAPI_RestartAppIfNecessary}
+ * @returns {boolean} 
+ */
+module.exports.restartAppIfNecessary = (appId) => nativeBinding.restartAppIfNecessary(appId);
+
+/**
+ * Enable the steam overlay on electron
+ * @param {boolean} [disableEachFrameInvalidation] - Should attach a single pixel to be rendered each frame
+*/
+module.exports.electronEnableSteamOverlay = (disableEachFrameInvalidation) => {
+    const electron = require('electron')
+    if (!electron) {
+        throw new Error('Electron module not found')
+    }
+
+    electron.app.commandLine.appendSwitch('in-process-gpu')
+    electron.app.commandLine.appendSwitch('disable-direct-composition')
+
+    if (!disableEachFrameInvalidation) {
+        /** @param {electron.BrowserWindow} browserWindow */
+        const attachFrameInvalidator = (browserWindow) => {
+            browserWindow.steamworksRepaintInterval = setInterval(() => {
+                if (browserWindow.isDestroyed()) {
+                    clearInterval(browserWindow.steamworksRepaintInterval)
+                } else if (!browserWindow.webContents.isPainting()) {
+                    browserWindow.webContents.invalidate()
+                }
+            }, 1000 / 60)
+        }
+
+        electron.BrowserWindow.getAllWindows().forEach(attachFrameInvalidator)
+        electron.app.on('browser-window-created', (_, bw) => attachFrameInvalidator(bw))
+    }
+}
+
+const SteamCallback = nativeBinding.callback.SteamCallback
 module.exports.SteamCallback = SteamCallback

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "steamworks.js-timmy",
-    "version": "0.1.15",
+    "version": "0.1.17",
     "main": "index.js",
     "types": "index.d.ts",
     "napi": {
@@ -23,18 +23,17 @@
     "license": "MIT",
     "devDependencies": {
         "@napi-rs/cli": "3.3.1",
+        "@types/node": "*",
         "electron": "24.2.0",
         "rimraf": "6.0.1",
         "typescript": "5.5.3"
     },
-    "dependencies": {
-        "@types/node": "*"
-    },
     "engines": {
         "node": ">= 14"
     },
     "scripts": {
         "build": "npm run types && node build --release",
+        "prepare": "npm run build",
         "build:debug": "node build",
         "prune": "rimraf dist target client.d.ts",
         "format": "cargo clippy --fix --allow-staged && cargo fmt",