Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NetCordDev/NetCord
The modern and fully customizable C# Discord library.
https://github.com/NetCordDev/NetCord
bot discord discord-api discord-api-framework discord-api-library discord-api-wrapper discord-bot discord-framework discord-library discord-wrapper framework library wrapper
Last synced: about 1 month ago
JSON representation
The modern and fully customizable C# Discord library.
- Host: GitHub
- URL: https://github.com/NetCordDev/NetCord
- Owner: NetCordDev
- License: mit
- Created: 2021-11-16T22:54:41.000Z (about 3 years ago)
- Default Branch: alpha
- Last Pushed: 2024-10-25T15:33:46.000Z (about 2 months ago)
- Last Synced: 2024-10-25T23:40:04.611Z (about 2 months ago)
- Topics: bot, discord, discord-api, discord-api-framework, discord-api-library, discord-api-wrapper, discord-bot, discord-framework, discord-library, discord-wrapper, framework, library, wrapper
- Language: C#
- Homepage: https://netcord.dev
- Size: 53.2 MB
- Stars: 66
- Watchers: 2
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-discord - NetCord
- discord-api-libs - NetCord - The modern and fully customizable C# Discord library. (Libraries / C#)
README
The modern and fully customizable C# Discord library
⭐ If you like this project, please consider giving it a star! ⭐
# Table of Contents
1. [📦 Installation](#1--installation)
2. [🚀 Showcase](#2--showcase)
3. [🎨 Features](#3--features)
4. [🥅 Goals](#4--goals)
5. [📚 Guides](#5--guides)
6. [📄 Documentation](#6--documentation)
7. [🩹 Support](#7--support)
6. [📜 License](#8--license)
## 1. 📦 Installation
You can install NetCord packages via NuGet package manager:
| Package | Description |
|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|
| **[NetCord](https://www.nuget.org/packages/NetCord)** | Core package with fundamental functionality. |
| **[NetCord.Services](https://www.nuget.org/packages/NetCord.Services)** | Facilitates seamless handling of commands and interactions. |
| **[NetCord.Hosting](https://www.nuget.org/packages/NetCord.Hosting)** | Provides .NET Generic Host extensions for the NetCord package. |
| **[NetCord.Hosting.Services](https://www.nuget.org/packages/NetCord.Hosting.Services)** | Provides .NET Generic Host extensions for the NetCord.Services package. |
| **[NetCord.Hosting.AspNetCore](https://www.nuget.org/packages/NetCord.Hosting.AspNetCore)** | Provides ASP.NET Core extensions for seamless handling of HTTP interactions. |
## 2. 🚀 Showcase
This snippet showcases a bot with a minimal API-style `/square` command and includes a module-based `/greet` command.
Required usings omitted for readability, click here to show
```cs
using Microsoft.Extensions.Hosting;
using NetCord;
using NetCord.Services.ApplicationCommands;
using NetCord.Hosting.Gateway;
using NetCord.Hosting.Services.ApplicationCommands;
```
### 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:
```cs
var builder = Host.CreateDefaultBuilder(args)
.UseDiscordGateway()
.UseApplicationCommands();
var host = builder.Build()
.AddSlashCommand("square", "Square!", (int a) => $"{a}² = {a * a}")
.UseGatewayEventHandlers();
await host.RunAsync();
```
### 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:
```cs
public class GreetingModule : ApplicationCommandModule
{
[SlashCommand("greet", "Greet someone!")]
public string Greet(User user) => $"{Context.User} greets {user}!";
}
```
## 3. 🎨 Features
- **Fully customizable** - NetCord is fully customizable and extensible
- **Easy to use** - NetCord is easy to use and understand
- **Lightweight** - NetCord is lightweight and performant
- **Asynchronous** - NetCord is fully asynchronous and concurrent
- **AOT-ready** - NetCord supports Native AOT compilation
- **Immutable** - NetCord's caching is immutable by default
- **Voice-ready** - NetCord supports both sending and receiving voice
- **Comprehensive** - NetCord covers the entire Discord API and more
## 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](https://netcord.dev/guides/getting-started/installation.html)**
## 6. 📄 Documentation
- **[Documentation](https://netcord.dev/docs/)**
## 7. 🩹 Support
## 8. 📜 License
This repository is released under the [MIT License](LICENSE.md).