Basic Concepts / Getting Started

How do I get started?

First of all, welcome! You may visit us on our Discord should you
have any questions. Before you delve into using the library,
however, you should have some decent understanding of the language
you are about to use. This library touches on
Task-based Asynchronous Pattern (TAP), polymorphism, interface
and many more advanced topics extensively. Please make sure that you
understand these topics to some extent before proceeding.

Here are some examples:

[!TIP]
Please note that you should not try to blindly copy paste
the code. The examples are meant to be a template or a guide.
It is not meant to be something that will work out of the box.

How do I add my bot to my server/guild?

You can do so by using the permission calculator provided
by FiniteReality.
This tool allows you to set the permissions that the bot will be
added with, and invite the bot into your guild. With this method,
bots will also be assigned their own special roles that normal users
cannot use; this is what we call a Managed role, and this is a much
safer method of permission management than to create a role that any
users can be assigned to.

What is a Client/User/Object ID? Is it the token?

Each user and object on Discord has its own snowflake ID generated
based on various conditions.

The ID can be seen by anyone; it is public. It is merely used to
identify an object in the Discord ecosystem. Many things in the
library require an ID to retrieve the said object.

There are 2 ways to obtain the said ID.

Enable Discord's developer mode. With developer mode enabled,
you can - as an example - right click on a guild and copy the guild
id (please note that this does not apply to all objects, such as
Role IDs [see below], or DM channel IDs).
Escape the object using \ in front the object. For example,
when you do \@Example#1234 in chat, it will return the user ID of
the aforementioned user.

A token is a credential used to log into an account. This information
should be kept private and for your eyes only. Anyone with your
token can log into your account. This applies to both user and bot
accounts. That also means that you should never ever hardcode your
token or add it into source control, as your identity may be stolen
by scrape bots on the internet that scours through constantly to
obtain a token.

How do I get the role ID?

Several common ways to do this:

Make the role mentionable and mention the role, and escape it
using the \ character in front.
Inspect the roles collection within the guild via your debugger.

Please note that right-clicking on the role and copying the ID will
not work. It will only copy the message ID.

I have more questions!

Please visit us at #dotnet_discord-net at Discord API.
Describe the problem in details to us, and preferably with the
problematic code uploaded onto Hastebin.

3.8 KiB Raw Blame History