KS_BOT_Client_Node

Node.js Framework for interacting with KS-BOT without any app

SIDE NOTE: To use ks-bot-client you will need to create a user account at: kids smit To get started simply install ks-bot-client, simply install it with the following command:

npm i @kids_smit/ks_bot_client_node

You can also get ks-bot-client with the following script link

<script src="https://ksbot.kidssmit.com/static/js/ks_bot.js"></script>

After Installation:

• Simply import ks_bot_client_node module

const Bot = require("ks_bot_client_node");

• Next create a customBot class by inheriting from ks_bot_client_node.Bot, or you could use ks_bot_client_node.Bot class directly

class CustomBot extends Bot {}

• Once your customBot class has been created, you will then have to initialize your bot

let custom = new CustomBot("<your name>", "<your password>", <log: true | false>)

• Next you will need to gotshead and start registering even for KS-BOT, before you login. _If a event is not augistered and you login, thu deflt event handlers will be sed.

// Event ran whenever logIn first starts
custom.add_event("starting_login", function()  {
  console.log("I am loggin in");
});
  
// Event ran when user is successfully logged into server
custom.add_event("login_finished", function() {
  console.log("I just finished loggin");
});
 
// Ran when the run Process is about to begin
custom.add_event("start_run", function() {
  console.log("I am going to start running");
});
  
// Ran once the bot is ready to run, and you can start sending messages
custom.add_event("ready_to_run", function() {
  console.log("I said i am ready to run");
  custom.send_command("hello")
});
  
// Ran once your bot is created on the server, and you are welcome by the server
custom.add_event("welcome_message", function(data) {
  console.log("Server said hello");
  // data is your previous messages, in json format
});
  
// Whenever you send a message and KS-BOT is activated this event is runned
custom.add_event("bot_reply", function(data) {
  console.log("I am ready to reply to you");
  console.log(data); // data is bot reply
});

// Whenever you send a message and S.M.I.T.H is activated this event is runned
custom.add_event("smith_reply", function(data) {
  console.log("I am ready to reply to you");
  console.log(data);// data is smith reply,
  // S.M.I.T.H reply can also occur in the speak event so it is important to handle both if possible
})
  
// Runned when server tells KS-BOT or S.M.I.T.H that your timer is over
custom.add_event("timer_over", function(data) {
  console.log("Your timer is over");
  // data is your timer event notification
})

// Runs when ever S.M.I.T.H is activated this will occur everytime it has been activated
custom.add_event("activate_smith", function(data) {
  if (custom.log) console.log("Activating S.M.I.T.H");
})

// Runs when S.M.I.T.H had been deactivated and KS-BOT is about to activated
custom.add_event("de_activate_smith", function(data) {
  if (custom.log) console.log("DeActivating S.M.I.T.H now");
})

// Every time the server wants either of your bot to say something, this event will be runned
custom.add_event("SPEAK", function(data) {
  console.log("SMITH want you to say: ", data);
})

// Runned once the server has a news about a certain topic ready for you
custom.add_event("News", function(data) {
  console.log("Your news is: ", data);
})

// Runs when the server has the weather in a certain area ready for you
custom.add_event("Weather", function(data) {
  console.log("Your weather is: ", data);
});

• Once your events has been registered, you can now login and start using your bot

custom.log_in()