From fd44ee249bad9803687a66981321fc8c2bcd0686 Mon Sep 17 00:00:00 2001 From: Bingus_Violet Date: Fri, 15 Dec 2023 17:16:24 +0000 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 62ddb86..3fdd427 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,12 @@ git clone https://codeberg.org/Bingus_Violet/SteamRPC cd SteamRPC ``` -In order for SteamRPC to run, you need to give it 2 environment variables.
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. +
Example: ```bash 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. @@ -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]` - **this HAS TO BE over 30 seconds** - `STEAM_ID=[your_steam_id]` - Prevents the program from prompting you for your steam ID If everything is setup properly, it should look something like this!:
-![Alt text](docs/examples/image.png)
-![Alt text](docs/examples/image-1.png)
-![Alt text](docs/examples/image-2.png)
-![Alt text](docs/examples/image-3.png)
+![Alt text](docs/examples/image.png) +![Alt text](docs/examples/image-1.png) +![Alt text](docs/examples/image-2.png) +![Alt text](docs/examples/image-3.png) ## 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] Show profile picture and username as small Image +- [x] Hide when not playing a game - [ ] Allow Steam Icon Overrides -- [ ] Add config -- [ ] Allow more configurable options \ No newline at end of file +- [ ] Add blacklist for certain games that have their own RPC +- [ ] Add config \ No newline at end of file