Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added commonly user terms #718

Merged
merged 18 commits into from
Aug 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@
"CORO",
"cback",
"mentionables",
"stringified",
"disdppgloss",
"awaiter",
"checkered",
"ramen",
Expand Down
1 change: 1 addition & 0 deletions docpages/INDEX.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ The library should work fine on other operating systems as well, and if you run
* [Frequently Asked Questions](/md_docpages_01_frequently_asked_questions.html)
* [Installing D++](/md_docpages_01_installing.html)
* [Example Programs](/md_docpages_03_example_programs.html)
* [Commonly used terms](/md_docpages_disdppgloss.html)

## Architecture
* \ref clusters-shards-guilds
Expand Down
51 changes: 51 additions & 0 deletions docpages/disdppgloss.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
## A Glossary of Common Discord Terms

This is a list of terms that one should know if you want use D++ (or any other discord library). These terms are not D++ specific, and are commonly used throughout most of the Discord developer community. This list, with a few exceptions, ***is discord specific***, that is to say that this is not a explanation of commonly used C++ terms, it is for people who are not familiar with the terminology of the discord API and libraries themselves.

#### Glossary

Listed in alphabetical order, with terms in bold, here are the basics on...

1. **Action row**: A collection of up to five **components** which is attached to a message.

2. **Audit log**: A log of **events** that have happened in a **guild**.

3. **Auto mod**: Discord's low-code solution to moderation. However, it is very limited in scope.

4. **Badge**: A decoration on someone's profile showing certain things about them, such as if they have nitro, if they are a discord developer, etc.

5. **Bot token**: A secret string of characters that is used as a "login" to your bot. If you lose it or it gets leaked you will have to get a new one from the discord developer portal, so be sure to keep it in a place that is both secure and where you won't forget it.

6. **Button**: A **component** on a message that can be styled that sends an **event** when clicked on by a user.

7. **Cache**: A type of storage efficient for things like messages.

8. **Callback**: While not strictly related to discord, it is used a LOT in D++. A callback is when a function is passed to another function, sort of like how you might give someone a telephone number (you give them the means to do some sort of interaction rather than asking them how to interact), which is used to handle responses to **events**.

9. **Cluster**: A singular bot application, which is composed of one or more **shards**, a **cluster** is the center of bot development.

10. **\(Slash\) command**: The primary way a user interacts with a bot. It is a command sent to the bot with **parameters** (which may be optional) and is initiated by staring a message with `/`.

11. **Component**: A component is anything that can appear in a bot's message besides text, such as **buttons** and **select menus**.

12. **Drop down/Select menu**: A **component** of a message that upon being clicked drops down and allows the user to select an option.

13. **Embeds**: A widget attached to a message which can contain multiple fields of texts, an image, and much more information.

14. **Ephemeral**: A message only visible to the user being replied to.

15. **Event**: Something that a Discord bot can respond to, such as a message being sent, a **button** being clicked, or an option being selected, among others.

16. **Guild**: What the Discord API (and most libraries for it) call a server.

17. **Intents**: The right for a bot to receive certain data from the Discord API.

18. **Interaction**: A object that contains information about whenever a user interacts with a application, such as sending a message or clicking a button. It is the main part of an **event** that will be accessed in an application.

19. **Modal**: A pop up form that contains text that can be sent by a bot.

20. **[Shards](\ref clusters-shards-guilds)**: A shard manages part of the workload of your Discord application

21. **Snowflake**: An unsigned 64 bit integer (it can represent anything from 0 to 2^64-1) that is used by discord to identify basically everything, including but not limited to, **guilds**, users, messages, and much more.

22. **Subcommands**: A command which is derived from a different command, such as a bot that allows a person to get statistics for discord might have a `stats guild` command and a `stats global` command, both of which are **subcommands** of `stats`.