more docs

This commit is contained in:
Bingus_Violet 2023-11-22 12:23:34 -06:00
parent 4ab23270ff
commit bf532102f2
5 changed files with 16 additions and 1 deletions

View file

@ -4,6 +4,7 @@ SteamRPC pulls your game and presence from Steam and puts it onto discord.
## Table of Contents
- [Setup](#setup)
- [Downloading the repository](#downloading-the-repository)
- [Discord Setup](#discord-setup)
- [Steam Setup](#steam-setup)
- [Running it](#running-it)
@ -12,6 +13,13 @@ SteamRPC pulls your game and presence from Steam and puts it onto discord.
## Setup
### Downloading the repository
Simply run:
```bash
git clone https://codeberg.org/Bingus_Violet/SteamRPC
cd SteamRPC
```
In order for SteamRPC to run, you need to give it 2 environment variables. <br> Example:
```bash
CLIENT_ID=1234567890 STEAM_ID=12345678 node index.js
@ -65,5 +73,12 @@ There are also option environment variables:
- `UPDATE_TIME=[number of seconds to update]`
- **this HAS TO BE over 15 seconds**
If everything is setup properly, it should look something like this!:<br>
![Alt text](docs/examples/image.png)<br>
![Alt text](docs/examples/image-1.png)<br>
![Alt text](docs/examples/image-2.png)<br>
![Alt text](docs/examples/image-3.png)<br>
## 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!

BIN
docs/examples/image-1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

BIN
docs/examples/image-2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

BIN
docs/examples/image-3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

BIN
docs/examples/image.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB