Team Firetruck's COS 420 working repository for the VibeCheque Discord Bot. Also see the repository for the landing page.
- Download this repository, either using this ZIP or by running
git clone [email protected]:COS420-Fall24/VibeCheque.git
if git is installed. - If Node.js is installed, navigate to the repository's directory and run
npm install
. If Node.js is not installed, it can be downloaded here. - You'll need to set some environment variables for this bot to connect to the Discord API. If you don't know what these are, be sure to make a bot using the Discord Developer Portal. Fill out the details in
.env.example
and rename the file.env
.
Once the Installation Process is complete, run npm run registerCommands
to allow users to access the bot's commands. This task is only necessary once, unless a command has been added, removed, or its description/format has been changed. The console should print
> [email protected] registerCommands
> npm run build && node build/registerCommands.js
> [email protected] build
> npx tsc && npx tsc-alias
refreshing commands
reloaded commands
To run the bot, simply run npm start
and the following text should print to console:
> [email protected] start
> npm run build && node build/index.js
> [email protected] build
> npx tsc && npx tsc-alias
(node:1546482) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
(Use `node --trace-deprecation ...` to show where the warning was created)
client "ready": Logged in as VibeCheque#4991!