You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.3 kB

4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. # Discord.Net Labs
  2. [![NuGet](https://img.shields.io/nuget/vpre/Discord.Net.Labs.svg?maxAge=2592000?style=plastic)](https://www.nuget.org/packages/Discord.Net.Labs)
  3. [![Discord](https://discord.com/api/guilds/848176216011046962/widget.png)](https://discord.gg/dvSfUTet3K)
  4. 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
  5. ## Known issues
  6. Labs will not work with Playwo's [InteractivityAddon](https://github.com/Playwo/Discord.InteractivityAddon). The reason is that his package depends on the base discord.net lib, you can get around this by cloning his repo and building it with discord.net labs instead of discord.net.
  7. ## How to use
  8. Setting up labs in your project is really simple, here's how to do it:
  9. 1) Remove Discord.Net from your project
  10. 2) Add Discord.Net Labs nuget to your project
  11. 3) Enjoy!
  12. ## Branches
  13. ### Dev
  14. The main branch we pull off of to introduce new features into, the dev branch is the same as Discord.Nets dev branch
  15. ### Interactions
  16. This branch is for anything todo with Discord Interactions, such as [Slash commands](https://discord.com/developers/docs/interactions/slash-commands) and [Message Components](https://discord.com/developers/docs/interactions/message-components). This branch is stable enough to use but does not contain all the features of interactions.
  17. ### SlashCommandService
  18. This branch is on pause and does not work currently, Once everything is stable with the Interaction branch we will continue working on a slash command service for it.
  19. ### web/SlashCommandService
  20. webmilio's spin on the SlashCommandService branch, again the state of this is unknown.
  21. ## Message Components
  22. So, you want to use Message components? Well you're in luck! Below is a quick overview of how to use them
  23. #### Listening for button presses
  24. ```cs
  25. // Subscribe to the InteractionCreated event
  26. client.InteractionCreated += Client_InteractionCreated;
  27. ...
  28. private async Task Client_InteractionCreated(SocketInteraction arg)
  29. {
  30. // If the type of the interaction is a message component
  31. if(arg.Type == Discord.InteractionType.MessageComponent)
  32. {
  33. // parse the args
  34. var parsedArg = (SocketMessageComponent)arg;
  35. // respond with the update message response type. This edits the original message if you have set AlwaysAcknowledgeInteractions to false.
  36. await parsedArg.RespondAsync($"Clicked {parsedArg.Data.CustomId}!", type: InteractionResponseType.UpdateMessage);
  37. }
  38. }
  39. ```
  40. #### Sending messages with buttons
  41. Theres a new field in all `SendMessageAsync` functions that takes in a `MessageComponent`, you can use it like so:
  42. ```cs
  43. var builder = new ComponentBuilder().WithButton("Hello!", ButtonStyle.Primary, customId: "id_1");
  44. await Context.Channel.SendMessageAsync("Test buttons!", component: builder.Build());
  45. ```
  46. ## Slash commands
  47. Slash command example how to's can be found [here](https://github.com/Discord-Net-Labs/Discord.Net-Labs/blob/Interactions/docs/guides/commands/application-commands.md). If you want to read some code using slash commands, you can do that [here](https://github.com/quinchs/SwissbotCore/blob/master/SwissbotCore/Handlers/AutoMod/Censor.cs)