-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:Nick-NCSU/hpbot
- Loading branch information
Showing
4 changed files
with
115 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,49 @@ | ||
# hpbot | ||
Prefix: src! | ||
A Discord Bot to connect the Speedrun.com and Hypixel APIs. | ||
|
||
Uses MongoDB for a database to store the banlist and known runners. | ||
|
||
## Slash Commands | ||
Command|Description | ||
:-----:|:-----: | ||
/help|Shows a help message. | ||
/hypixel|Provides helpful links for Hypixel Speedruns. | ||
/link \<game>|Sends a link to the provided game. | ||
/categories \<game>|Shows the categories/variables for the provided game. | ||
/search \<keyword> (page)|Searches for games containing the keyword(s). | ||
/leaderboard \<game>|Provides a leaderboard for the given game. | ||
/verified \<user>|Provides the number of runs verified by the given user. | ||
/queuelength \<game>|Provides the number of unverified runs for the given game. | ||
/dream (simulations)|Simulates Dream\'s pearl and blaze rod odds. | ||
/ping|Provides bot response time. | ||
|
||
## Message Commands | ||
### src!banlist | ||
Command|Description | ||
:-----:|:-----: | ||
src!banlist list|Lists all accounts in the banlist. | ||
src!banlist add \<player>|Adds an account to the banlist. | ||
src!banlist remove \<player>|Removes an account from the banlist. | ||
src!banlist search \<player>|Searches for banned player and returns information regarding ban | ||
|
||
### src!runners | ||
Command|Description | ||
:-----:|:-----: | ||
src!runners list|Lists all accounts in the known runners. | ||
src!runners add \<player> \<src account>|Adds an account to the known runners. | ||
src!runners remove \<player>|Removes an account from the known runners. | ||
src!runners search \<player>|Searches for known and returns information account information. | ||
src!runners searchsrc \<src account>| Searches by src account and returns all associated accounts. | ||
|
||
### src!dream | ||
Command|Description | ||
:-----:|:-----: | ||
src!dream (simulations)|Same as slash command version. | ||
|
||
### src!check | ||
Command|Description | ||
:-----:|:-----: | ||
src!check (...account)|Checks a list of accounts for Hypixel friends/guild lists, banlist, and known runners list. | ||
|
||
## Credits | ||
* [Nick-NCSU](https://github.com/Nick-NCSU) Developer |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters