Skip to content
This repository has been archived by the owner on Jan 1, 2022. It is now read-only.

raidensakura/watame

Repository files navigation

Watame Sheep

Watame Banner

Deploy GitHub Issues GitHub code size in bytes

A Discord bot I like to write during my free time. It was originally made for just one purpose: To ask quizzes to users, and then assign specific roles based on the answers, kind of like the sorting hat in Harry Potter.

Why watame

Because Tsunomaki Watame is just that cute and something Raiden liked when he started making this.

Please subscribe to her.

Watame

Requirements

  • git command line (Windows|Linux|MacOS) installed
  • node Version 14 or 16 required
  • The node-gyp build tools. This is a pre-requisite for Enmap, but also for a lot of other modules. See The Enmap Guide for details and requirements for your OS. Just follow what's in the tabbed block only, then come back here!

You also need your bot's token. This is obtained by creating an application in the Developer section of discord.com. Check the first section of this page for more info.

Intents

Watame uses intents which are required as of October 7, 2020. You can enable privileged intents in your bot page (the one you got your token from) under Privileged Gateway Intents.

By default Watame needs the Guilds, Guild Messages and Direct Messages intents to work. For join messages to work you need Guild Members, which is privileged. User counts that Watame has in places such as in the ready log, and the stats command may be incorrect without the Guild Members intent.

Intents are loaded from your config, and will get created by the setup scripts.

For more info about intents checkout the official Discord.js guide page and the official Discord docs page.

Downloading

In a command prompt in your projects folder (wherever that may be) run the following:

git clone https://github.com/raidensakura/watame.git

Once finished:

  • In the folder from where you ran the git command, run cd watame and then run npm install
  • If you get any error about python or msibuild.exe or binding, read the requirements section again!

Run node setup.js to generate a proper configuration file and settings.

Starting the bot

To start the bot, in the command prompt, run the following command: node index.js

Inviting to a guild

To add the bot to your guild, you have to get an oauth link for it.

You can use this site to help you generate a full OAuth Link, which includes a calculator for the permissions: https://finitereality.github.io/permissions-calculator/?v=0