/cyberquincy

Cyber Quincy is the most popular btd6 discord bot. From providing infor on towers, heroes, rounds, maps, and calculating cash from rounds, and hero levelling. It also includes info for BTD6 Index

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

Cyber Quincy

CodeFactor PRs stars forks

Please give the repository a ⭐️!

Cyber Quincy is the most polished BTD6 discord bot from providing information on towers, hero, rounds, maps, as well as calculating cash from rounds and hero levelling. (and more)

Links

For help, simply use /help

Basic local test guide

note: all credentials will be in ./1/config.json (you need to create this file yourself), fill in the json accordingly (as per ./1/template.json).

  1. make a new discord bot in discord dev page, and copy the token into ./1/config.json as token.

  2. to register slash commands type node register

  3. to run type node server, or to run with sharding run node index

Project Info

  • this project uses CommonJS modules (no import or export, just require and module.exports)
  • there is now ESLint for this project - there is an .eslintrc.json linter file now which should hopefully enforce a somewhat consistent code standard
  • to use eslint to check for errors run npx eslint <file or directory>. Many text editors also have integration with eslint as well.

Project Information (Where do the numbers and stats come from)

  • Much of the data the bot uses is within the ./jsons folder
  • Tower Information are from Extreme Bloonology and their pastebins (Heroes and Towers)
  • This bot also uses the Official Ninja Kiwi API

Contributing Guidelines

  • try to use camelCase
  • don't use var to define variables. JS is weird enough
  • try not to do too much at once (for pull requests, split it into multiple PRs)
  • util functions/classes/modules should go to ./helpers (unless they are specific to only one command)
  • new data should go into ./jsons if to be stored locally. Small nuggets of information are usually displayed via the /tag command