-
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
100 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
|  | ||
|
|
||
| ## The modern and fully customizable C# Discord library | ||
|
|
||
| # Table of Contents | ||
|
|
||
| 1. [📦 Installation](#installation) | ||
| 2. [🚀 Showcase](#showcase) | ||
| 3. [🎨 Features](#features) | ||
| 4. [🥅 Goals](#goals) | ||
| 5. [📚 Guides](#guides) | ||
| 6. [📄 Documentation](#documentation) | ||
| 7. [🩹 Support](#support) | ||
| 6. [📜 License](#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. | ||
|
|
||
| ### 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<SlashCommandInteraction, SlashCommandContext>(); | ||
|
|
||
| var host = builder.Build() | ||
| .AddSlashCommand<SlashCommandContext>("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<SlashCommandContext> | ||
| { | ||
| [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/index.html)** | ||
|
|
||
| ## 7. 🩹 Support | ||
|
|
||
| - **[Discord](https://discord.gg/meaSHTGyUH)** | ||
|
|
||
| ## 8. 📜 License | ||
|
|
||
| This repository is released under the [MIT License](https://github.com/NetCordDev/NetCord/blob/alpha/LICENSE.md). |