Update README.md
This commit is contained in:
parent
8898714c62
commit
fd44ee249b
1 changed files with 11 additions and 8 deletions
19
README.md
19
README.md
|
@ -19,10 +19,12 @@ git clone https://codeberg.org/Bingus_Violet/SteamRPC
|
||||||
cd 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 provide it with a Steam ID. There are 2 ways to do this, the first is through environment variables.
|
||||||
|
<br> Example:
|
||||||
```bash
|
```bash
|
||||||
STEAM_ID=12345678 node index.js
|
STEAM_ID=12345678 node index.js
|
||||||
```
|
```
|
||||||
|
Alternatively, running SteamRPC without providing an ID through an environment variable will make it prompt you for one.
|
||||||
|
|
||||||
Below you can find documentation for how to get your Steam ID.
|
Below you can find documentation for how to get your Steam ID.
|
||||||
|
|
||||||
|
@ -45,17 +47,17 @@ node index.js
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
There are also option environment variables:
|
Here is a concise list of all environment variables:
|
||||||
- `UPDATE_TIME=[number of seconds to update]`
|
- `UPDATE_TIME=[number of seconds to update]`
|
||||||
- **this HAS TO BE over 30 seconds**
|
- **this HAS TO BE over 30 seconds**
|
||||||
- `STEAM_ID=[your_steam_id]`
|
- `STEAM_ID=[your_steam_id]`
|
||||||
- Prevents the program from prompting you for your steam ID
|
- Prevents the program from prompting you for your steam ID
|
||||||
|
|
||||||
If everything is setup properly, it should look something like this!:<br>
|
If everything is setup properly, it should look something like this!:<br>
|
||||||
![Alt text](docs/examples/image.png)<br>
|
![Alt text](docs/examples/image.png)
|
||||||
![Alt text](docs/examples/image-1.png)<br>
|
![Alt text](docs/examples/image-1.png)
|
||||||
![Alt text](docs/examples/image-2.png)<br>
|
![Alt text](docs/examples/image-2.png)
|
||||||
![Alt text](docs/examples/image-3.png)<br>
|
![Alt text](docs/examples/image-3.png)
|
||||||
|
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
@ -65,6 +67,7 @@ This project was never meant to be public, but I decided there was no reason not
|
||||||
|
|
||||||
- [x] Pull images from steam directly
|
- [x] Pull images from steam directly
|
||||||
- [x] Show profile picture and username as small Image
|
- [x] Show profile picture and username as small Image
|
||||||
|
- [x] Hide when not playing a game
|
||||||
- [ ] Allow Steam Icon Overrides
|
- [ ] Allow Steam Icon Overrides
|
||||||
- [ ] Add config
|
- [ ] Add blacklist for certain games that have their own RPC
|
||||||
- [ ] Allow more configurable options
|
- [ ] Add config
|
Loading…
Reference in a new issue