Skip to content

Commit

Permalink
update readme and bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
PoloLacoste committed May 10, 2022
1 parent 97eb655 commit 52d18ef
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 19 deletions.
44 changes: 26 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Create a `.env` file
EMAIL=[Rainbow six siege account email]
PASSWORD=[Rainbow six siege account password]
TOKEN=[Discord bot token]
CLIENT_ID=[Discord bot application id]
GUILD_ID=[Discord server id]
```
**Optional**
```ini
Expand Down Expand Up @@ -80,7 +82,8 @@ You can choose between two different docker files
Then you can run the docker container :

```docker
docker run r6-discord-bot -e EMAIL=[YOUR_EMAIL] -e PASSWORD=[YOUR_PASSWORD] -e TOKEN=[DISCORD_BOT_TOKEN]
docker run r6-discord-bot -e EMAIL=[YOUR_EMAIL] -e PASSWORD=[YOUR_PASSWORD] \
-e TOKEN=[DISCORD_BOT_TOKEN] -e CLIENT_ID=[APPLICATION_CLIENT_ID] -e GUILD_ID=[SERVER_ID]
```

With docker compose :
Expand All @@ -91,76 +94,80 @@ docker-compose up

## ⌨️ Bot commands

### !setLink
### /link

**Subcommands:**

#### set

This command will link your discord account id with your Rainbow Six Siege username.

Example :

```
!setLink Godly
/link set Godly
```

### !getLink
#### get

This command will return the current Rainbow Six Siege username linked to your discord account id.

Example :

```
!getLink
/link get
```

### πŸ†” !id
### πŸ†” /id

This command get your unique Rainbow Six Siege player id.

Example :

```
!id
/id
```

Optional arguments :

- platform : To specify the platform the account is on (default `uplay`, `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network))

### ⭐ !level
### ⭐ /level

This command will return your current level & lootbox drop chance percentage.

Example :

```
!level
/level
```

Optional arguments :

- platform : To specify the platform the account is on (default `uplay`, `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network))

### ⌚ !playtime
### ⌚ /playtime

This command will return your general, casual, ranked and discovery playtime.

Example :

```
!playtime
/playtime
```

Optional arguments :

- platform : To specify the platform the account is on (default `uplay`, `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network))

### πŸ† !rank
### πŸ† /rank

This command will return analytics of the current season.

Example :

```
!rank
/rank
```

Optional arguments :
Expand All @@ -176,31 +183,32 @@ Seasons reference :
12: 'Wind Bastion', 13: 'Burnt Horizon', 14: 'Phantom Sight',
15: 'Ember Rise', 16: 'Shifting Tides', 17: 'Void Edge',
18: 'Steel Wave', 19: 'Shadow Legacy', 20: 'Neon Dawn',
21: 'Crimson Heist', 22: 'North Star', 23: 'Crystal Guard'
21: 'Crimson Heist', 22: 'North Star', 23: 'Crystal Guard',
24: 'High Calibre', 25: 'Demon Veil'
```

### πŸ“Š !stats
### πŸ“Š /stats

This command will return some general analytics of your account (kills, deaths, wins, losses, ...).

Example :

```
!stats
/stats
```

Optional arguments :

- platform : To specify the platform the account is on (default `uplay`, `uplay` (pc), `xbl` (Xbox Live) or `psn` (PlayStation Network))

### 🟒 !status
### 🟒 /status

This command will return the status of all the servers.

Example :

```
!status
/status
```

## 🌟 You are all set! You have a problem ? Please open an issue
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "r6-discord-bot",
"version": "1.6.0",
"version": "1.7.0",
"description": "Rainbow Six Siege Discord bot",
"main": "src/index.ts",
"scripts": {
Expand Down

0 comments on commit 52d18ef

Please sign in to comment.