Discord.Net.Labs.WebSocket 3.0.4

Suggested Alternatives

Discord.Net.WebSocket

There is a newer version of this package available.
See the version list below for details.
dotnet add package Discord.Net.Labs.WebSocket --version 3.0.4                
NuGet\Install-Package Discord.Net.Labs.WebSocket -Version 3.0.4                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Discord.Net.Labs.WebSocket" Version="3.0.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Discord.Net.Labs.WebSocket --version 3.0.4                
#r "nuget: Discord.Net.Labs.WebSocket, 3.0.4"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Discord.Net.Labs.WebSocket as a Cake Addin
#addin nuget:?package=Discord.Net.Labs.WebSocket&version=3.0.4

// Install Discord.Net.Labs.WebSocket as a Cake Tool
#tool nuget:?package=Discord.Net.Labs.WebSocket&version=3.0.4                

Discord.Net Labs

NuGet

Join our Discord server for support using labs

This repo is a custom fork of Discord.Net that introduces the newest features of discord for testing and experimenting. Nothing here is guaranteed to work but you are more than welcome to submit bugs in the issues tabs

Known issues

Labs will not work with normal package of Playwo's InteractivityAddon. The reason is that his package depends on the base discord.net lib. You can instead use the InteractivityAddon.Labs package which implements some of the features added in Discord.Net-Labs.

How to use

Setting up labs in your project is really simple, here's how to do it:

  1. Remove Discord.Net from your project
  2. Add Discord.Net Labs nuget to your project
  3. Enjoy!

Listening for interactions

// Subscribe to the InteractionCreated event
client.InteractionCreated += Client_InteractionCreated;

...
private async Task Client_InteractionCreated(SocketInteraction interaction)
{
  // Checking the type of this interaction
  switch (interaction)
  {
    // Slash commands
    case SocketSlashCommand commandInteraction:
      await MySlashCommandHandler(commandInteraction);
      break;
      
    // Button clicks/selection dropdowns
    case SocketMessageComponent componentInteraction:
      await MyMessageComponentHandler(componentInteraction);
      break;
      
    // Unused or Unknown/Unsupported
    default:
      break;
  }
}

Simple handling slash commands

private async Task MySlashCommandHandler(SocketSlashCommand interaction)
{
    // Checking command name
    if (interaction.Data.Name == "ping")
    {
      // Respond to interaction with message.
      // You can also use "ephemeral" so that only the original user of the interaction sees the message
      await interaction.RespondAsync($"Pong!", ephemeral: true);
      
      // Also you can followup with a additional messages, which also can be "ephemeral"
      await interaction.FollowupAsync($"PongPong!", ephemeral: true);
    }
}

Simple handling button clicks and selection dropdowns

private async Task MyMessageComponentHandler(SocketMessageComponent interaction)
{
    // Get the custom ID 
    var customId = interaction.Data.CustomId;
    // Get the user
    var user = (SocketGuildUser) interaction.User;
    // Get the guild
    var guild = user.Guild;
    
    // Respond with the update message. This edits the message which this component resides.
    await interaction.UpdateAsync(msgProps => msgProps.Content = $"Clicked {interaction.Data.CustomId}!");
    
    // Also you can followup with a additional messages
    await interaction.FollowupAsync($"Clicked {interaction.Data.CustomId}!", ephemeral: true);
    
    // If you are using selection dropdowns, you can get the selected label and values using these
    var selectedLabel = ((SelectMenu) interaction.Message.Components.First().Components.First()).Options.FirstOrDefault(x => x.Value == interaction.Data.Values.FirstOrDefault())?.Label;
    var selectedValue = interaction.Data.Values.First();
}

Note: The example above assumes that the selection dropdown is expecting only 1 returned value, if you configured your dropdown for multiple values, you'll need to modify the code slightly.

Sending messages with buttons

Theres a new field in all SendMessageAsync functions that takes in a MessageComponent, you can use it like so:

