This Discord-verified bot is used to fetch in-game player data by using the official [Clash of Clans API](https://developer.clashofclans.com/#/documentation). ClashStats Bot is still under testing and some features have yet to be implemented. Suggestions are encouraged!

## Commands

Currently, nine commands are able to be used.

### /verify

When ran, the bot will DM the user and prompt their in-game player tag and API token (also found in-game). This command allows the user's data to be saved to the database, and therefore, the user will be able to run other commands. The experience with this bot is much better when the user has verified.

### /stats

When ran without verification, the bot requires a player tag argument to be entered after the command. 
```
/stats #GY2GJLCP
```
When ran, and the user has already been verified, no additional arguments are required.

<img src='https://res.cloudinary.com/clashstats/image/upload/c_mfit,h_500,w_500/v1640840697/readme/cocstats_jbbfow.png' width='500' height='500'/>

### /clan

This command requires user verification before use. If the user does not have a default clan saved, the user will need to input a clan tag: 
```
/clan #2PGJUGPR
```

At this point, the bot will prompt if the user would like to save the inputted clan tag as their default clan. If so, the next instance of `/clan` will not need a clan tag; instead, it will fetch the clan data from the saved clan tag: 
```
/clan
```

And if you're curious what metrics are shown, here are some images! 

<img src='https://res.cloudinary.com/clashstats/image/upload/c_mfit,h_284,w_500/v1640840697/readme/cocclan1_k61zxg.png' width="500" height="284" /> 
<img src='https://res.cloudinary.com/clashstats/image/upload/c_mfit,h_592,w_500/v1640840699/readme/cocclan2_aywfyq.png' width='500' height='592' />

### /graph

This command requires user verification before use. The user's saved trophy data will be plotted (via matplotlib) on a line graph. New data can only be saved once daily, but the graph can be seen as many times as prompted. 

<img src='https://res.cloudinary.com/clashstats/image/upload/c_scale,h_441,w_500/v1640840698/readme/cocgraph_irhmss.png' width='500' height='441' />

### /hero

This command requires verification before use. Lists your hero levels. Tells how far you are from maxed hero levels at your Town Hall level.

<img src='https://res.cloudinary.com/clashstats/image/upload/c_mfit,h_541,w_500/v1640840698/readme/cochero_uw5vcu.png' width='500' height='541' />

### /zap

Tells the player how many lightning spells are required to destroy an air defense.
This command requires two parameters: the air defense level and your lightning spell level. 
```
/zap [air defense level] [lightning spell level]
```

### /zapquake

Tells the player how many lightning spells and earthquake spells are required to destroy an air defense.
This command requires three parameters: the air defense level and a lightning spell level, and an earthquake spell level 
```
/zapquake [air defense level] [lightning spell level] [earthquake spell level]
```

### /invite

Fetches the permanent Discord invite link for ClashStats.

### /help

Sends the command list!

## Contribute & Support

Want to add the bot to your server? Use this [link](https://discord.com/api/oauth2/authorize?client_id=870085172136149002&permissions=2147544128&scope=bot)! Need more support? Join the support [server](https://discord.gg/6MXVXxK7pb) and ask me directly! Want to support? [Buy me a coffee!](https://www.buymeacoffee.com/danmaruchi)

ClashStats

A bot designed to optimize the player experience for Clash of Clans, one of the most popular, free, mobile games of all time.

Voting for ClashStats