About

bloxified.js is a powerful Node.js module that allows you to easily interact with the Bloxified API.

Installation

Node.js 16.6.0 or newer is required.

npm install bloxified.js

Example usage

Register a basic bot with a command handler:

-- index.ts

import { readdirSync } from "fs";

import { Client, MessageObject, InteractionListener, ReadyListener } from "bloxified.js";

const client = new Client(
  "botuid",
  "http://sdk.m.pipedream.net/pipelines/p_mkCDA2P/sse"
);

client.init();

let globalAliases: any = [];
let globalCommands: any = [];
let globalSlashCommands: any = [];

readdirSync("./commands/").forEach(async (dir) => {
  // Filter so we only have .js command files
  const commands = readdirSync(`./commands/${dir}/`).filter((file) =>
    file.endsWith(".ts")
  );

  for (let file of commands) {
    var pull = require(`./commands/${dir}/${file}`);

    if (pull.name) {
      globalCommands.push(pull);
    } else {
      continue;
    }

    if (pull.aliases && Array.isArray(pull.aliases))
      pull.aliases.forEach((alias: string) =>
        globalAliases.push({ alias: pull.name })
      );
  }
});

let prefix = "/";

const readyHandler = async function (client: Client) {
  const guilds = await client.guilds.fetch();
  const users = await client.users.fetch();

  console.log(`Logged into bot with UID "${client.uid}" /--/ Guilds: ${guilds.length} /--/ Users: ${users.length}`)
}

const interactionHandler = async function (client: Client, data: MessageObject) {
  if (data) {
    const json = data.data;

    if (data.type == "text") {
      if (json.text.startsWith(prefix)) {
        const command = json.text.split(prefix).pop();

        console.log(command);

        globalCommands.forEach((pull: any) => {
          if (pull.name == command) {
            pull.run(client, data);
          } else {
            globalAliases.forEach((alias: any) => {
              if (alias == command) {
                if (pull.aliases.contains(alias)) {
                  pull.run(client, data);
                }
              }
            });
          }
        });
      }
    }
  }
};

const onReady = new ReadyListener(client, readyHandler);
const onInteraction = new InteractionListener(client, interactionHandler);

-- commands/info.ts

import { Client } from "bloxified.js";

module.exports = {
  name: "info",
  description: "bot info",
  aliases: ["i"],
  category: "General",
  run: async function (client: Client, message: any) {
    console.log("command run!");
    console.log(client);

    let text = `The info command.\n\nCan be used to get info about the bot API and debug stats.`;

    var sentMessage: any = await message.channel.send({
      text: text,
    });

    console.log(sentMessage);
  },
};

Pre-requisites (native module help)

We use a module named Enmap to keep this project on it's legs (message caching, to prevent bot spam) and so it's easier for users to interact with our API. Enmap requires for users to install Python (>=2.7), and the Visual Studio C++ Build Tools (>=2015) to build the module for your computer/runtime. More info here

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested to our developers via the Issues tab.

Happy coding!