SmartBot

Introduction

SmartBot is a versatile tool designed to enhance bot interaction and management, particularly for multi-language support. This guide focuses on setting up and initializing SmartBot for your projects, ensuring a smooth start for beginners in programming.

We have bot demo: BBDemoTaskBot - free available in the Store.

Setup

You need setup Lang File. Please read here

Creating an Instance of SmartBot

To use SmartBot, you first need to create an instance. This is typically done in the main bot file or where you handle your bot's logic.

Syntax:

let smartBot = new SmartBot(options);

You need to put this code:

• in BeforeAll command - "@"

• and create blank Master Command (because we need to track all commands we need blank "*" command)

Options:

• params: Initial parameters for the bot.

• defaultMarkdown: The default formatting style for messages (e.g., Markdown, HTML).

• skip_cmd_folders: Don't process commands in this folders (it can be "Setup", "Admin" folders for example)

• strict_params: Default - false. If true - error will be thrown if param not found but it is needed in Command's. It is good for debugging.

• debug: A boolean flag for enabling debugging. Default: false.

Example:

let smartBot = new SmartBot({
  params: {
    balance: 0,
    name: user.first_name
  }
});

Handling Commands

SmartBot manages commands based on the language file. Use the handle method to process incoming commands and generate appropriate responses.

Example:

Prefer to use after all command "@@":

// command "@@"
smartBot.handle();

You can make "return" in command and "@@"-command will be not run. It can be helpful in some case.

Adding Params

One of SmartBot's key features is its ability to handle dynamic content through variables.

Use the add method to include dynamic content in responses:

smartBot.add({ username: user.name, balance: user.balance });

// or it can be "set" method
// but with this method all another props will be deleted
// smartBot.set({ username: user.name, balance: user.balance });

So we can use username and balance props for command in Lang File now:

...
// "/balance" commands
"/balance": {
   text: "Hello, {username}. Your balance: {balance}"
}
...

Params from options after SmartBot.run (or Bot.run) - are added automatically

Running other Command

Use the run method to execute another command within a command:

smartBot.run({
  command: "/anotherCommand"
});

// if you want edit mode:
smartBot.run({
  command: "/anotherCommand edit"
});

It is same method like Bot.run but current options will be passed automatically

is Alias method

let isAlias = smartBot.isAlias(message);

if(isAlias){
  // for example we can have alias "Cancel", "Exit" on button
  // so we just make exit from command
  return
}

// other code

Filling Content

The fill method replaces all vars like "{data}" in text with actual variable values:

let response = smartBot.fill("Hello, {username}, your balance is {balance}");

As a rule, there is no need to use this method - everything should happen automatically

You can use titles from Lang file like:

smartBot.fill(smartBot.params.YOUR_KEY_FROM_TITLES) It is possible because title was added as param

Change language for user

You can change language for user via this code:

// change user language to "en"
smartBot.setUserLang("en");
// or to "fr"
smartBot.setUserLang("fr");

// get current user language:
let lngCode = smartBot.getUserLang(); // it will be "fr" here

You can define translation. Read about this here.

Debugging

If debug is set to true, SmartBot will provide detailed error messages, which is helpful for troubleshooting and ensuring your bot behaves as expected.

Best Practices

• Keep Language Files Updated: Regularly update your language files to reflect changes in your bot's functionality.

• Test Thoroughly: Always test your bot for various scenarios, especially after adding new features or making changes.

• Handle Errors Gracefully: Ensure that your bot handles errors smoothly and provides helpful feedback to users.

Conclusion

Setting up and initializing SmartBot is a straightforward process. By carefully configuring your language files and utilizing the robust features of SmartBot, you can create an interactive and user-friendly bot experience. Remember to test extensively and update your language files as your bot evolves.