Skip to main content

Starter (TS)

Welcome to your fresh Robo.js project!

Build, deploy, and maintain your Discord activities with ease. With Robo.js as your guide, you'll experience a seamless, file-based setup, an integrated database, TypeScript support, and a multitude of plugin-powered skills to unlock along the way.

Ready to embark on this adventure?

Getting Started​

Create a project with this template, replacing <project-name> with your desired name:

Terminal
npx create-robo <project-name> --template discord-bots/starter-ts

Then navigate into your project directory:

Terminal
cd <project-name>

Run development mode:

Terminal
npm run dev

Development​

Creating a Slash Command is as easy as creating files.

Let's say you want a new /hello command. Just create a file in the /src/commands directory named hello.js and export a default function that returns something.

/src/commands/hello.js
export default (interaction) => {
	interaction.reply('Hello World!')
}

Code for a slash command

Your /hello command is now ready to use! Robo.js takes care of registration for you.

Pk using a slash command

Ever clicked on an avatar or message and seen an Apps section? Those are Context Commands!

Create a file file in /src/context/message named after the command. For example, Quote.js.

/src/context/message/Quote.js
export default (interaction, message) => {
	interaction.reply(`${message.author} said:\n\n> ${message.content}`)
}

Code for a context command

You can do the same for users under /src/context/user.

Quoting a message via context command

Debugging​

Discord Bots made with Robo.js come with a built-in Debugger.

Whenever your bot crashes in development mode, the debugger shows an interactive error message - all within Discord!

Built-in debugger showing an error

You even get /dev Subcommands for quick access to logs, system info, and more. Just set your test server's ID as an environment variable called DISCORD_GUILD_ID.

Client Configuration​

Robo.js manages your Discord.js Client instance. You may import client anywhere in your project.

// File: /src/commands/name.js
import { client } from 'robo.js'

export default () => {
	return `My name is ${client.user.username}`
}

Intents or other configurations can be set in the config/robo.mjs file.

// File: /config/robo.mjs
export default {
	clientOptions: {
		intents: ['Guilds', 'GuildMessages']
	}
	// ... other options
}

Robo Ecosystem​

By building with Robo.js, you gain access to a growing ecosystem of plugins, templates, and tools. Robo Plugins are special. They can add features with one command.

Terminal
npx robo add @robojs/ai @robojs/moderation

Plugins integrate seamlessly thanks to the Robo File Structure. What's more, anyone can create a plugin.

Hosting​

Hosting your project keeps it running 24/7. No need to keep your computer on at all times, or worry about your Internet connection.

You can host on any platform that supports Node.js, or run robo deploy to host on RoboPlay - a hosting platform optimized for Robo.js.

Terminal
npm run deploy

Learn More​