Skip to content

Currently Maintained Version. You can find the original at the link in README

Notifications You must be signed in to change notification settings

Natemo2625/ConsoleChat

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Currently Maintained Version (rewriting soon, finally)

You may find the original version here.

ConsoleChat

Command-Line Chat Node Module for Discord.js Bots

Features:

  • Connect to and chat with any Discord server the bot is a member of via the command line
  • Send and receive text messages, including basic info for attachments and embeds
  • Basic command support (type /help to see a list of commands)
  • Supports emojis (:emoji_name:) and user tagging (by tag or nickname)
  • Colors user nicknames by role colors (as accurate as the console window allows)

Basic setup (in your main bot script):

const Discord = require('discord.js')
const client = new Discord.Client()
const consoleChat = require('./consoleChat.js')
...

client.on('ready', () => {
    ...
    consoleChat.startConsoleInput(client)
    ...
})

client.on('message', function(message) {
    consoleChat.onMessage(message)
    ...
})

client.login(YOUR_SECRET_TOKEN)
...

Anywhere you would use console.log(value):

...
consoleChat.println(value)
...

Useful functions:

  • consoleChat.setChannel(channel): Change the chat channel e.g. by command (takes a TextChannel object)
  • consoleChat.hidePrompt(): Hide the console prompt to print messages without interruption
  • consoleChat.showPrompt(): Restore from hidePrompt

Additional configuration functions:

  • consoleChat.setIgnoreBots(ignore): Whether to ignore bot messages (default: false)
  • consoleChat.setUseTimestamps(use): Whether to add timestamps to messages (default: true)
  • consoleChat.setUseBotBadges(use): Whether to display a blue 'BOT' badge next to bot names (default: true)
  • consoleChat.setStopFunction(function): Specify a function to run for the '/stop' command (default: process.exit())
  • consoleChat.setPromptPrefix(prefix): Specify a prompt prefix string (default: "> ")
  • consoleChat.setGamma(value): Set the gamma value for color calculations (default: 1.2)

Suggestions

Feel free to make a new issue with your suggestion and it may get added! (no template yet)

About

Currently Maintained Version. You can find the original at the link in README

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%