CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2026-05-11 02:35:58 -04:00
Code Issues Packages Projects Releases Wiki Activity

Stop referencing V2 everywhere and move migration guide (#6737)

Browse Source
This commit is contained in:
Jakub Kuczys
2026-05-10 21:51:36 +02:00
committed by GitHub
parent 99babf9ad3
commit b02fa38423
10 changed files with 54 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/labeler.yml
-1
View File
@@ -266,7 +266,6 @@
- docs/framework_events.rst
- docs/guide_cog_creation.rst
- docs/guide_cog_creators.rst
- docs/guide_migration.rst
- docs/guide_publish_cogs.rst
- docs/guide_slash_and_interactions.rst
"Category: Docs - Install Guides":
docs/framework_bank.rst
-3
View File
@@ -7,9 +7,6 @@
Bank
====
Bank has now been separated from Economy for V3. New to bank is support for
having a global bank.
***********
Basic Usage
***********
docs/framework_config.rst
-43
View File
@@ -446,49 +446,6 @@ Of course, if we're less than responsible pet owners, there are consequences::
"how poorly it was taken care of."
)
*************
V2 Data Usage
*************
There has been much conversation on how to bring V2 data into V3 and, officially, we recommend that cog developers
make use of the public interface in Config (using the categories as described in these docs) rather than simply
copying and pasting your V2 data into V3. Using Config as recommended will result in a much better experience for
you in the long run and will simplify cog creation and maintenance.
However.
We realize that many of our cog creators have expressed disinterest in writing converters for V2 to V3 style data.
As a result we have opened up config to take standard V2 data and allow cog developers to manipulate it in V3 in
much the same way they would in V2. The following examples will demonstrate how to accomplish this.
.. warning::
By following this method to use V2 data in V3 you may be at risk of data corruption if your cog is used on a bot
with multiple shards. USE AT YOUR OWN RISK.
.. code-block:: python
from redbot.core import Config, commands
class ExampleCog(commands.Cog):
def __init__(self):
self.config = Config.get_conf(self, 1234567890)
self.config.init_custom("V2", 1)
self.data = {}
async def load_data(self):
self.data = await self.config.custom("V2", "V2").all()
async def save_data(self):
await self.config.custom("V2", "V2").set(self.data)
async def setup(bot):
cog = ExampleCog()
await cog.load_data()
await bot.add_cog(cog)
************************************
Best practices and performance notes
************************************
docs/framework_modlog.rst
-2
View File
@@ -8,8 +8,6 @@
Mod log
=======
Mod log has now been separated from Mod for V3.
***********
Basic Usage
***********
docs/framework_rpc.rst
+1 -1
View File
@@ -9,7 +9,7 @@ RPC
RPC support is included in Red on a `provisional <developer-guarantees-exclusions>` basis.
Backwards incompatible changes (up to and including removal of the RPC) may occur if deemed necessary.
V3 comes default with an internal RPC server that may be used to remotely control the bot in various ways.
Red comes default with an internal RPC server that may be used to remotely control the bot in various ways.
Cogs must register functions to be exposed to RPC clients.
Each of those functions must only take JSON serializable parameters and must return JSON serializable objects.
docs/guide_cog_creation.rst
+7 -9
View File
@@ -3,11 +3,11 @@
.. role:: python(code)
:language: python
========================
Creating cogs for Red V3
========================
=====================
Creating cogs for Red
=====================
This guide serves as a tutorial on creating cogs for Red V3.
This guide serves as a tutorial on creating cogs for Red.
It will cover the basics of setting up a package for your
cog and the basics of setting up the file structure. We will
also point you towards some further resources that may assist
@@ -111,8 +111,8 @@ Make sure that both files are saved.
Testing your cog
----------------
To test your cog, you will need a running instance of V3.
Assuming you installed V3 as outlined above, run :code:`redbot-setup`
To test your cog, you will need a running instance of Red.
Assuming you installed Red as outlined above, run :code:`redbot-setup`
and provide the requested information. Once that's done, run Red
by doing :code:`redbot <instance name> --dev` to start Red.
Complete the initial setup by providing a valid token and setting a
@@ -169,6 +169,4 @@ Becoming an Approved Cog Creator
Additional resources
--------------------
Be sure to check out the :doc:`/guide_migration` for some resources
on developing cogs for V3. This will also cover differences between V2 and V3 for
those who developed cogs for V2.
If you've developed cogs for V2, you might find `incompatible_changes/v2_migration` document helpful.
docs/guide_publish_cogs.rst
+2 -2
View File
@@ -1,7 +1,7 @@
.. Publishing cogs for V3
Publishing cogs for Red V3
==========================
Publishing cogs for Red
=======================
Users of Red install 3rd-party cogs using Downloader cog. To make your cog available
to install for others, you will have to create a git repository
docs/incompatible_changes/index.rst
+1
View File
@@ -10,3 +10,4 @@ Backward incompatible changes
future
3.5
v2_migration
docs/guide_migration.rst → docs/incompatible_changes/v2_migration.rst
+43
View File
@@ -38,6 +38,49 @@ per-server/member/user/role/channel or global basis. Be sure to check
out :doc:`/framework_config` for the API docs for Config as well as a
tutorial on using Config.
*************
V2 Data Usage
*************
There has been much conversation on how to bring V2 data into V3 and, officially, we recommend that cog developers
make use of the public interface in Config (using the categories as described in these docs) rather than simply
copying and pasting your V2 data into V3. Using Config as recommended will result in a much better experience for
you in the long run and will simplify cog creation and maintenance.
However.
We realize that many of our cog creators have expressed disinterest in writing converters for V2 to V3 style data.
As a result we have opened up config to take standard V2 data and allow cog developers to manipulate it in V3 in
much the same way they would in V2. The following examples will demonstrate how to accomplish this.
.. warning::
By following this method to use V2 data in V3 you may be at risk of data corruption if your cog is used on a bot
with multiple shards. USE AT YOUR OWN RISK.
.. code-block:: python
from redbot.core import Config, commands
class ExampleCog(commands.Cog):
def __init__(self):
self.config = Config.get_conf(self, 1234567890)
self.config.init_custom("V2", 1)
self.data = {}
async def load_data(self):
self.data = await self.config.custom("V2", "V2").all()
async def save_data(self):
await self.config.custom("V2", "V2").set(self.data)
async def setup(bot):
cog = ExampleCog()
await cog.load_data()
await bot.add_cog(cog)
----
Bank
----
docs/index.rst
-1
View File
@@ -62,7 +62,6 @@ Welcome to Red - Discord Bot's documentation!
:maxdepth: 2
:caption: Red Development Framework Reference:
guide_migration
guide_cog_creation
guide_slash_and_interactions
guide_publish_cogs