Basic Usage

Set Up a TypeScript Project

First, set up a new TypeScript project. You can follow the official TypeScript Handbook for detailed instructions on how to get started.

Install the Package

Let's start by adding Carbon to your project:

npm install @buape/carbon

pnpm add @buape/carbon

yarn add @buape/carbon

bun add @buape/carbon

Create a Client

Next, create a new client instance by importing the Client class from the @buape/carbon package. The client requires a configuration object with your bot's credentials and an array of commands to register.

import { Client } from "@buape/carbon";

const client = new Client({
	baseUrl: process.env.BASE_URL,
	deploySecret: process.env.DEPLOY_SECRET,
	clientId: process.env.DISCORD_CLIENT_ID,
	publicKey: process.env.DISCORD_PUBLIC_KEY,
	token: process.env.DISCORD_TOKEN,
}, [])

Create a Command

Now we'll create a simple command that responds with "Hello!" when invoked. This command will serve as a basic example to demonstrate how to set up and handle interactions with your bot.

import { Command, type CommandInteraction } from "@buape/carbon";

export default class HelloCommand extends Command {
	name = "hello";
	description = "Say hello to the bot";

	async run(interaction: CommandInteraction) {
		await interaction.reply("Hello!");
	}
}

Then, mount the command to your client to make it available for use. This step involves importing the command and adding it to the client's configuration.

import HelloCommand from './commands/hello'

const client = new Client(
	{ ... },
	[new HelloCommand()]
)

Use an Adapter

You'll now need to set up an adapter to wrap your handle function to work with your runtime, pick an adapter from the list below to continue.