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.

Sign up for GitHub

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

Jump to bottom

Intents Guide #9606

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Intents Guide #9606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
35db6f3
Move intents guide
Soheab Oct 11, 2023
995b95d
Add missing images
Soheab Oct 11, 2023
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
14 changes: 6 additions & 8 deletions docs/intents.rst → docs/guide/topics/intents.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
:orphan:

.. currentmodule:: discord
.. versionadded:: 1.5
.. _intents_primer:

A Primer to Gateway Intents
=============================
.. _guide_topic_intents:

Gateway Intents
================

In version 1.5 comes the introduction of :class:`Intents`. This is a radical change in how bots are written. An intent basically allows a bot to subscribe to specific buckets of events. The events that correspond to each intent is documented in the individual attribute of the :class:`Intents` documentation.

Expand Down Expand Up @@ -64,12 +62,12 @@ A privileged intent is one that requires you to go to the developer portal and m
3. Click on the bot you want to enable privileged intents for.
4. Navigate to the bot tab on the left side of the screen.

.. image:: /images/discord_bot_tab.png
.. image:: /images/guide/intents/discord_bot_tab.png
:alt: The bot tab in the application page.

5. Scroll down to the "Privileged Gateway Intents" section and enable the ones you want.

.. image:: /images/discord_privileged_intents.png
.. image:: /images/guide/intents/discord_privileged_intents.png
:alt: The privileged gateway intents selector.

.. warning::
Expand Down
0 docs/images/discord_bot_tab.png → .../images/guide/intents/discord_bot_tab.png
View file
Open in desktop
File renamed without changes
0 docs/images/discord_privileged_intents.png → ...de/intents/discord_privileged_intents.png
View file
Open in desktop
File renamed without changes
2 changes: 1 addition & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Getting started
Is this your first time using the library? This is the place to get started!

- **First steps:** :doc:`intro` | :doc:`quickstart` | :doc:`logging`
- **Working with Discord:** :doc:`discord` | :doc:`intents`
- **Working with Discord:** :doc:`discord` | :doc:`intents <guide/topics/intents>`
- **Examples:** Many examples are available in the :resource:`repository <examples>`.

Getting help
Expand Down
4 changes: 2 additions & 2 deletions docs/locale/ja/LC_MESSAGES/whats_new.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1279,8 +1279,8 @@ msgid "v1.5.0"
msgstr "v1.5.0"

#: ../../whats_new.rst:500
msgid "This version came with forced breaking changes that Discord is requiring all bots to go through on October 7th. It is highly recommended to read the documentation on intents, :ref:`intents_primer`."
msgstr "このバージョンでは、Discordが10月7日に行う、すべてのBotに要求している強制的な破壊的変更が含まれています。Intentsに関するドキュメント :ref:`intents_primer` を読むことを強くおすすめします。"
msgid "This version came with forced breaking changes that Discord is requiring all bots to go through on October 7th. It is highly recommended to read the documentation on intents, :ref:`guide_topic_intents`."
msgstr "このバージョンでは、Discordが10月7日に行う、すべてのBotに要求している強制的な破壊的変更が含まれています。Intentsに関するドキュメント :ref:`guide_topic_intents` を読むことを強くおすすめします。"

#: ../../whats_new.rst:503
msgid "API Changes"
Expand Down
2 changes: 1 addition & 1 deletion docs/whats_new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ Miscellaneous
v1.5.0
--------

This version came with forced breaking changes that Discord is requiring all bots to go through on October 7th. It is highly recommended to read the documentation on intents, :ref:`intents_primer`.
This version came with forced breaking changes that Discord is requiring all bots to go through on October 7th. It is highly recommended to read the documentation on intents, :ref:`guide_topic_intents`.

API Changes
~~~~~~~~~~~~~
Expand Down
Loading