feat: Labs deprecation & readme expansion (#2406)
This commit is contained in:
@@ -36,7 +36,7 @@ _client = new DiscordSocketClient(config);
|
||||
This includes intents that receive messages such as: `GatewayIntents.GuildMessages, GatewayIntents.DirectMessages`
|
||||
- GuildMembers: An intent disabled by default, as you need to enable it in the [developer portal].
|
||||
- GuildPresences: Also disabled by default, this intent together with `GuildMembers` are the only intents not included in `AllUnprivileged`.
|
||||
- All: All intents, it is ill adviced to use this without care, as it *can* cause a memory leak from presence.
|
||||
- All: All intents, it is ill advised to use this without care, as it _can_ cause a memory leak from presence.
|
||||
The library will give responsive warnings if you specify unnecessary intents.
|
||||
|
||||
|
||||
|
||||
@@ -30,17 +30,25 @@ other limitations, you may also consider targeting [.NET Framework]
|
||||
[.net framework]: https://docs.microsoft.com/en-us/dotnet/framework/get-started/
|
||||
[additional steps]: #installing-on-net-standard-11
|
||||
|
||||
## Installing with NuGet
|
||||
## Installing
|
||||
|
||||
Release builds of Discord.Net will be published to the
|
||||
[official NuGet feed].
|
||||
|
||||
Development builds of Discord.Net, as well as add-ons, will be
|
||||
published to our [MyGet feed]. See
|
||||
@Guides.GettingStarted.Installation.Nightlies to learn more.
|
||||
### Experimental/Development
|
||||
|
||||
[official nuget feed]: https://nuget.org
|
||||
[myget feed]: https://www.myget.org/feed/Packages/discord-net
|
||||
Development builds of Discord.Net will be
|
||||
published to our [MyGet feed]. The MyGet feed can be used to run the latest dev branch builds.
|
||||
It is not advised to use MyGet packages in a production environment, as changes may be made that negatively affect certain library functions.
|
||||
|
||||
### Labs
|
||||
|
||||
This exterior branch of Discord.Net has been deprecated and is no longer supported.
|
||||
If you have used Discord.Net-Labs in the past, you are advised to update to the latest version of Discord.Net.
|
||||
All features in Labs are implemented in the main repository.
|
||||
|
||||
[official NuGet feed]: https://nuget.org
|
||||
[MyGet feed]: https://www.myget.org/feed/Packages/discord-net
|
||||
|
||||
### [Using Visual Studio](#tab/vs-install)
|
||||
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
---
|
||||
uid: Guides.GettingStarted.Installation.Labs
|
||||
title: Installing Labs builds
|
||||
---
|
||||
|
||||
# Installing Discord.NET Labs
|
||||
|
||||
Discord.NET Labs is the experimental repository that introduces new features & chips away at all bugs until ready for merging into Discord.NET.
|
||||
Are you looking to test or play with new features?
|
||||
|
||||
> [!IMPORTANT]
|
||||
> It is very ill advised to use Discord.NET Labs in a production environment normally,
|
||||
> considering it can include bugs that have not been discovered yet, as features are freshly added.
|
||||
> However if approached correctly, will work as a pre-release to Discord.NET.
|
||||
> Make sure to report any bugs at the Labs [repository] or on [Discord]
|
||||
|
||||
[Discord]: https://discord.gg/dnet
|
||||
[repository]: https://github.com/Discord-Net-Labs/Discord.Net-Labs
|
||||
|
||||
## Installation:
|
||||
|
||||
[NuGet] - This only includes releases, on which features are ready to test.
|
||||
|
||||
> [!NOTE]
|
||||
> Installing NuGet packages is covered fully at [Installing Discord NET](xref:Guides.GettingStarted.Installation)
|
||||
|
||||
[MyGet] - Available for current builds and unreleased features.
|
||||
|
||||
[NuGet]: https://www.nuget.org/packages/Discord.Net.Labs/
|
||||
[MyGet]: https://www.myget.org/feed/Packages/discord-net-labs
|
||||
@@ -8,18 +8,22 @@ title: Terminology
|
||||
## Preface
|
||||
|
||||
Most terms for objects remain the same between 0.9 and 1.0 and above.
|
||||
The major difference is that the ``Server`` is now called ``Guild``
|
||||
The major difference is that the `Server` is now called `Guild`
|
||||
to stay in line with Discord internally.
|
||||
|
||||
## Implementation Specific Entities
|
||||
|
||||
Discord.Net is split into a core library and two different
|
||||
implementations - `Discord.Net.Core`, `Discord.Net.Rest`, and
|
||||
`Discord.Net.WebSockets`.
|
||||
`Discord.Net.WebSocket`.
|
||||
|
||||
As a bot developer, you will only need to use `Discord.Net.WebSockets`,
|
||||
You will typically only need to use `Discord.Net.WebSocket`,
|
||||
but you should be aware of the differences between them.
|
||||
|
||||
> [!TIP]
|
||||
> If you are looking to implement Rest based interactions, or handle calls over REST in any other way,
|
||||
> `Discord.Net.Rest` is the resource most applicable to you.
|
||||
|
||||
`Discord.Net.Core` provides a set of interfaces that models Discord's
|
||||
API. These interfaces are consistent throughout all implementations of
|
||||
Discord.Net, and if you are writing an implementation-agnostic library
|
||||
@@ -33,4 +37,4 @@ implementation are prefixed with `Rest` (e.g., `RestChannel`).
|
||||
`Discord.Net.WebSocket` provides a set of concrete classes that are
|
||||
used primarily with Discord's WebSocket API or entities that are kept
|
||||
in cache. When developing bots, you will be using this implementation.
|
||||
All entities are prefixed with `Socket` (e.g., `SocketChannel`).
|
||||
All entities are prefixed with `Socket` (e.g., `SocketChannel`).
|
||||
|
||||
@@ -6,9 +6,6 @@
|
||||
items:
|
||||
- name: Installation
|
||||
topicUid: Guides.GettingStarted.Installation
|
||||
items:
|
||||
- name: Nightly builds
|
||||
topicUid: Guides.GettingStarted.Installation.Labs
|
||||
- name: Your First Bot
|
||||
topicUid: Guides.GettingStarted.FirstBot
|
||||
- name: Terminology
|
||||
|
||||
@@ -38,7 +38,7 @@ _client = new DiscordSocketClient(config);
|
||||
This includes intents that receive messages such as: `GatewayIntents.GuildMessages, GatewayIntents.DirectMessages`
|
||||
- GuildMembers: An intent disabled by default, as you need to enable it in the [developer portal].
|
||||
- GuildPresences: Also disabled by default, this intent together with `GuildMembers` are the only intents not included in `AllUnprivileged`.
|
||||
- All: All intents, it is ill adviced to use this without care, as it _can_ cause a memory leak from presence.
|
||||
- All: All intents, it is ill advised to use this without care, as it _can_ cause a memory leak from presence.
|
||||
The library will give responsive warnings if you specify unnecessary intents.
|
||||
|
||||
> [!NOTE]
|
||||
|
||||
Reference in New Issue
Block a user