<center>![checky.png](https://ipfs.busy.org/ipfs/QmNmtCVakcrDMvoLFD3gF6voGy5Hor4LL6A8o23q9mgYQD)</center>
<center><a href="https://github.com/RagePeanut/checky"><strong>Click here to get redirected to the GitHub repository of this project.</strong></a></center>

<div class="text-justify">Ever since my arrival on <strong>Steem</strong>, I have noticed that many authors fail to write other steemians' usernames correctly. I remember being mentioned as @parragepeanut more than once in the past, luckily it was by an author that I follow so it didn't make much difference. However, it becomes an issue when authors mention other users that don't follow them in their posts. Let's take a hypothetical case in which A is the author of a post, R  is someone reading that post and M is the user mentioned in that post. If A fails to mention M correctly, M won't have any way of knowing that he got mentioned but also R won't have any way to access M's account through the post. That's where @checky comes in handy ! @checky's only purpose is to check if the steemians mentioned in a post exist and, if not, to indicate to authors that they may have made some typos while mentioning those steemians. It achieves that by analyzing all the new posts posted on the blockchain and by leaving a comment under the posts containing wrong mentions. Here is an example of what you may see under your post if you happen to wrongly mention someone (as you can see it also works with comments if you set the bot to advanced, more on that later).</div>

https://i.gyazo.com/c2ef80bfb414bbb6ff2341a1e0d4e0c3.png
<div class="text-justify">If there is one thing that I've learned from following the activity of @grammarnazi (an amazing bot that is really underappreciated), it's that some users just don't like bots trying to help them. Some steemians even go as far as flagging those kinds of bots. Because of that, I've seen @grammarnazi go all the way down to a reputation of 9 despite trying to help authors with their posts. In order to prevent such a scenario from happening with @checky, I've added some commands to the bot including <code>!mode off</code> which requests @checky to stop analyzing your posts. Let's get more in depth with the commands available in order to change @checky's behavior when encountering your posts. Those commands have to be written as replies to @checky's posts or comments, otherwise they won't work. Since I've mentioned @parragepeanut in this post, it should reply in the comments below so feel free to play around with it !</div>

* **!help** **-** gives a list of commands and their explanations.
* **!ignore** *username1* *username2* **-** tells  the bot to ignore some usernames mentioned in your posts (useful to avoid the bot mistaking other social network accounts for **Steem** accounts).
* **!mode** *[regular-advanced-off]* **-** sets the mentions checking to regular (only posts), advanced (posts and comments) or off (no checking). Alternatively, you can write *normal* or *on* instead of *regular*. You can also write *plus* instead of *advanced*.
* **!state** **-** gives the state of your account (*regular*, *advanced* or *off*) and a list of the usernames you told it to ignore.
* **!switch** *[regular-advanced-off]* **-** same as **!mode**.
* **!unignore** *username1* *username2* **-** tells the bot to unignore some usernames mentioned in your posts.
___
## What's coming next ?
* **A support for all the posts:** the bot only works with posts from apps setting the *users* array right now.
* **A support for some languages:** the bot could detect a post's language and write its comment in that language if supported. At first it will just be made into a language setting though.
* **Ignoring end of posts behaviors:** some users write their username differently on purpose at the end of a post (for example @multiple-words would become @multiple), @checky shouldn't treat that as a wrong mention.
* **Any idea ?** Make sure to tell me what you've got in mind by commenting this post !

___
## Contributions
<div class="text-justify">If you want to contribute to this project or talk about an issue it has, feel free to visit <a href="https://github.com/RagePeanut/checky">its <strong>GitHub</strong> page</a>. You can also clone it and follow the instructions written there to get it running (although not recommended since @checky already runs the script). My social medias are listed at the end of the <em>README</em> file. If you add me on <strong>Steam</strong>, tell me the reason why on my wall, otherwise I won't accept your friend request.</div>

___
#### Technology Stack
<div class="text-justify">@checky is written in <strong>JavaScript</strong> using <strong>Node.js</strong>. <strong>Steem.js</strong> is used in order to stream and interact with the blockchain. @checky also uses <strong>fs</strong> (which is installed by default with <strong>Node.js</strong>) to manage files and <strong>Lodash</strong> to make array manipulations easier.</div>

___
#### Proof of Work Done
https://github.com/RagePeanut/