consolebot v0.0.2-third

consolebot is a wrapper for creating console bots and is easy which only has 3 steps!

Get started by installing the wrapper: npm install consolebot@latest!

Example code:

const cb = require('consolebot');

cb.createBot({
  name: 'TEST-BOT', // Replace 'TEST-BOT' with something else
  id: '<optional>' // If you want the bot to have an id, Replace '<optional>' with a random id or something like '1'.
});

Functions

chat

The chat function is used to let the bot chat in the console!

cb.chat('<message>'); // [TEST-BOT] <message>

updateName

The updateName function is used to change the name of the bot.

cb.updateName('TEST-BOT-2'); // [TEST-BOT-2] <message> (output of the chat function)

getId

The getId function is used to get the id of the bot.

If the id is '' in the { id } value of the createBot function then the output will show 'Not specified'

// <optional> output:
cb.getId(); // Not specified

// { id: 1 } output:
cb.getId(); // 1

getName

The getName function is used to get the name of the bot.

cb.getName(); // TEST-BOT

We don't think if the updateName function counts but we will experiment it:

cb.updateName('TEST-BOT-2');
cb.getName(); // TEST-BOT-2

Options

name

The name option is input for the bot name

{ name: <any> }

id

The id option is input for the bot id

{ id: <any>, '<optional>' }

color

The color option is input for the bot chat color name

{ color: colors.[blue, red, white, black] }

If section 2 do:

{ color: colors.s2.[reset] }

Also, to use our colors variable input this to your code:

const { colors } = require('consolebot');

Update

UPDATE (9/18/2022 4:59 PM): Updated to throw an error if the name option is undefined UPDATE (9/19/2022 11:11 AM): Made a new function 'getId' and 'getName'! UPDATE (9/19/2022 11:28 AM): Made a new option 'color' which changes the chat name color of the bot UPDATE (9/19/2022 11:35 AM): Fixed the 'Missing ) after argument list' error