How do I create a Discord bot with Arikawa?

Start by importing the state package, setting up a command router using cmdroute, and connecting with your bot token. The bare minimum example in the README shows a bot that responds to /ping with minimal code.

Arikawa vs discordgo for Go Discord bots?

Arikawa offers better modularity and type safety with features like typed snowflakes, while discordgo is more monolithic and easier for quick starts. Choose Arikawa for complex, maintainable projects; discordgo for simpler bots.

How to handle slash commands in Arikawa?

Use the cmdroute package to define command handlers and call OverwriteCommands to register them with Discord. The commands-hybrid example demonstrates routing and executing interaction commands effectively.

Can I use Arikawa to cache messages for an undeleter bot?

Yes, Arikawa supports local or custom caches and PreHandlers to intercept delete events. The undeleter example caches messages in state to log deletions, showcasing this feature.

Is Arikawa good for self-botting or user accounts?

While it includes user account support via the ningen package, the library explicitly warns against self-botting as it violates Discord's ToS. It's designed for ethical bot development only.

How to implement custom caching with Redis in Arikawa?

Implement the cache interfaces provided in the state package, but the README doesn't detail Redis setup; you'll need to refer to Godoc for interface specifications and create your own implementation.

arikawa — Modular Discord Bot Framework

What is arikawa?

Arikawa is a comprehensive Go library and framework for the Discord API, designed to simplify the development of Discord bots and applications. It provides a structured, type-safe approach to interacting with Discord's features, emphasizing modularity and clear separation of concerns. The library helps developers build robust Discord bots with minimal boilerplate while adhering to Discord's best practices.

Target Audience

Go developers building Discord bots or applications who need a modular, type-safe library with clear abstractions and support for advanced features like custom caching and event interception. It is suitable for those implementing interaction-based bots as recommended by Discord.

Value Proposition

Developers choose Arikawa for its modular architecture with independent packages for API client, Websocket Gateway, and state management, allowing flexible integration. Its unique selling points include typed snowflakes to prevent ID misuse, extensible Gateway events for advanced use cases, and pluggable cache support for custom implementations like Redis.

A Golang library and framework for the Discord API.

Use Cases

Best For

Building Discord bots with a modular architecture where API client, Websocket Gateway, and state management are separated into independent packages.
Developing type-safe Discord applications using typed snowflakes to prevent accidental misuse of IDs (e.g., using a channel ID as a message ID).
Implementing advanced Gateway event interception for features like reading deleted messages or custom pre-handler logic.
Creating bots with pluggable caching systems, such as Redis, that automatically fall back to the API when needed.
Building interaction-based Discord bots that comply with Discord's recommendations, using examples like command routing and webhook APIs.
Developing applications that require clear separation of API and Gateway models to avoid confusion and improve code clarity.

Not Ideal For

Teams wanting an all-in-one Discord bot framework with built-in command parsing, middleware, and utilities out of the box
Developers prioritizing rapid prototyping over granular control and type safety
Projects where Go is not the primary language or where a simpler, script-like approach is preferred
Environments requiring extensive third-party plugins or a larger community ecosystem for support

Pros & Cons

Pros

Modular Architecture

Independent packages for API client, Websocket Gateway, and state management allow flexible integration and reduce bloat, as shown in the examples where components can be used separately.

Type-Safe Snowflakes

Strongly-typed IDs prevent common errors like using a channel ID as a message ID, enhancing code safety and reliability, which is highlighted in the library's key features.

Extensible Gateway Events

PreHandlers and event interception enable advanced use cases such as reading deleted messages, demonstrated in the undeleter example with local state caching.

Pluggable Caching

Supports custom cache implementations like Redis with automatic API fallback, improving performance and scalability, though implementation details require custom work.

Cons

Complex Initial Configuration

Modular design requires assembling components like state, router, and cache separately, increasing boilerplate for simple bots compared to more opinionated frameworks.

Limited High-Level Abstractions

Focuses on low-level control, so features like automatic command registration or built-in middleware are absent, forcing developers to build from scratch, as seen in the bare minimum example.

Ecosystem Maturity

As a specialized Go library, it has fewer third-party plugins or community extensions compared to more established Discord bot frameworks in other languages, which might limit tooling.

What is arikawa?

Target Audience

Value Proposition

Use Cases

Best For

Building Discord bots with a modular architecture where API client, Websocket Gateway, and state management are separated into independent packages.
Developing type-safe Discord applications using typed snowflakes to prevent accidental misuse of IDs (e.g., using a channel ID as a message ID).
Implementing advanced Gateway event interception for features like reading deleted messages or custom pre-handler logic.
Creating bots with pluggable caching systems, such as Redis, that automatically fall back to the API when needed.
Building interaction-based Discord bots that comply with Discord's recommendations, using examples like command routing and webhook APIs.
Developing applications that require clear separation of API and Gateway models to avoid confusion and improve code clarity.

Not Ideal For

Teams wanting an all-in-one Discord bot framework with built-in command parsing, middleware, and utilities out of the box
Developers prioritizing rapid prototyping over granular control and type safety
Projects where Go is not the primary language or where a simpler, script-like approach is preferred
Environments requiring extensive third-party plugins or a larger community ecosystem for support

Pros & Cons

Pros

Modular Architecture

Independent packages for API client, Websocket Gateway, and state management allow flexible integration and reduce bloat, as shown in the examples where components can be used separately.

Type-Safe Snowflakes

Strongly-typed IDs prevent common errors like using a channel ID as a message ID, enhancing code safety and reliability, which is highlighted in the library's key features.

Extensible Gateway Events

PreHandlers and event interception enable advanced use cases such as reading deleted messages, demonstrated in the undeleter example with local state caching.

Pluggable Caching

Supports custom cache implementations like Redis with automatic API fallback, improving performance and scalability, though implementation details require custom work.

Cons

Complex Initial Configuration

Modular design requires assembling components like state, router, and cache separately, increasing boilerplate for simple bots compared to more opinionated frameworks.

Limited High-Level Abstractions

Focuses on low-level control, so features like automatic command registration or built-in middleware are absent, forcing developers to build from scratch, as seen in the bare minimum example.

Ecosystem Maturity

As a specialized Go library, it has fewer third-party plugins or community extensions compared to more established Discord bot frameworks in other languages, which might limit tooling.

arikawa

What is arikawa?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

arikawa

What is arikawa?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?