Skip to content

Guilded.NET - An open-source Guilded.gg API wrapper based around .NET Standard 2.1.

License

Notifications You must be signed in to change notification settings

Guilded-NET/Guilded.NET

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Banner

🟡 Guilded.NET

Guilded.NET is a free and open-source unofficial API framework/library for Guilded written on .NET platform. It allows creating bots, webhooks and interacting any other way with Guilded API.

Version Version

📥 Installing

Guilded.NET is available as a package on NuGet (or FuGet).

You can run this command to add Guilded.NET to an existing .NET project:

dotnet add package Guilded

Otherwise, you can install Guilded.NET templates and create new Guilded.NET projects:

dotnet new -i Guilded.Templates
dotnet new guilded.bot

⚙️ Using Guilded.NET

You can check out Guilded.NET's guide to get started on your bot. If you want to see everything that Guilded.NET offers, check out reference page.

It is recommended to use .NET 6 or above for Guilded.NET. While Guilded.NET supports .NET 5 or similar for now, this will definitely change in the future.

📙 Example

Here's a quick example of a starter Guilded.NET bot with a !ping command:

// Program.cs
using System.Reactive.Linq;
using Guilded;

string auth   = "your_bots_auth_token",
       prefix = "!";

await using var client = new GuildedBotClient(auth);

client
    .Prepared
    .Subscribe(me =>
        Console.WriteLine("The bot is prepared!\nLogged in as \"{0}\" with the ID \"{1}\"", me.Name, me.Id)
    );

// Wait for !ping messages
client
    .MessageCreated
    .Where(msgCreated => msgCreated.Content == prefix + "ping")
    .Subscribe(async msgCreated =>
        await msgCreated.ReplyAsync("Pong!")
    );

await client.ConnectAsync();

// Don't close the program when the bot connects; not recommended to put code after this
await Task.Delay(-1);

Note: The code above uses enabled implicit usings option.

⁉️ Support

If you need any help related to Guilded.NET, you can check out the following sources:

✅ Goals

Our goal is to provide a library that is consistent and fast, while also maintaining ease of use. A library that does not bite a developer's hand allows them to focus more heavily on their code, have fun in what they are doing along, and have an easier time making bots. The consistency of code helps increase readability and collaboration.