@smartcloudai/discord v0.0.3-beta.292

Discord

{% hint style="success" %}

I already use Discord Bot Maker, and want to switch!

As discord bot maker was built using a similar method of JSON structuring, we decided to build a direct conversion tool for users who already use DBM. Once you have installed SCAA, simply head over to our tutorial on how to convert! {% endhint %}

This "framework" (term used lightly) is developed to make creating discord bots extremely easy for end users and developers. Built on the Typescript coding platform, it features tools for ts, js and json creation of commands and events.

Even though this could be used as an framework for back-end developers, we have built it with the intention of front end editing and production. Everything you can create and make from the back-end can also be created using the SCAA web portal, WordPress plugin or API.

Please see the SCAA Core project for information regarding initial setup and installation of Smart Cloud Artificial Assistant if you intend to use all the features of this software.

JSON driven, what the *?

Yeah we know, that term is slightly confusing for most users. We are claiming this title under the understanding that Discord Bot Maker is an application and not a framework as it is limited on the ability to extend and has reduced functionality.

We have built this framework to be as simple to use while maintaining functionality for the end users. We have introduced unprecedented customisation into a system with extremely minimal effort to actually use. To prove how simple our system actually is, we have developed a command using JSON to build new JSON commands!

Obviously there is more to this than meets the eye, there is still a lot of Javascript involved, so we have build a handy selection of guides to get you started!

{% page-ref page="guides/" %}

Why use over other Discord.js Frameworks?

We don't expect everyone to just drop frameworks which already exist, that would seriously scare our team as we really ain't anywhere near ready for that level of responsibility. What we do want to do is make an impact, be seen as a serious tool for discord bots.

But JSON isn't capable of the customisation which others can using JavaScript....

This was one of the most scary things for us to hear from the community during the development of this framework, people doubting that customisation would be sufficient for complex discord bots. We really wanted to prove these doubters wrong.

So we created custom handlers with such depth, you can access any option using JSON without even having to think about the JavaScript behind it. Imagine the following command:

{
  "name": "demo",
  "alias": [],
  "version": "0.0.2",
  "description": "demo command",
  "helpInformation": "",
  "permissions": "none",
  "usage": "<action>",

  "args": true,
  "minargs": 0,
  "localargs": {
    "name": "smartcloud#0001",
    "local": 1
  },
  "guildOnly": true,
  "execute": [
      {"action": "demo", "options": {"vars": {"names": "*m0*&&*c1*||*m1*", "mentions": "*m1*", "returned": "+[savevar.3.var]+", "local": "[name]", "server": "<server>", "global": "{global}"}}, "typing": {"active": true, "mode": "channel"} },
      "pong"
  ]
}

The execute of this command is an array[] which is cycled through.

{% hint style="info" %} && is always passed before ||

This therefore means an option of "*m0*&&*c1*||*m1*&&<option>" would always return:

[ MentionedUser0 , (Channel1 or MentionedUser1) , ServerOption ] {% endhint %}

Module Installation

This module can be run as either part of Smartcloud Artificial Assistant, or as standalone framework for discord bots. Using our auto installer, it comes completely operational with default commands, events and actions.

From within the @smartcloud/cli user can choose to install, create and upload their own modules with actions, events and commands to our repository much like npm does, allowing for continuous grouth of the applications abilities without the hassle which is often involved when building customised applications.

Using our auto installer for SCAA operation

Running our auto installer is super easy and guides you through all the steps.

Simply install our command line interface using:

npm i -g @smartcloud/cli

Once installed, run the command

smartcloud install

You can read more about our installation options here:

{% page-ref page="installation.md" %}

Framework information

General

General details about the frameworks, such as versions.

†1 Written in typescript
†2 Without optional dependencies, functionality may be reduced

Command Parsing

Command parsing is how frameworks parse messages into commands.

Command Handling

Command handling refers to the behaviour of command execution and restrictions. It also includes the monitoring of and the inhibition of messages and commands. Subcommands are commands that are individual commands with the same base name.

Argument Parsing

Arguments are the data acquired and parsed from user input. This section compares how frameworks can match and parse input.

Prompting

Prompting is the ability to collect messages from the user without invoking a command directly.

Module System

The module system of a framework is how the framework structures its modules. This includes how new modules (e.g. commands) are created and loaded.

Events System

Events that are useful for a framework

Database System

Database support is listed here, alongside settings that can be changed for Discord.

†1 This is handled by requiring either separate module (read guide) or @smartcloud/core

Integrations

Database support is listed here, alongside settings that can be changed for Discord.

†1 This is handled by requiring either separate module (read guide) or @smartcloud/core