comfydiscord/README.md

Comfiest Discord Bot Module for Coding Cafe

# ComfyDiscord
We built this Comfy Discord Bot Module live on Twitch for Coding Cafe!

**ComfyDiscord** lets you create a bot for your Discord server ***SUPER EASILY*** in just a few lines of code.

## Instafluff ##
> *Like these projects? The best way to support my open-source projects is by becoming a Comfy Sponsor on GitHub!*

> https://github.com/sponsors/instafluff

> *Come and hang out with us at the Comfiest Corner on Twitch!*

> https://twitch.tv/instafluff

## Instructions ##

#### Node
1. Install `comfydiscord`
```
npm install comfydiscord --save
```

2. Respond to !commands in your Discord
```javascript
require( "dotenv" ).config();

const ComfyDiscord = require( "comfydiscord" );
ComfyDiscord.onCommand = ( channel, user, command, message, flags ) => {
  if( command == "test" ) {
    console.log( "!test was typed in chat" );
  }
}
ComfyDiscord.Init( "MyDiscordBotToken" );
```

## Flags ##

Currently, the flags possible in `onCommand()` are:

- bot

## Reading Chat Messages ##

You can read chat messages by using the `onChat()` handler

```javascript
ComfyDiscord.onChat = ( channel, user, message, flags, extra ) => {
  console.log( channel, user, message );
}
```

## Sending Chat Messages ##

Sending Chat Messages can be done through `ComfyDiscord.Say( channel, message )`.

#### Securely adding your Discord token
1. Register a Discord App, Navigate to `Bot` in the Settings Menu on the page, and Get a Discord Bot Token - [https://discordapp.com/developers/applications/](https://discordapp.com/developers/applications/)
and Invite the Bot into your server using a link with your Bot's Client ID and permission scope [https://discordapp.com/oauth2/authorize?client_id=123mybotclientid123&scope=bot&permissions=133262656](https://discordapp.com/oauth2/authorize?client_id=123mybotclientid123&scope=bot&permissions=133262656)
2. Install `dotenv`
```
npm install dotenv --save
```
3. Create a file named `.env` that looks like this:
```javascript
DISCORDTOKEN=[DISCORD-BOT-TOKEN HERE] # e.g. DISCORDTOKEN=Fdkjher128764Da3B
```
4. Initialize with the Token
```javascript
require( "dotenv" ).config();

const ComfyDiscord = require( "comfydiscord" );
ComfyDiscord.onCommand = ( channel, user, command, message, flags ) => {
  if( command == "test" ) {
    ComfyDiscord.Say( "general", "replying to !test" );
  }
}
ComfyDiscord.Init( process.env.DISCORDTOKEN );
```

## All Supported Events ##

- **onCommand**`( channel, user, command, message, flags, extra )`

  Responds to "!" commands

  - **`channel`** (_string_) - Name of the Discord channel.
  - **`user`** (_string_) - Name of the message author.
  - **`command`** (_string_) - Name of the command used. The "!" is removed
  and is lower case.
  - **`message`** (_string_) - The message without the command.
  - **`flags`** (_MessageFlags_) - Basic flags about the user.
  - **`extra`** (_MessageExtras_) - Extra details from the message.

- **onChat**`( channel, user, message, flags, extra )`

  Responds to user chatting

  - **`channel`** (_string_) - Name of the Discord channel.
  - **`user`** (_string_) - Name of the message author.
  - **`message`** (_string_) - The message.
  - **`flags`** (_MessageFlags_) - Basic flags about the user.
  - **`extra`** (_MessageExtras_) - Extra details from the message.

### Types ###

- **`MessageFlags`** (_object_)

  Basic flags about the user.

  - **`bot`** (_boolean_) If the user is a bot account.

- **`MessageExtras`** (_object_)

  Extra details from the message.

  - **`id`** (_string_) - The message ID.
  - **`channelId`** (_string_) - The channel ID.
  - **`channel`** (_TextChannel | DMChannel | GroupDMChannel_) - Discord.js
  Channel.
  - **`userId`** (_string_) - Message author's ID.
  - **`username`** (_string_) - Message author's username.
  - **`userNumber`** (_string_) - Message author's username discriminator.
  - **`nickname`** (_string_) - Message author's nickname within the guild.
  - **`displayName`** (_string_) - Nickname or username with discriminator.
  - **`cleanContent`** (_string_) - The message contents with all mentions
  replaced by the equivalent text.

## Credits ##
Thank you too all the participants of this project!

**Gilokk0, ItsLittany, Instafluff, Instafriend, ChatTranslator, BillNash, MacabreMan, MsSaltyGiggles, That_MS_Gamer, DutchGamer46, sethorizer, TastyZero, jackconceprio, Amarogine, xRolo768, simrose4u, FlavCreations, i_am_from_mars, PhysoTronic, IAmThatOneJason, twallace123, superman1990skid, LilyHazel, Stay_Hydrated_Bot, atel0s, Docpinecone, Copperbeardy, losthewar, wietlol, caLLowCreation, JMSWRNR, BungalowGlow, theArtifacts, SausageCam, crazychick2019, morepizza308, TheHungerService, rockysenpai24, BellaTriXrbsa, where_is_laughingman, LatJorr, seniorkae, ReadyPlayerEmma, smilesandtea, merkurrz, CJnxd, primal_vertex, QuiiZyy, lewdmelon, MalForTheWin, itsboek, twitch_chat_is_stupid, iMrTnT, angel0O, ripSquidd, napkats, boki996, Clarkio, drowmander, JUBAN_3, Kyoslilmonster, ElysiaGriffin, tvgBadger, DareFutari, HonestDanGames, Dragonflytru_1, imJMB, rurutu, kazuhiko0, ichibadass, DurandalCraft, codeheir, shinageeexpress, JesusAcHe**