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 ## Table of Contents
- [Setup](#setup) - [Setup](#setup)
- [Downloading the repository](#downloading-the-repository)
- [Discord Setup](#discord-setup) - [Discord Setup](#discord-setup)
- [Steam Setup](#steam-setup) - [Steam Setup](#steam-setup)
- [Running it](#running-it) - [Running it](#running-it)
@ -12,9 +13,16 @@ SteamRPC pulls your game and presence from Steam and puts it onto discord.
## Setup ## 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: In order for SteamRPC to run, you need to give it 2 environment variables. <br> Example:
```bash ```bash
CLIENT_ID=1234567890 STEAM_ID=12345678 node index.js CLIENT_ID=1234567890 STEAM_ID=12345678 node index.js
``` ```
Below you can find documentation for how to get the Discord Client ID and the Steam ID. Below you can find documentation for how to get the Discord Client ID and the Steam ID.
@ -65,5 +73,12 @@ There are also option environment variables:
- `UPDATE_TIME=[number of seconds to update]` - `UPDATE_TIME=[number of seconds to update]`
- **this HAS TO BE over 15 seconds** - **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 ## 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! 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