This commit is contained in:
Bingus_Violet 2023-11-22 12:06:23 -06:00
parent f638f6e9d7
commit 3ec5c3c641

View file

@ -6,6 +6,7 @@ SteamRPC pulls your game and presence from Steam and puts it onto discord.
- [Setup](#setup)
- [Discord Setup](#discord-setup)
- [Steam Setup](#steam-setup)
- [Running it](#running-it)
- [Customization](#customization)
- [Notes](#notes)
@ -54,5 +55,15 @@ And your done!
Here is an example of my current setup:
![A photo of my setup, with Gunfire Reborn and Risk of rain 2. The Gunfire Reborn is simply named "gunfirereborn" and Risk of Rain 2 is named "riskofrain2"](docs/images/setupExample.png)
### Running it
Lastly, all you need to do, is open a terminal and run
```
CLIENT_ID=[your discord client ID] STEAM_ID=[your steam id] node index.js
```
There are also option environment variables:
- `UPDATE_TIME=[number of seconds to update]`
- **this HAS TO BE over 15 seconds**
## Notes
This project was never meant to be public, but I decided there was no reason not to. Please do report any problems you encounter, and if there are any issues with the documentation, please let me know!