dc8e0e329d
* [Docs] Get docs working on latest docfx version. Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways. Gotta figure out how to get the description generator and "last modified" plugins to work. * [Docs] Get docs working on latest docfx version. Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways. Gotta figure out how to get the description generator and "last modified" plugins to work. * [Docs] Re-add search index extractor. * [Docs] Use material theme and override derived tree style. Also adds a tiny GitHub icon on the navbar. * [Docs] Exclude DebugTools project. * [Docs] Use better method for overriding things. Totally not because DocFX won't allow me to have an override template. * [Docs] Improve styling overrides. * [Docs] Fix links in FAQs and guides. * [Docs] Use new xref service. The old xref service is being deprecated by the end of the year. See https://github.com/dotnet/docfx/issues/8958 * [Docs] Replace (c) with proper copyright symbol. * [Docs] Fix formatting in docfx.json file. Thanks, VSCode. * [Docs] Remove non-working post processors. They don't work, and *personally* I feel like they're unnecessary considering you can check the last modification date in the (linked) GitHub page. I honestly have no idea what the other post processor does and honestly the code doesn't help much either. * [Docs] Fix "in this article" being too thin. Fixes https://github.com/discord-net/Discord.Net/pull/2778#issuecomment-1748812077 * [Docs] Get examples working again. * [Docs] Make properties be separated more clearly. * [Docs] Change docs index to reflect the new nightly MyGet feed. * [Docs] Get docs working on latest docfx version. Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways. Gotta figure out how to get the description generator and "last modified" plugins to work. * [Docs] Get docs working on latest docfx version. Removed light-dark-theme as it didn't work with modern docfx, and Material provides the features it provided anyways. Gotta figure out how to get the description generator and "last modified" plugins to work. * [Docs] Re-add search index extractor. * [Docs] Use material theme and override derived tree style. Also adds a tiny GitHub icon on the navbar. * [Docs] Exclude DebugTools project. * [Docs] Use better method for overriding things. Totally not because DocFX won't allow me to have an override template. * [Docs] Improve styling overrides. * [Docs] Fix links in FAQs and guides. * [Docs] Use new xref service. The old xref service is being deprecated by the end of the year. See https://github.com/dotnet/docfx/issues/8958 * [Docs] Replace (c) with proper copyright symbol. * [Docs] Fix formatting in docfx.json file. Thanks, VSCode. * [Docs] Remove non-working post processors. They don't work, and *personally* I feel like they're unnecessary considering you can check the last modification date in the (linked) GitHub page. I honestly have no idea what the other post processor does and honestly the code doesn't help much either. * [Docs] Fix "in this article" being too thin. Fixes https://github.com/discord-net/Discord.Net/pull/2778#issuecomment-1748812077 * [Docs] Get examples working again. * [Docs] Make properties be separated more clearly. * [Docs] Change docs index to reflect the new nightly MyGet feed. * [Docs] Fix index image not switching when changing themes. Co-Authored-By: exsersewo <25526843+exsersewo@users.noreply.github.com> * add updated description generator postprocessor * update postprocessor * got it working * downgrade postprocessor docfx * [Docs] Add left margin to side navigation links. * remove dup docs cuz `<inheritdoc />` --------- Co-authored-by: exsersewo <25526843+exsersewo@users.noreply.github.com> Co-authored-by: Misha133 <mihagribkov133@gmail.com> Co-authored-by: Mihail Gribkov <61027276+Misha-133@users.noreply.github.com>
📄 Documentation
🩷 Supporting Discord.Net
Discord.Net is an MIT-licensed open source project with its development made possible entirely by volunteers. If you'd like to support our efforts financially, please consider:
📥 Installation
Stable (NuGet)
Our stable builds available from NuGet through the Discord.Net metapackage:
The individual components may also be installed from NuGet:
-
Webhooks
-
Text-Command & Interaction services.
-
Complete API coverage.
-
The API core. Implements only entities and barebones functionality.
Unstable
Nightly builds are available through our MyGet feed (https://www.myget.org/F/discord-net/api/v3/index.json).
These builds target the dev branch.
🛑 Known Issues
WebSockets (Win7 and earlier)
.NET Core 1.1 does not support WebSockets on Win7 and earlier. This issue has been fixed since the release of .NET Core 2.1. It is recommended to target .NET Core 2.1 or above for your project if you wish to run your bot on legacy platforms; alternatively, you may choose to install the Discord.Net.Providers.WS4Net package.
TLS on .NET Framework.
Discord supports only TLS1.2+ on all their websites including the API since 07/19/2022.
.NET Framework does not support this protocol by default.
If you depend on .NET Framework, it is suggested to upgrade your project to net6-windows.
This framework supports most of the windows-only features introduced by fx, and resolves startup errors from the TLS protocol mismatch.
🗃️ Versioning Guarantees
This library generally abides by Semantic Versioning. Packages are published in MAJOR.MINOR.PATCH version format.
Patch component
An increment of the PATCH component always indicates that an internal-only change was made, generally a bugfix. These changes will not affect the public-facing API in any way, and are always guaranteed to be forward- and backwards-compatible with your codebase, any pre-compiled dependencies of your codebase.
Minor component
An increment of the MINOR component indicates that some addition was made to the library, and this addition is not backwards-compatible with prior versions. However, Discord.Net does not guarantee forward-compatibility on minor additions. In other words, we permit a limited set of breaking changes on a minor version bump.
Due to the nature of the Discord API, we will oftentimes need to add a property to an entity to support the latest API changes. Discord.Net provides interfaces as a method of consuming entities; and as such, introducing a new field to an entity is technically a breaking change. Major version bumps generally indicate some major change to the library, and as such we are hesitant to bump the major version for every minor addition to the library. To compromise, we have decided that interfaces should be treated as consumable only, and your applications should typically not be implementing interfaces.
For applications where interfaces are implemented, such as in test mocks, we apologize for this inconsistency with SemVer.
While we will never break the API (outside of interface changes) on minor builds, we will occasionally need to break the ABI, by introducing parameters to a method to match changes upstream with Discord. As such, a minor version increment may require you to recompile your code, and dependencies, such as addons, may also need to be recompiled and republished on the newer version. When a binary breaking change is made, the change will be noted in the release notes.
Major component
An increment of the MAJOR component indicates that breaking changes have been made to the library; consumers should check the release notes to determine what changes need to be made.
📚 Branches
Release/X.X
Release branch following Major.Minor. Upon release, patches will be pushed to these branches. New NuGet releases will be tagged on these branches.
Dev
Development branch, available on MyGet. This branch is what pull requests are targetted to.
Feature/X
Branches that target Dev, adding new features. Feel free to explore these branches and give feedback where necessary.
Docs/X
Usually targets Dev. These branches are used to update documentation with either new features or existing feature rework.