Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crutchtheclutch/localhost-steam-api
Provides an easy way to access and use the Steam API on a local machine.
https://github.com/crutchtheclutch/localhost-steam-api
achievements local-machine obs steam steam-api steam-stats
Last synced: 21 days ago
JSON representation
Provides an easy way to access and use the Steam API on a local machine.
- Host: GitHub
- URL: https://github.com/crutchtheclutch/localhost-steam-api
- Owner: CrutchTheClutch
- Created: 2018-04-29T23:32:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-17T20:58:10.000Z (almost 6 years ago)
- Last Synced: 2025-01-04T01:51:42.750Z (about 1 month ago)
- Topics: achievements, local-machine, obs, steam, steam-api, steam-stats
- Language: JavaScript
- Homepage:
- Size: 1.61 MB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Localhost-Steam-API
This project provides an easy way to access and use the Steam API on a local machine.
## Why?
I recently have been using Twitch to stream and wanted a way to track my Steam stats while I played. The problem was that there was no way to track these stats on screen with OBS. This project allows streamers to track Steam stats in a web browser on a Localhost server, which you can in turn access through OBS's web browser streaming settings.
## Installation & Usage
1. Copy the Localhost-Steam-API folder to your local machine.
2. Obtain a Steam Web API Key [HERE](https://steamcommunity.com/dev/apikey)
3. Edit lines 1 + 2 in the server.js file.
```javascript
const steamKey = ""; // Place your Steam API key in this variable as a string
const steamID = ""; // Place your Steam ID in this variable as a string
```
4. Navigate to Localhost-Steam-API folder in command prompt or terminal
5. Run `npm install`
6. Run `node server.js`
You can now open a browser and navigate to pages on the server
## Navigation
Currently there is only one implemented method from the Steam API
| Pages | Usage | Description |
| --------------------- | ------------- | ------------ |
| localhost:4000/ | Index | Copy of /:appid without data |
| localhost:4000/:appid | Replace ":appid" with ID of a steam game | Tracks amount of achievements in :appid |
## Tools Used
+ [Steam Web API](https://partner.steamgames.com/doc/webapi_overview)
+ [Node JS](https://nodejs.org/en/)
+ [EJS](http://ejs.co/)