2981d6bd80
commit ed3dac1cc7cb57b00e158273ab1487d5fb3e4eb3 Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 21:38:26 2019 -0400 merge docs into Windows_deploy commit de7768e2ff710cf183310e8d843cffb2e50285d4 Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 21:31:12 2019 -0400 clone via ssh commit 3b25b4508ae1476d17d91e6394c5bacf2721a1fc Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 21:27:15 2019 -0400 use proper \ in folder command commit 6a78a662ab21681fce2d9186888e92a3790752c0 Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 21:24:37 2019 -0400 nugget commit 13064a6184b63ebafda540514391301412407638 Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 21:17:26 2019 -0400 yes, i am sure commit 604b784e64fbbe24d8111bbfc53d59016871b244 Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 21:12:49 2019 -0400 use proper \ in windows commands commit dd3954071433a1c10f42e8510bb7961d20a089d1 Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 21:09:35 2019 -0400 install docfx.console from NuGetCommand commit 769693d834921217a51e15ef4ad34d0d7d612b33 Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 20:59:58 2019 -0400 fix syntax error commit c8c4ea5439610f0591edbc56ee17384f6e87a162 Author: Christopher Felegy <foxbot@protonmail.com> Date: Sun Jul 21 20:57:31 2019 -0400 ci: build docs
Discord.Net
An unofficial .NET API Wrapper for the Discord client (http://discordapp.com).
Check out the documentation or join the Discord API Chat.
Installation
Stable (NuGet)
Our stable builds available from NuGet through the Discord.Net metapackage:
The individual components may also be installed from NuGet:
Unstable (MyGet)
Nightly builds are available through our MyGet feed (https://www.myget.org/F/discord-net/api/v3/index.json).
Compiling
In order to compile Discord.Net, you require the following:
Using Visual Studio
The .NET Core workload must be selected during Visual Studio installation.
Using Command Line
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.
Versioning Guarantees
This library generally abides by Semantic Versioning. Packages are published in MAJOR.MINOR.PATCH version format.
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 any pre-compiled dependencies of your codebase.
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).
Furthermore, 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.
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.