/stacks-discord-bot-1

Primary LanguageJavaScript

Stacks Discord Bot

Version 0.1

Description

A simple open source discord bot for the Stacks community and ecosystem.

Features

Commands

See below for a list of commands.

Install

  1. Follow the instructions to create a new Bot on Discord
  2. Clone the repository
  3. Rename .env.sample to .env
  4. Fill out .env with your Discord token
  5. Adjust botConfig.json as needed; see below
  6. Run npm install in the command line
  7. Run npm run dev or npm run start to start the bot.

Configuration

Make changes to botConfig.json as needed. Additional instructions in V1. Make changes to collectionConfig.json as needed. Additional instructions in V1.

Run Tests

TBD

Support & Documentation

Discord GitHub

Contributors

  • aazei
  • hz

Basic Commands

Admin

ban

  • name: 'ban',
  • aliases: ['ban'],
  • description: 'Bans a user from the server',
  • usage: 'ban ',
  • category: 'admin',
  • args: false,

dev

  • name: 'dev',
  • aliases: ['dev', 'inDev'],
  • description: 'Template for commands that are in development',
  • usage: 'dev',
  • category: 'admin',
  • args: false,

kick

  • name: 'kick',
  • aliases: ['kick'],
  • description: 'Kicks a user from the server',
  • usage: 'kick <user> <reason>',
  • category: 'admin',
  • args: false,

reload

  • name: 'reload',
  • alises: ['reload'],
  • description: 'Reloads a command',
  • usage: 'reload <command name>',
  • category: 'admin',
  • args: true,

stats

  • name: 'stats',
  • alises: ['stats'],
  • description: 'Gives some useful bot statistics',
  • usage: 'stats',
  • category: 'admin',
  • args: true

Collection

contract

  • name: 'contract',
  • aliases: ['contract, smartcontract'],
  • description: 'Get the smart contract details',
  • usage: '',
  • category: 'collection',
  • args: false,

get

  • name: 'get',
  • aliases: ['lookup', 'search', 'find'],
  • description: 'Get a specific NFT from the collection',
  • usage: 'get <nftID>',
  • category: 'collection',
  • args: true,

lastmint

  • name: lastmint
  • aliases: ['lastmint', 'last']
  • description: Get the last minted NFT in the collection
  • usage: lastmint
  • category: collection
  • args: false

total

  • name: 'total',
  • aliases: ['totalcount'],
  • description: 'Get the total count of tokens for the address',
  • usage: 'address',
  • category: 'collection',
  • args: true,

twitter

  • name: twitter
  • aliases: ['twitter']
  • description: Get the Twitter account for the collection
  • usage: twitter
  • category: collection
  • args: false

website

  • name: website
  • aliases: ['website']
  • description: Get the website for the collection
  • usage: website
  • category: collection
  • args: false

Market

floor

  • name: floor
  • aliases: ['floor', 'floor-price']
  • description: Get the current floor price of the collection
  • usage: floor
  • category: market
  • args: false

marketplace

  • name: marketplace
  • aliases: ['market', 'byz', 'byznation', 'stxnft']
  • description: Get the current floor price of the collection
  • usage: marketplace
  • category: market
  • args: false

stxprice

  • aliases: ['stxprice', 'stx-price']
  • description: Get the current price of STX in USD
  • usage: stxprice
  • category: market
  • args: false

Misc

help

  • name: help
  • aliases: ['commands']
  • description: List all commands of bot or info about a specific command.
  • usage: [command name]
  • category: general
  • args: false

ping

  • name: ping
  • aliases: ['ping']
  • description: Ping the bot
  • usage: ping
  • category: misc
  • args: false

Slash Commands

/help

/verify

/update