A discord bot designed to alert users of important cryptocurrency movements and events.
Report Bug
·
Request Feature
Table of Contents
There are a plethora of discord bots available for users with a simple Google search, however it was difficult for me to find any that suited my needs so I decided to create my own. I needed a bot that could at the most basic level, alert users of important cryptocurrency movements and events.
Here's why:
- I wanted to familiarize myself with the Twitter and CoinGecko APIs
- I wanted to learn how to build my own discord bot
- I wanted to create a bot that directly suited my needs
This project is still currently in its early stages so some features may change or be removed depending on how useful I find them after extended use.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
A couple of things youll need before you can have Narwhal up and running:
- A Discord API access token & Application
- A Discord account & Discord Server you have administrative access to
- A Twitter API access token
(Coming soon... 😄)
All commands begin with the default "$" prefix, however this can be changed. For example:
$somecommand arg1 arg2 ...argCommand documentation is as follows:
$somecommand - A very cool description.
- arg1 - arg1 description
- arg2 - arg2 description
- arg3 - arg3 description
Commands:
$ping - A simple ping command to check if services are online and responding properly.
- coingecko - Checks to see if CoinGecko API services are online.
$bind - Allows a user to change the discord text channel that Narwhal is bound to.
- check - Checks to see if bot is bound to a channel.
- #[channel] - Binds the bot to channel mentioned.
$narwhalPrefix - Allows a user to change the prefix for Narwhal. Default is $.
- [new_prefix] - Adds [new_prefix] as the new prefix.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.