NetCord 1.0.0-alpha.357

The modern and fully customizable C# Discord library

Table of Contents

1. 📦 Installation
2. 🚀 Showcase
3. 🎨 Features
4. 🥅 Goals
5. 📚 Guides
6. 📄 Documentation
7. 🩹 Support
8. 📜 License
9. 🛠️ Development

1. 📦 Installation

You can install NetCord packages via NuGet package manager:

2. 🚀 Showcase

This snippet showcases a bot with a minimal API-style /square command and includes a module-based /greet command.

Minimal API-style Bot Example

The following example sets up a bot with a minimal API-style approach for the /square command, which calculates the square of a number:

var builder = Host.CreateDefaultBuilder(args)
    .UseDiscordGateway()
    .UseApplicationCommands();

var host = builder.Build()
    .AddSlashCommand("square", "Square!", (int a) => $"{a}² = {a * a}")
    .UseGatewayEventHandlers();

await host.RunAsync();

Of course, you can also use the bare-bones approach.

Module-based Command Example

Moreover, you can use a module-based approach. Here's an example of a /greet command that greets a specified user:

public class GreetingModule : ApplicationCommandModule<ApplicationCommandContext>
{
    [SlashCommand("greet", "Greet someone!")]
    public string Greet(User user) => $"{Context.User} greets {user}!";
}

3. 🎨 Features

• Fully Customizable - Easily tailor your Discord bot with NetCord's flexible, extensible API.
• Easy to Use - Designed to be intuitive and easy to use for C# and .NET developers.
• Lightweight & High Performance - Optimized for efficient resource use, ideal for scalable bots.
• Fully Asynchronous - Built for responsive, concurrent operations in your bot.
• Native AOT Support - Enjoy faster startups and reduced memory usage with AOT compilation.
• Immutable Caching - Default immutable caching keeps data reliable and consistent.
• Voice Support - Includes high-quality capabilities for sending and receiving voice.
• HTTP Interactions - Easily handle interactions over HTTP without a persistent connection.
• Dependency-Free - Lightweight by design, with no external dependencies required.
• Stateless REST - Efficiently manage API requests with a stateless design.
• Complete API Coverage - Comprehensive support for the Discord API and advanced features.
• Open Source - Free to use and contribute to, licensed under MIT.

4. 🥅 Goals

NetCord's goal is to allow .NET developers to create fully customizable Discord bots without fighting the API wrapper itself. NetCord is designed to be easy to use and fully customizable, while still being lightweight and performant.

5. 📚 Guides

• Getting Started

6. 📄 API Documentation

• API Documentation

7. 🩹 Support

• Discord

8. 📜 License

This repository is released under the MIT License.

9. 🛠️ Development

Versioning

NetCord follows a MAJOR.MINOR.PATCH versioning scheme:

• MAJOR versions can introduce significant, breaking API changes.
• MINOR versions can add new features and may include limited breaking changes that are unlikely to affect most users.
• PATCH versions contain backwards-compatible bug fixes and improvements.

Our goal is to maintain stability while allowing for necessary evolution of the API.