Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/noowz/bsrpc

Discord Rich Presence that shows on your profile your Brawl Stars statistics.
https://github.com/noowz/bsrpc

brawl-stars brawl-stars-api discord discord-js discordapp djs rich-presence rpc supercell supercell-brawl-stars

Last synced: 2 months ago
JSON representation

Discord Rich Presence that shows on your profile your Brawl Stars statistics.

Awesome Lists containing this project

README

        

![BSRPC](https://socialify.git.ci/noowz/BSRPC/image?description=1&forks=1&issues=1&language=1&name=1&owner=1&pattern=Solid&pulls=1&stargazers=1&theme=Auto)

---


About |
Preview |
Installation |
How to use |
Contribute |
License |
Disclaimer |

---

## **πŸ“™ About**

**BSRPC** is a Discord Rich Presence that shows on your profile your Brawl Stars statistics.

---

## **πŸ–ΌοΈ Preview**

![Discord RPC](https://i.imgur.com/mKPDkoU.png)

---

## **βš’οΈ Installation**

1. Download [Node.js](https://nodejs.org/en/download/prebuilt-installer).
2. Download [BSRPC](https://github.com/noowz/BSRPC/releases/latest).

---

## **πŸš€ How to use**

1. Open **Brawl Stars** and follow the steps to get your player tag:

![Brawl Stars Player Tag](https://i.imgur.com/wnNhtJW.gif)

2. Go to the `config.json` file and replace **YOUR PLAYER TAG** with your Brawl Stars player tag.
3. Go to the [Brawl Stars API Dashboard](https://developer.brawlstars.com) and create an account or log in to your account.
4. Create a [new API key](https://developer.brawlstars.com/#/new-key). You will need to allow your IP Address. To find out your IP Address, [click here](https://nordvpn.com/what-is-my-ip).
5. Go to the `config.json` file and replace **YOUR API KEY** with your API key.
6. Open the Terminal and go to the folder where you saved the files with the `cd` command.
7. Install all the required dependencies:

```cmd
npm install
```

8. Run the RPC:

```cmd
node .
```

---

## πŸ› **Contribute**

If you have a bug or an idea, browse the open [issues](https://github.com/noowz/BSRPC/issues) before opening a new one.

If you know how to fix an [issue](https://github.com/noowz/BSRPC/issues), consider opening a [pull request](https://github.com/noowz/BSRPC/pulls) for it.

---

## πŸ“ **License**

This project is licensed under the [MIT](./LICENSE) license.

---

## πŸ“Œ **Disclaimer**

> This material is unofficial and is not endorsed by Supercell. For more information see Supercell's Fan Content Policy: [Supercell’s Fan Content Policy](https://supercell.com/fan-content-policy).