ceifa · ceifa · Jul 4, 2023 · Jun 8, 2023 · Jun 22, 2023
diff --git a/README.md b/README.md
@@ -77,3 +77,9 @@ Make sure you have the latest [node.js](https://nodejs.org/en/), [Rust](https://
 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.
diff --git a/test/electron/index.html b/test/electron/index.html
@@ -11,6 +11,7 @@
 
 <body>
     <h1>Your steam name: <span id="name"></span></h1>
+    <button id="activateOverlay">activate overlay</button>
     <script src="./renderer.js"></script>
 </body>
 

diff --git a/test/electron/renderer.js b/test/electron/renderer.js
@@ -3,4 +3,8 @@ const steamworks = require('steamworks.js');
 const client = steamworks.init(480);
 
 const playerName = client.localplayer.getName()
-document.getElementById('name').innerText = playerName
+document.getElementById('name').innerText = playerName
+
+document.getElementById('activateOverlay').addEventListener('click', function() {
+    client.overlay.activateToWebPage('https://www.example.com/')
+})
diff --git a/test/overlay.js b/test/overlay.js
@@ -0,0 +1,10 @@
+const { init } = require('../index.js')
+
+const client = init(480)
+
+/*
+This node script is "headless." It has no graphical context into which Steam can inject an overlay.
+
+Therefore, when you run this script while the Steam app is running, Steam will foreground the Steam app, and display example.com in the Steam app's window.
+*/
+client.overlay.activateToWebPage('https://www.example.com/');