Package Exports

@roboplay/robo.js
@roboplay/robo.js/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@roboplay/robo.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Robo

Robo is a lightweight, supercharged Node.js metaframework for Discord.js, designed to make building Discord bots a breeze. It features a powerful plugin architecture and streamlined interaction handling with Sage, all while allowing full access to the underlying Discord.js features.

Note: This is a pre-release and is likely to undergo breaking changes before reaching version 1.0.

Installation

npm install @roboplay/robo.js

Getting Started

Check out the three example projects included in the GitHub repo to help you get started:

Features

Effortless command and event generation: Create .ts or .js files in the relevant directories.
Sage: A built-in mechanism for streamlined interaction handling.
Plugins: Install npm packages and configure them in your project to extend your bot's functionality.
CLI: Includes commands like doctor, invite, and deploy for convenient bot management and deployment.
RoboPlay integration: Host your Robo-powered bots on the RoboPlay service, with both free and paid tiers available.

Command Handling

With Robo's file-based structure, creating commands is a breeze. For example, to create a /ping command, follow this structure:

/src
  /commands
    ping.js

Creating the ping.js file is a breeze, requiring only a few lines:

export default () => {
    return 'Pong!'
}

You can further customize the command by exporting a config object:

export const config = {
    description: 'Replies with Pong!'
}

export default () => {
    return 'Pong!'
}

Event Listening

Event listening works similarly to command handling by using a file-based structure. For example, to create a ready event listener:

/src
  /events
    ready.js

Crafting the ready.js file is a piece of cake, requiring only a minimal number of lines:

export default () => {
    // This event will run if the bot starts, and logs in, successfully.
}

To register multiple listeners for the same event, use directories instead of files:

/src
  /events
    /ready
      one.js
      example.js

The file names can be anything you want, but we recommend using descriptive names.

CLI

The built-in CLI features the following commands:

dev: Run your bot in development mode.
build: Build your bot for production.
start: Start your bot.
doctor: Verify that your project is set up correctly.
invite: Generate URLs to add your Robo to servers (in beta).
deploy: Host your bot on RoboPlay for free.

Configuration

Robo supports configuration through a configuration file, allowing you to enable or disable features like Sage, set up permissions and intents, and configure installed plugins.

// @ts-check

/**
 * @type {import('@roboplay/robo.js').Config}
 **/
export default {
    intents: ['Guilds', 'GuildMessages', 'MessageContent']
}

License

MIT License