docs: September 2019 Documentation Update (#1379)
* docs: adjust wording of ActivityType.Watching enum Adjusts the xmldoc summary wording of the ActivityType.Watching enum to fix a wording issue. * Add D.NET Logo to Open Graph meta tags * Update DescriptionGenerator ...And update color to suit the logo better * Disable smooth scrolling due to user complaints * Remove unnecessary spacing in sideaffix * Update footer version * Remove featherlight plugin As it is unnecessary and can break image tags * Adjust wordings regarding safe-handling of secrets * Fix formatting for first bot token sample * Add badges to homepage * Minor wording fixes on terminal * Update to higher quality PNG * Add Discord.Net.Example in sln for build validation * Clarify all instances of IAsnycEnumerable * Clarify overridden props in SocketNewsChannel * Add returns and params docs for SyncPermissionsAsync * Remove/fix invalid XMLdoc strings * Remove AppVeyor and add GitHub badge
This commit is contained in:
@@ -146,23 +146,6 @@ method with the application's "token."
|
||||
> Pay attention to what you are copying from the developer portal!
|
||||
> A token is not the same as the application's "client secret."
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Your bot's token can be used to gain total access to your bot, so
|
||||
> **do not** share this token with anyone else! You should store this
|
||||
> token in an external source if you plan on distributing
|
||||
> the source code for your bot.
|
||||
>
|
||||
> In the following example, we retrieve the token from the environment
|
||||
> variable `DiscordToken`. Please note that this is *not* designed to
|
||||
> be used in a production environment, as the secrets are stored in
|
||||
> plain-text.
|
||||
>
|
||||
> For information on how to set an environment variable, please see
|
||||
> instructions below,
|
||||
>
|
||||
> * Windows: [How to Create Environment Variables Shortcut in Windows](https://www.tenforums.com/tutorials/121742-create-environment-variables-shortcut-windows.html)
|
||||
> * Linux: [How To Read and Set Environmental and Shell Variables on a Linux VPS](https://www.digitalocean.com/community/tutorials/how-to-read-and-set-environmental-and-shell-variables-on-a-linux-vps)
|
||||
> * macOS: [How do I set environment variables on OS X?](https://apple.stackexchange.com/questions/106778/how-do-i-set-environment-variables-on-os-x)
|
||||
|
||||
We may now invoke the client's [StartAsync] method, which will
|
||||
start connection/reconnection logic. It is important to note that
|
||||
@@ -175,6 +158,22 @@ Finally, we will want to block the async main method from returning
|
||||
when running the application. To do this, we can await an infinite delay
|
||||
or any other blocking method, such as reading from the console.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> Your bot's token can be used to gain total access to your bot, so
|
||||
> **do not** share this token with anyone else! You should store this
|
||||
> token in an external source if you plan on distributing
|
||||
> the source code for your bot.
|
||||
>
|
||||
> In the following example, we retrieve the token from a pre-defined
|
||||
> variable, which is **NOT** secure, especially if you plan on
|
||||
> distributing the application in any shape or form.
|
||||
>
|
||||
> We recommend alternative storage such as
|
||||
> [Environment Variables], an external configuration file, or a
|
||||
> secrets manager for safe-handling of secrets.
|
||||
>
|
||||
> [Environment Variables]: https://en.wikipedia.org/wiki/Environment_variable
|
||||
|
||||
The following lines can now be added:
|
||||
|
||||
[!code-csharp[Create client](samples/first-bot/client.cs)]
|
||||
|
||||
@@ -78,7 +78,7 @@ published to our [MyGet feed]. See
|
||||
|
||||
### [Using dotnet CLI](#tab/dotnet-cli)
|
||||
|
||||
1. Launch your terminal
|
||||
1. Launch a terminal of your choice
|
||||
2. Navigate to where your `*.csproj` is located
|
||||
3. Enter `dotnet add package Discord.Net`
|
||||
|
||||
@@ -90,7 +90,7 @@ In order to compile Discord.Net, you will need the following:
|
||||
|
||||
### Using Visual Studio
|
||||
|
||||
* [Visual Studio 2017](https://www.visualstudio.com/)
|
||||
* [Visual Studio 2019](https://visualstudio.microsoft.com/)
|
||||
* [.NET Core SDK]
|
||||
|
||||
The .NET Core and Docker workload is required during Visual Studio
|
||||
@@ -109,7 +109,7 @@ When running any Discord.Net-powered bot on an older operating system
|
||||
you may encounter a @System.PlatformNotSupportedException upon
|
||||
connecting.
|
||||
|
||||
You may resolve this by either targeting .NET Core 2.1 or later, or
|
||||
You may resolve this by either targeting .NET Core 2.1 or higher, or
|
||||
by installing one or more custom packages as listed below.
|
||||
|
||||
#### [Targeting .NET Core 2.1](#tab/core2-1)
|
||||
@@ -141,4 +141,4 @@ over the default ones.
|
||||
|
||||
***
|
||||
|
||||
[.NET Core SDK]: https://www.microsoft.com/net/download/
|
||||
[.NET Core SDK]: https://dotnet.microsoft.com/download
|
||||
@@ -53,7 +53,7 @@ adding the feed to your package source.
|
||||
|
||||
### [Using dotnet CLI](#tab/cli)
|
||||
|
||||
1. Launch your terminal
|
||||
1. Launch a terminal of your choice
|
||||
2. Navigate to where your `*.csproj` is located
|
||||
3. Type `dotnet add package Discord.Net --source https://www.myget.org/F/discord-net/api/v3/index.json`
|
||||
|
||||
|
||||
@@ -2,22 +2,22 @@ private DiscordSocketClient _client;
|
||||
|
||||
public async Task MainAsync()
|
||||
{
|
||||
_client = new DiscordSocketClient();
|
||||
_client = new DiscordSocketClient();
|
||||
|
||||
_client.Log += Log;
|
||||
|
||||
// You can assign your bot token to a string, and pass that in to connect.
|
||||
// This however is insecure, particularly if you plan to have your code hosted in a repository.
|
||||
_client.Log += Log;
|
||||
|
||||
// You can assign your bot token to a string, and pass that in to connect.
|
||||
// This is, however, insecure, particularly if you plan to have your code hosted in a public repository.
|
||||
var token = "token";
|
||||
|
||||
// Some alternative options would be to keep your token in an Environment Variable or a standalone file.
|
||||
|
||||
// Some alternative options would be to keep your token in an Environment Variable or a standalone file.
|
||||
// var token = Environment.GetEnvironmentVariable("NameOfYourEnvironmentVariable");
|
||||
// var token = File.ReadAllText("token.txt");
|
||||
// var token = JsonConvert.DeserializeObject<AConfigurationClass>(File.ReadAllText("config.json")).Token;
|
||||
|
||||
await _client.LoginAsync(TokenType.Bot, token);
|
||||
await _client.StartAsync();
|
||||
await _client.LoginAsync(TokenType.Bot, token);
|
||||
await _client.StartAsync();
|
||||
|
||||
// Block this task until the program is closed.
|
||||
await Task.Delay(-1);
|
||||
}
|
||||
// Block this task until the program is closed.
|
||||
await Task.Delay(-1);
|
||||
}
|
||||
Reference in New Issue
Block a user