lbry-wunderbot/README.md
Fillerino 6ce8aade5b Fixed formating and added prettier to pre-commit.
Fixed the formatting, added prettier to auto run on pre-commit.
2017-11-07 18:25:05 +01:00

1.5 KiB

Bot for LBRY's Discord

(This README will be updated along with bot updates)

Features:

  • Tipbot for LBC. Responds to !tip.

  • Price bot displays price of lbc for currency given. Responds to !price <cur> <amount>

  • Stats bot display current market stats of lbc. Responds to !stats

  • Hash bot displays current hashrate of network. Responds to !hash

  • Github Release Notes bot displays release notes for current lbry-app release.

    Responds to !releasenotes User with Defined Perms !releasenotes post to send to specified channel

  • Purge Bot (moderator only) deletes X amount of messages. User with Defined Perms Responds to !purge <X>

  • Speech bot displays top claim from provided image name(coming soon posting to speech).

    Responds to !speech <imagename>

  • Welcome bot sends Direct Message when new users join, User with Defined Perms can send using !welcome <@username>

  • Spam Detection Bot to Prevent Discord Raids and Spammers

  • Dynamic plugin loading with permission support.

Requirements

  • node > 8.0.0
  • npm > 0.12.x
  • yarn ( install with npm install -g yarn if not installed )

Installation

Create a bot and get the bot's API Token: https://discordapp.com/developers/applications/me

Edit and rename default.json.example in /config, then cd to wunderbot directory and run:

yarn install
node bot/bot.js

Development

Be sure to run the command below before working on any code, this ensures prettier goes to work and keeps code to our standard.

yarn install --production=false