var builder = new ComponentBuilder().WithButton("Hello!", customId: "id_1", ButtonStyle.Primary, row: 0);
await Context.Channel.SendMessageAsync("Test buttons!", component: builder.Build());

Sending messages with selection dropdowns

Theres a new field in all SendMessageAsync functions that takes in a MessageComponent, you can use it like so:

var builder = new ComponentBuilder()
  .WithSelectMenu(new SelectMenuBuilder()
    .WithCustomId("id_2")
    .WithPlaceholder("This is a placeholder")
    .AddOption(
      label: "Option",
      value: "value1",
      description: "Evan pog champ",
      emote: Emote.Parse("<:evanpog:810017136814194698>")
    )
    .AddOption("Option B", "value2", "Option B is poggers")
  );
  
await Context.Channel.SendMessageAsync("Test selection!", component: builder.Build());

Note: You can only have 5 buttons per row and 5 rows per message. If a row contains a selection dropdown it cannot contain any buttons.

Slash Commands & Context Menu Commands

Slash command & Context command examples and how to's can be found here.

Message Components

Message components (buttons, menus, etc) examples and how to's can be found here

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Discord.Net.Labs.WebSocket:

Package Downloads
Discord.Net.Labs

An experimental fork of Discord.NET that adds all the new discord features to play around with! This metapackage includes all of the optional Discord.Net Labs components.

Discord.Net.Labs.Interactions

A Discord.Net Labs extension adding support for Application Commands.

Fergun.Interactive.Labs

An addon that adds interactive functionality to commands. This is a fork of Discord.InteractivityAddon that adds several features like more customization and support for interactions.

Discord.InteractivityAddon.Labs

This package is an Addon for Discord.Net. It provides basic and advanced interactivity features for your Discord Bot. Moreover it includes support for any command framework.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.6.1 25,025 12/24/2021
3.6.0 1,116 12/24/2021
3.5.0 2,729 12/15/2021
3.4.9 5,614 12/6/2021
3.4.8 5,781 12/4/2021
3.4.7 3,677 11/28/2021
3.4.6 1,002 11/27/2021
3.4.5 839 11/27/2021
3.4.4 968 11/27/2021
3.4.3 981 11/27/2021
3.4.2 3,165 11/26/2021
3.4.1 2,447 11/26/2021
3.4.0 2,480 11/26/2021
3.3.3 1,434 11/23/2021
3.3.2 1,306 11/21/2021
3.3.1 1,476 11/21/2021
3.3.0 1,752 11/19/2021
3.2.0 2,577 11/9/2021
3.1.7 3,751 10/20/2021
3.1.6 1,658 10/15/2021
3.1.5 962 10/15/2021
3.1.4 2,583 10/13/2021
3.1.2 1,685 10/12/2021
3.1.1 3,488 9/23/2021
3.1.0 2,228 9/21/2021
3.0.4 1,455 9/15/2021
3.0.3 3,571 9/13/2021
3.0.2 3,955 8/25/2021
3.0.1 880 8/25/2021
3.0.1-pre 1,750 8/8/2021
3.0.0 2,104 8/24/2021
3.0.0-pre 448 8/5/2021
2.4.9 2,102 7/18/2021
2.4.8 1,877 7/17/2021
2.4.7 1,020 7/15/2021
2.4.6 1,487 7/11/2021
2.4.5 2,562 7/7/2021
2.4.4 967 7/6/2021
2.4.3 968 7/5/2021
2.4.2 985 7/4/2021
2.4.1 1,017 7/3/2021
2.4.0 992 7/3/2021
2.3.9-pre 426 6/1/2021
2.3.9-dev 404 7/2/2021
2.3.8 1,484 5/30/2021
2.3.7 1,029 5/30/2021
2.3.6 1,023 5/30/2021
2.3.5 982 5/29/2021
2.3.5-dev 401 5/29/2021
2.3.4 941 5/28/2021
2.3.3 879 5/28/2021
2.3.1 930 5/27/2021