* Revert "Wait for two 'Started Launcher' lines before connecting to managed LL (#5751)"
This reverts commit cf85a6470f.
* Use the new ready line from LL dev build 1352+
* [Core] Add `--unload-cogs` cli.
* Fixed error + Reformat.
* At @Jack1142's request, the `packages` local variable is no longer a list, but a dictionary with `None` values, to avoid duplication.
* Update redbot/core/bot.py
Co-authored-by: Jakub Kuczys <6032823+jack1142@users.noreply.github.com>
* Update redbot/core/bot.py
Co-authored-by: Jakub Kuczys <6032823+jack1142@users.noreply.github.com>
* Update bot.py
* Update bot.py
Co-authored-by: Jakub Kuczys <6032823+jack1142@users.noreply.github.com>
* Initial commit
* Necessary amendments/changes
* style changes (i knew id have to do this...)
* Use inline()
Co-authored-by: Jakub Kuczys <6032823+jack1142@users.noreply.github.com>
Multiple bugfixes
* Fixed unbound channel_value
* Fixed lack of new lines for listcases
* Fixed response text for case. It can only be used in the current server.
* rhel->rhel8 rename of the include file for install guides
* Add RHEL 9
* Add Alma, Oracle, and Rocky Linux 9 pre-emptively
* Add Alma Linux 9 EOL date
* Add support for set api Modals
Co-authored-by: TrustyJAID <TrustyJAID@gmail.com>
* Blaacckkkk!
* Swap locations of interaction and button.
* Clarified template tokens
* Update docs and some string
* More docs
* Rework the client
Co-authored-by: TrustyJAID <TrustyJAID@gmail.com>
* Goddamned black!
* Missed a few arguments
* Black... Again
* Update redbot/core/utils/views.py
Co-authored-by: TrustyJAID <TrustyJAID@gmail.com>
* Update redbot/core/core_commands.py
Co-authored-by: TrustyJAID <TrustyJAID@gmail.com>
Co-authored-by: TrustyJAID <TrustyJAID@gmail.com>
There's no need to update RepoManager's code as:
- regex for parsing output about ambiguous refs properly treats the date
as part of description regardless of ref type
- code for checking if module exists doesn't use the contents of the error message;
the test only really checks for it to make sure that it triggers the error case
we're actually testing for. We could instead just remove it too.
* Make `controls` in `menu()` optional
You might wonder, shouldn't we pass `None` to functions from controls?
No, we shouldn't because when `None` is passed, only DEFAULT_CONTROLS
can be used and that means that the length of pages list won't change.
* Update usage in core and core cogs
* Add missing docstrings to `redbot.core.utils.menus` module
* Streamalert list shows each platform the channels were added on
* Added argument to specify the discord channel where stream alerts appear
* Fixed styling
* Changed discord_channel type to discord.TextChannel
* Changed join to humanize_list to display the streams list, split the message concatenation into two lines for better readability
* Allow specifying discord channel for picarto and hitbox, fix style for youtube and twitch
* Since token_name from streamtypes can be None on Picarto and Hitbox, I added an attribute to the Stream class to hold the platform name
* Message now tells the user that the stream alert was disabled only for the specified channel.
* Address review
* fix style
* Consistency! Sort of...
Co-authored-by: douglas-cpp <douglasc.dev@gmail.com>
Co-authored-by: Douglas <douglas.carvalho@edu.unipar.br>
* Make sure that the repository we check is in the location we expect
* Merge `redbot._version` into `redbot`
* Generate VersionInfo in _get_version()
This way, if VersionInfo.from_str() generates exception due to invalid
version, we catch it.
* Temporarily set d.py to use latest git revision
* Remove `bot` param to Client.start
* Switch to aware datetimes
A lot of this is removing `.replace(...)` which while not technically
needed, simplifies the code base. There's only a few changes that are
actually necessary here.
* Update to work with new Asset design
* [threads] Update core ModLog API to support threads
- Added proper support for passing `Thread` to `channel`
when creating/editing case
- Added `parent_channel_id` attribute to Modlog API's Case
- Added `parent_channel` property that tries to get parent channel
- Updated case's content to show both thread and parent information
* [threads] Disallow usage of threads in some of the commands
- announceset channel
- filter channel clear
- filter channel add
- filter channel remove
- GlobalUniqueObjectFinder converter
- permissions addglobalrule
- permissions removeglobalrule
- permissions removeserverrule
- Permissions cog does not perform any validation for IDs
when setting through YAML so that has not been touched
- streamalert twitch/youtube/picarto
- embedset channel
- set ownernotifications adddestination
* [threads] Handle threads in Red's permissions system (Requires)
- Made permissions system apply rules of (only) parent in threads
* [threads] Update embed_requested to support threads
- Threads don't have their own embed settings and inherit from parent
* [threads] Update Red.message_eligible_as_command to support threads
* [threads] Properly handle invocation of [p](un)mutechannel in threads
Usage of a (un)mutechannel will mute/unmute user in the parent channel
if it's invoked in a thread.
* [threads] Update Filter cog to properly handle threads
- `[p]filter channel list` in a threads sends list for parent channel
- Checking for filter hits for a message in a thread checks its parent
channel's word list. There's no separate word list for threads.
* [threads] Support threads in Audio cog
- Handle threads being notify channels
- Update type hint for `is_query_allowed()`
* [threads] Update type hints and documentation to reflect thread support
- Documented that `{channel}` in CCs might be a thread
- Allowed (documented) usage of threads with `Config.channel()`
- Separate thread scope is still in the picture though
if it were to be done, it's going to be in separate in PR
- GuildContext.channel might be Thread
* Use less costy channel check in customcom's on_message_without_command
This isn't needed for d.py 2.0 but whatever...
* Update for in-place edits
* Embed's bool changed behavior, I'm hoping it doesn't affect us
* Address User.permissions_in() removal
* Swap VerificationLevel.extreme with VerificationLevel.highest
* Change to keyword-only parameters
* Change of `Guild.vanity_invite()` return type
* avatar -> display_avatar
* Fix metaclass shenanigans with Converter
* Update Red.add_cog() to be inline with `dpy_commands.Bot.add_cog()`
This means adding `override` keyword-only parameter and causing
small breakage by swapping RuntimeError with discord.ClientException.
* Address all DEP-WARNs
* Remove Context.clean_prefix and use upstream implementation instead
* Remove commands.Literal and use upstream implementation instead
Honestly, this was a rather bad implementation anyway...
Breaking but actually not really - it was provisional.
* Update Command.callback's setter
Support for functools.partial is now built into d.py
* Add new perms in HUMANIZED_PERM mapping (some from d.py 1.7 it seems)
BTW, that should really be in core instead of what we have now...
* Remove the part of do_conversion that has not worked for a long while
* Stop wrapping BadArgument in ConversionFailure
This is breaking but it's best to resolve it like this.
The functionality of ConversionFailure can be replicated with
Context.current_parameter and Context.current_argument.
* Add custom errors for int and float converters
* Remove Command.__call__ as it's now implemented in d.py
* Get rid of _dpy_reimplements
These were reimplemented for the purpose of typing
so it is no longer needed now that d.py is type hinted.
* Add return to Red.remove_cog
* Ensure we don't delete messages that differ only by used sticker
* discord.InvalidArgument->ValueError
* Move from raw <t:...> syntax to discord.utils.format_dt()
* Address AsyncIter removal
* Swap to pos-only for params that are pos-only in upstream
* Update for changes to Command.params
* [threads] Support threads in ignore checks and allow ignoring them
- Updated `[p](un)ignore channel` to accept threads
- Updated `[p]ignore list` to list ignored threads
- Updated logic in `Red.ignored_channel_or_guild()`
Ignores for guild channels now work as follows (only changes for threads):
- if channel is not a thread:
- check if user has manage channels perm in channel
and allow command usage if so
- check if channel is ignored and disallow command usage if so
- allow command usage if none of the conditions above happened
- if channel is a thread:
- check if user has manage channels perm in parent channel
and allow command usage if so
- check if parent channel is ignored and disallow command usage
if so
- check if user has manage thread perm in parent channel
and allow command usage if so
- check if thread is ignored and disallow command usage if so
- allow command usage if none of the conditions above happened
* [partial] Raise TypeError when channel is of PartialMessageable type
- Red.embed_requested
- Red.ignored_channel_or_guild
* [partial] Discard command messages when channel is PartialMessageable
* [threads] Add utilities for checking appropriate perms in both channels & threads
* [threads] Update code to use can_react_in() and @bot_can_react()
* [threads] Update code to use can_send_messages_in
* [threads] Add send_messages_in_threads perm to mute role and overrides
* [threads] Update code to use (bot/user)_can_manage_channel
* [threads] Update [p]diagnoseissues to work with threads
* Type hint fix
* [threads] Patch vendored discord.ext.menus to check proper perms in threads
I guess we've reached time when we have to patch the lib we vendor...
* Make docs generation work with non-final d.py releases
* Update discord.utils.oauth_url() usage
* Swap usage of discord.Embed.Empty/discord.embeds.EmptyEmbed to None
* Update usage of Guild.member_count to work with `None`
* Switch from Guild.vanity_invite() to Guild.vanity_url
* Update startup process to work with d.py's new asynchronous startup
* Use setup_hook() for pre-connect actions
* Update core's add_cog, remove_cog, and load_extension methods
* Update all setup functions to async and add awaits to bot.add_cog calls
* Modernize cogs by using async cog_load and cog_unload
* Address StoreChannel removal
* [partial] Disallow passing PartialMessageable to Case.channel
* [partial] Update cogs and utils to work better with PartialMessageable
- Ignore messages with PartialMessageable channel in CustomCommands cog
- In Filter cog, don't pass channel to modlog.create_case()
if it's PartialMessageable
- In Trivia cog, only compare channel IDs
- Make `.utils.menus.menu()` work for messages
with PartialMessageable channel
- Make checks in `.utils.tunnel.Tunnel.communicate()` more rigid
* Add few missing DEP-WARNs
* Squash tested commits
* remove the code jack is concerned about
* Apply suggestions from code review
* more log lines
* more log lines
* format
* formatting
* style(Rename Xms and Xmx mentions): Rename Xms and Xmx to more use friendly names
- Change Xms to "Initial Heapsize"
- Change Xmx to "Max Heapsize"
Signed-off-by: Draper <27962761+Drapersniper@users.noreply.github.com>
* Fix embed requested in DM's
* Add documentation
* black
* Address comments
* Unnecessary added line
* Use correct channel on context
* use correct var name
* More review stuff
* Switch from low-level loop.create_task and asyncio.ensure_future
* Patch vendored discord.ext.menus to use modern APIs as well
That ext is no longer maintained by Danny anyway so...
* black
* Support all Messageables in bot.embed_requested
* Update usage in core
* Simplify [p]contact
This couldn't be done before this change.
I have also simplified getting embed color.
* Make `True` the new default for `check_permissions` kwarg
* update RC dep
* welp 100% tested
* fix import
* 120% tested
* Call _early_init even earlier
Not really in scope of this PR but the original was merged
before I could share any feedback.
* explicitly import getLogger
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* add different logging level callbacks for task exception logging
* Add callback to tasks which didn't have them
* The boring stuff - (apply .trace() and .verbose() to audio, stop using debug_exc_log, delete audio_logging.py)
* Unsured import cleanup
* use new lavalink method
* return so it doesn't log this twice.
* improve logging on main event handler
* Fix formatting breaking with nested formatters.
* Remove useless f-strings
* Revert formatting to the one before PR #5435
* One more small formatting revert
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Use proper syntax for inline formatting in core_commands
* use proper formating utils in core and core cogs wherever reasonable
* tests are awesome
* ensure "(continued)" is translated in help.py
* add colons to translatable strings for easier context comprehension by translators
* Thx flame :)
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com>
* good point
Co-authored-by: Dav <dav@mail.stopdavabuse.de>
Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com>
* Simplify `redbot-setup backup` thanks to Click 8.0
* Add some of the missing type hints
* Fix unnecessary new lines in `redbot-setup` and `redbot-setup delete`
* Add default value for storage backend
* Add non-interactive mode to `redbot-setup`
* Ensure Nitro users can't make CCs that are too long
Co-authored-by: TrustyJAID <TrustyJAID@gmail.com>
* Tox formatting
* Update to account for edits and better handling of randoms
Co-authored-by: TrustyJAID <TrustyJAID@gmail.com>
* Prevent unexpected matches by asserting whitespace or eof at the end of matches
* Use a positive lookahead instead of a capturing group to support 1d6h syntax
* Use fullmatch instead of modifying regex strings
This was removed long ago from the Windows guide (#4119) but it seems like we never got around to removing it from Unix install guides as well.
This note is rather inaccurate and the source of truth for updating Red is available in the Updating Red document.
* Drop Fedora 33
By the time we release, it's going to reach EOL.
* Drop Raspberry Pi OS 10, add support for 11
* Bring RPi OS 10 back
* Add Alma Linux 8
* Fix-up RHEL EOL dates
* Add '(Legacy)' to Raspberry Pi OS 10
* Drop CentOS 8
* catch and handle FileNotFoundError when using --no-instance when config.json does not already exist
* move load_existing_config to data_manager.py
* use load_existing_config in create_temp_config
* Fix import in redbot-launcher
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Update links to installation guides
* Update Windows link
This one redirects correctly but updated it anyways
* Update all red-discordbot.readthedocs.io links to docs.discord.red
* Reorganised Set command group
* Moved custominfo
* Tox styling
* Make `set locale®ionalformat` groups work same as server subcommands
* Use consistent method names for commands in `[p]set` group
* Update command names in docstrings
* Remove some weird rst formatting that bugs out my syntax highlighting
* Add checks to some command groups
* Update docs
* oops
* Minor fixes
* Move `[p]set api` group and its subcommands to other command groups
* Move `[p]set ownernotifications` group to other command groups
* black reformat
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Move bankset and modlogset to core commands
* Move prune over too
* Finish moving prune
* Move [p]economyset registeramount to [p]bankset registeramount
* style fix
* Fix circular import issue with another breaking change
* Apparently I missed a conflict and git still let me commit...
* Really git?
* Rename RawUserIds -> RawUserIdConverter, improve documentation
* Improve documentation of `is_owner_if_bank_global()`
* MENTION_REGEX -> USER_MENTION_REGEX
* Add 'bank.' prefix
* Fix command examples in docstrings
* Missing docstring change from `bankset prune`
* Missing changes for commands in modlogset
* Update docs
* Remove duplicated info in `economyset showsettings`
* Fix toctree in index.rst
* Add command group prefixes to names of functions for bankset/modlogset
* Remaining string updates due to command name changes
* Ensure that the bank folder is actually gone
Co-authored-by: palmtree5 <palmtree5+3577255@users.noreply.github.com>
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Add instructions on how to add pyenv to load path
* Support zsh in pyenv load path instructions
* Make instructions for Mac work when shell-specific profile file exists
* Includes are weird...
* .
* Fix my misunderstanding of what files zsh sources
* Operator precedence, or something like that
The new pip 21.3 (released 2021-10-11) uses in-tree builds when `pip install .` is used (see [release notes](https://pip.pypa.io/en/stable/news/#v21-3) and [implementation PR](https://github.com/pypa/pip/pull/10495)). This means CodeQL will see all files twice (once in the real location that is part of this repository, and one in the copy in the `build/` dir), which trips up the analysis.
When an editable install is used instead with `pip install -e .`, there is no `build/` dir, so the analysis will work again.
* Update Java URL
* Update choco package as well
* Use Windows-specific URL for Python downloads
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Fix wording in redbot/cogs/mod/kickban.py to match with the command example
* Made changes as requested in PR Review #770078179
* Added changes to docs/cog_guides/mod.rst as requested in PR Review #70784066
* Fixed kick wording
* Fix kick wording
* Update some link texts for accessibility
* Fix stuff nearby while we're here
* Reword links to DigitalOcean
* Use better link text for `[p]triviaset custom`
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Fix#5312
* Update setup.py
* put db actions under one if statement
* check backend type and improve displayed message
* accept format fix
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* fix whitespace
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* separate datapath delete from data delete
* Fix indentation
* Call `driver_cls.initialize()` outside try-finally
* Backup requires db server to run too + some simplifications
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Exclude include files from being built
* Split install guides into multiple documents (one per OS/version combo)
* Update references
* Unify anchor names
* Update pyenv requirements in CentOS 7 guide
* Update install guides for RHEL derivatives to not use pyenv
* Add guide for Rocky Linux 8
* 8.4+ -> 8.4-8.x
* Add 'the'
* add commands, cog converter
* properly use type_checking
* make core commands use command converter
* update commands to use cogconverter
* fix undefined variable name, style
* Update redbot/core/commands/converter.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Update redbot/core/commands/converter.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Update redbot/core/core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* update cog argument names
* update documentation arg names
* update more docs
* This new Sphinx is annoying about this...
* I'm questioning my skills
* Fix name error in `[p]embedset showsettings` when command is not given
* Do not use the new cog converter in `[p]command enablecog`
This is needed so that a cog that isn't loaded but was disabled
can be enabled back.
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Clarify Debian 10 as "Buster"
* Add Debian 11 Install
* This typo would of bugged my OCD...
* Clarify Debian 10 as "Buster"
* Add Debian 11 Install
* This typo would of bugged my OCD...
* Add apt upgrade line to doc
* Removing dupe for Debian 11
I'm not sure how that happened, but oh well...
* Update deps + allow Python 3.9
* Add in updates from Jack's branch
* Fix multiple target for cross-reference warnings
* Update a few more Python 3.8 occurrences
* Bump further
* Don't install tox in CodeQL environment
* Bump Python version in docs to 3.9.7
* more bumps
* Add missing pin
* Stop using the deprecated distro.linux_distribution()
* Suppress deprecation warning
* Fix OpenSUSE Leap instructions
* Drop Fedora 32
* Add Python 3.10-dev to CI
* meh
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* [Core] Blacklist api
* [Core] Use to_add, remove star from other method calls
* various touch ups
* style
* fix doc style
* [Core] Remove iterable import
* [Core] Update commands to use the blacklist/whitelist api
* Change signatures to not use `*args`
* Update all usage of private cache to the new public APIs
* Update the docstrings
* Update the usage in diagnoser
Co-authored-by: Kreusada <67752638+Kreusada@users.noreply.github.com>
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Added years and months to parse_timedelta
* Added new parse_datetimedelta along with classes for relative dates
* Switched datetime as dt to just datetime for clarity
* Changed to returning relativedelta instead of datetime
* Fixed single char typo
* After some digging, removed min and max from relative delta b/c of https://github.com/dateutil/dateutil/issues/350
* Add dateutil to intersphinx mapping
* Change uppercase D in RelativeDeltaConverter to a lowercase D
* Fix cross-references in docstrings
* Add new class and methods to __all__
* Remove get_relativedelta_converter()
* style
* Fix name of parse_relativedelta test
* more style
* Re-export new class and function in `redbot.core.commands`
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Split `Requires._transition_state` into reusable methods for Diagnoser
* (style) Fix line length
* Add missing .format()
* Add handling for user permissions, privilege level, Permissions rules
* Add missing awaits, use correct method in user perms check, add 'the'
* Fix .format() fields
* Add comment
* Add new file to labeler's configuration
* Add the command to the documentation
* All the work from DiagnoserCog
You can find the commit history of it here:
https://github.com/jack1142/DiagnoserCog
* Fix circular import
* Make channel argument optional
* Add a tip about channels from different servers
* [Trivia] Handle potential Discord errors in session.
* Hm why did I put HTTPException in there
* Revert "Hm why did I put HTTPException in there"
This reverts commit dc5cb990cb.
* Revert "[Trivia] Handle potential Discord errors in session."
This reverts commit d90e45f9e0.
* Handle Discord errors in _error_handler.
* [Streams] Check non-existent streams more than once
- For YouTube streams, it seems like the RSS feed may sometimes return
an HTTP 404 for a channel, even though the channel exists.
- If this happens more than a few times, then we should declare the
stream as non-existent, and purge it from the list of streams we
check.
* [Streams] Move retry_count reset for YouTubeStream
- Reset after the RSS check, since that is the only place where we raise
StreamNotFound in that function.
* [Streams] Increase retry to 20
* [Streams] Reduce retry count to 10
* [Alias] Added alias edit and alias global edit
* Comment and whitespace only changes
* Docstring fix
* Remove more whitespace
* Add `the` before some English purists make a PR for this...
Co-authored-by: npc203 <npc203@users.noreply.github.com>
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* added hierarchy check for rename
added hierarchy check for rename from utils
* format and self check
changed formats and added statement if me != member
* black format
apply black formatting and fix typo
* tox style
tox i guess
* tox again
:<
* Update redbot/cogs/mod/names.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Fix styling
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* [Mod] Send ban reason on Temp Bans
* If none
* Locale friendly
* Fixes for black style
* Use double line break to distinguish between reason header
* Check settings
* Black
* Reduce the number of config calls
* remove additional config call
* fixes
* style
* We're already in `if reason` so this is always True
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Add test for presence of upper and lower bound on Python version
* [part 1/3] Test that this works, DO NOT MERGE
* [part 2/3] Test that this works, DO NOT MERGE
* [part 3/3] Revert unwanted changes, NOW YOU CAN MERGE!
* Initial commit
* update docs
* remove usage kwargs
* style
* Type hint with SelfRole and not discord.Role
* fix docstring
* Various improvements, fixes
* i need to wake up
* more improvements
* AAAA
* add back check
* Improve converter error
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Initial support for Discord timestamping
* Fix timezones
* Fix userinfo for users with member.joined_at equal to None
* Simplify
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Add custom trivia list schema validation and test
* Address review
* Improve error formatting in trivia list test
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
* Oh my gosh Kowlin is finishing work!?
* fix style
* use f-strings
* moar f-strings actually
* Fix style...
* I did a poor job of find-replacing things
* Improve code readability per previous Kowlin's style
* And reformat it in such a way that get jack through the day
* Okay maybe some whitespace
* Update core_commands.py
* Update core_commands.py
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
@@ -21,10 +21,13 @@ Open that document in Notepad, and paste the following text in it:
CALL"%userprofile%\redenv\Scripts\activate.bat"
python -O -m redbot <your instance name>
IF%ERRORLEVEL%NEQ 0 (
ECHO Restarting Red...
GOTORED
)
IF%ERRORLEVEL%== 1 GOTORESTART_RED
IF%ERRORLEVEL%== 26 GOTORESTART_RED
EXIT /B %ERRORLEVEL%
:RESTART_RED
ECHO Restarting Red...
GOTORED
Replace ``<your instance name>`` with the instance name of your bot.
If you created your VENV at a location other than the recommended one, replace ``%userprofile%\redenv\Scripts\activate.bat`` with the path to your VENV.
@@ -45,4 +48,4 @@ Open the "Run" dialogue box using Windows Key + R.
Enter ``shell:startup`` if you want the bot to launch only when the current user logs in, or ``shell:common startup`` if you want the bot to launch when any user logs in.
Drag the shortcut into the folder that is opened. The bot will now launch on startup.
Drag the shortcut into the folder that is opened. The bot will now launch on startup.
You can set cooldowns for your custom commands. If a command is on cooldown, it will not be triggered.
You can set cooldowns per member or per channel, or set a cooldown guild-wide. You can also set multiple types of cooldown on a single custom command. All cooldowns must pass before the command will trigger.
You can set cooldowns per member or per thread/channel, or set a cooldown guild-wide. You can also set multiple types of cooldown on a single custom command. All cooldowns must pass before the command will trigger.
------------------
Context Parameters
@@ -27,19 +27,19 @@ Context Parameters
You can enhance your custom command's response by leaving spaces for the bot to substitute.
Mute a user in the current text channel (or in the parent of the current thread).
Examples:
@@ -145,28 +145,6 @@ If no time interval is provided this will be cleared.
*``[time]``: The length of time for a default mute.
.._mutes-command-muteset-forcerole:
"""""""""""""""""
muteset forcerole
"""""""""""""""""
..note:: |owner-lock|
**Syntax**
..code-block::none
[p]muteset forcerole <true_or_false>
**Description**
Whether or not to force role only mutes on the bot.
**Arguments**
*``<true_or_false>``: Whether to enable or disable this setting, must provide ``true`` or ``false``.
.._mutes-command-muteset-makerole:
""""""""""""""""
@@ -238,8 +216,8 @@ muteset role
Sets the role to be applied when muting a user.
If no role is setup the bot will attempt to mute a user by setting
channel overwrites in all channels to prevent the user from sending messages.
If no role is setup the bot will attempt to mute a user
by utilizing server timeouts.
..Note::
@@ -355,13 +333,41 @@ unmutechannel
**Description**
Unmute a user in this channel.
Unmute a user in this channel (or in the parent of this thread).
**Arguments**
*``<users...>``: A space separated list of usernames, ID's, or mentions.
*``[reason]``: The reason for the unmute.
.._mutes-command-timeout:
^^^^^^^
timeout
^^^^^^^
..note:: |mod-lock|
**Syntax**
..code-block::none
[p]timeout <users...> [time_and_reason]
**Description**
Timeout users.
Examples:
*``[p]timeout @member1 @member2 spam 5 hours``
*``[p]timeout @member1 3 days``
**Arguments**
*``<users...>``: A space separated list of usernames, ID's, or mentions.
*``[time_and_reason]``: The time and reason. If no time is provided, the mute will use the default set time or give an error if this hasn't been configured.
RPC support is included in Red on a provisional basis. Backwards incompatible changes (up to and including removal of the RPC) may occur if deemed necessary.
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.
Cogs must register functions to be exposed to RPC clients.
@@ -20,9 +21,9 @@ Examples
..code-block::Python
defsetup(bot):
async defsetup(bot):
c=Cog()
bot.add_cog(c)
awaitbot.add_cog(c)
bot.register_rpc_handler(c.rpc_method)
*******************************
@@ -64,4 +65,4 @@ All cog-based methods expect their parameter list to take one argument, a JSON o
API Reference
*************
Please see the :class:`redbot.core.bot.RedBase` class for details on the RPC handler register and unregister methods.
Please see the :class:`redbot.core.bot.Red` class for details on the RPC handler register and unregister methods.
Red uses a subclass of discord.py's ``CommandTree`` object in order to allow Cog Creators to add application commands to their cogs without worrying about the command count limit and to support caching ``AppCommand`` objects. When an app command is added to the bot's tree, it will not show up in ``tree.get_commands`` or other similar methods unless the command is "enabled" with ``[p]slash enable`` (similar to "load"ing a cog) and ``tree.red_check_enabled`` has been run since the command was added to the tree.
..note::
If you are adding app commands to the tree during load time, the loading process will call ``tree.red_check_enabled`` for your cog and its app commands. If you are adding app commands to the bot **outside of load time**, a call to ``tree.red_check_enabled`` after adding the commands is required to ensure the commands will appear properly.
If application commands from your cog show up in ``[p]slash list`` as enabled from an ``(unknown)`` cog and disabled from your cog at the same time, you did not follow the instructions above. You must manually call ``tree.red_check_enabled``**after** adding the commands to the tree.
@@ -41,17 +41,16 @@ Any Cog Creator that does not follow these requirements will have their repo rem
- Repo-wide ``info.json`` file with the keys
- ``author``
-``name``
-``short``
-``description``
- Cog ``info.json`` files with the keys
- ``author``
-``name``
-``short``
-``requirements`` (if applicable)
-``description``
-``min_python_version`` (if applicable)
See `info-json-format` for more information on how to set up ``info.json`` files.
@@ -73,7 +72,7 @@ Any Cog Creator that does not follow these requirements will have their repo rem
- Cogs that are more than what is able to be run in a simple eval.
- Cogs that are more than just a simple API access request.
- Cogs that properly use Red utilities, including Config, checks, and any other utility functions.
- Cogs that properly use Red utilities, for example Config, or any other utility functions.
- Cogs that use event listeners (bot.wait_for or cog-wide listeners) or custom tasks that are efficient and handle exceptions appropriately.
- Cogs that handle errors properly.
- Cogs that handle permissions properly.
@@ -84,7 +83,7 @@ Any Cog Creator that does not follow these requirements will have their repo rem
- The default locale must be English.
- The main cog class and every command must have a doc-string.
- No cog allows for escalation of permissions. (e.g., sending a mass ping through the bot without having permission to do so)
- Respect the role hierarchy. Don’t let a lower role have a way to grant a higher role.
- Respect the role hierarchy. Don't let a lower role have a way to grant a higher role.
- If your cog install comes with any pre-packaged data, use `bundled_data_path()` to access it.
- If your cog install creates any non-config data, use `cog_data_path()` to store it.
- Unless the cog is intentionally designed to listen to certain input from bots, cogs should ignore input from bots.
@@ -94,8 +93,6 @@ Any Cog Creator that does not follow these requirements will have their repo rem
- If that's not possible, don't break anything in core or any other cog with your code.
- If you have to use private methods, lock the cog to specific Red versions you can guarantee it works on without breaking anything using the ``min_bot_version`` and ``max_bot_version`` keys in that cog's ``info.json`` file.
- Cog Creators must keep their cogs up-to-date with core Red or be delisted until cogs meet Red API changes. Repositories must be kept up to date with the latest version of Red within 3 months of its release.
.._recommendations-for-cog-creators:
--------------------------------
@@ -138,14 +135,15 @@ While not required for approved Cog Creators, they are still recommended in orde
- ``ctx.embed_color``
-``bot.is_automod_immune``
- Use checks to limit command use when the bot needs special permissions.
- Use decorators to limit command use, restrict usage, or define whether the bot needs special permissions.
You can find all of the permission and cooldown related decorators under the ``redbot.core.commands`` namespace.
- Check against user input before doing things. Common things to check:
- Resulting output is safe.
- Values provided make sense. (eg. no negative numbers for payday)
- Don't unsafely use user input for things like database input.
- Check events against `bot.cog_disabled_in_guild() <RedBase.cog_disabled_in_guild()>`\
- Check events against `bot.cog_disabled_in_guild() <Red.cog_disabled_in_guild()>`\
- Not all events need to be checked, only those that interact with a guild.
- Some discretion may apply, for example,
@@ -195,7 +193,12 @@ Other Details
- The reviewer of your application has the final word.
- Hidden cogs will not be explicitly reviewed, however they are not allowed to contain malicious or ToS breaking code.
- QA reserves the right to revoke these roles and all privileges if you are found to be in gross negligence, malicious intent, or reckless abandonment of your repository.
-If a Cog Creator's repository is not maintained and kept up to date, that repo will be removed from the approved repo listings until such issues are addressed.
-Cogs must be functionally working to the quality of an approved cog on the latest minor version of Red to be listed on the Red Index. Cogs that are not updated within 1 month of initial breakage will be delisted from the index until they are updated. Examples of potential breakage include, but are not limited to:
- A dependency without version constraints receiving a breaking update
- An API changing the schema of its endpoints
- Red itself releasing a new minor version
- Only 1 person is allowed to be the Cog Creator for a particular repo. Multiple people are allowed to maintain the repo, however the "main" owner (and the Cog Creator) is responsible for any code on the repo.
- The Cog Creator status for a repo can be transferred to another user if the Cog Creator requests it.
- An approved Cog Creator can ask QA to add additional repos they have created to the approved pool.
This guide is going to cover on how to write a simple slash command into a Red cog.
This guide will assume that you have a working basic cog.
If you do not have a basic cog, please refer to the :ref:`getting started <getting-started>` guide.
It is also adviced to make yourself familiar with `Application Commands <https://discord.com/developers/docs/interactions/application-commands>`__ from Discord's documentation.
---------------
Getting Started
---------------
To start off, we will have to import some additional modules to our cog file.
We will be using the ``redbot.core.app_commands`` module to create our slash commands.
Once we have imported the module, we can start creating our slash commands in our cog class.
For this example we will use a basic hello world command.
bot.tree.remove_command("Get user ID",type=discord.AppCommandType.user)
Now we're ready to sync our commands to Discord.
We can do this by using the :ref:`[p]slash<core-command-slash>` command.
Take note of the specific arguments you have to use to sync a context command.
---------------------------------
Closing Words and Further Reading
---------------------------------
If you're reading this, it means that you've made it to the end of this guide.
Congratulations! You are now prepared with the basics of slash commands for Red.
However there is a lot we didn't touch on in this guide.
Below this paragraph you'll find a list of resources that you can use to learn more about slash commands.
As always, if you have any questions, feel free to ask in the `Red support server <https://discord.gg/red>`__.
For more information on `Application Commands <https://discord.com/developers/docs/interactions/application-commands>`__ as a whole, please refer to the official Discord documentation.
Discord.py also offers documentation regarding everything discussed on this page.
You can find the documentation `here <https://discordpy.readthedocs.io/en/stable/interactions/api.html>`__.
And lastly, AbstractUmbra has a great write up of `examples <https://gist.github.com/AbstractUmbra/a9c188797ae194e592efe05fa129c57f>`__.
The vast majority of functionality provided by ``redbot-launcher`` can already be
achieved through other means.
In Red 3.2.0, ``redbot-launcher`` has been stripped most of its functionality
as it can already be done through other (better supported) means:
- Updating Red (a proper way to update Red is now documented in `../update_red`)
- Creating instances (as documented in install guides, it should be done through ``redbot-setup``)
- Removing instances (available under ``redbot-setup delete``)
- Removing all instances (no direct alternative, can be done through ``redbot-setup delete``)
- Debug information (available under ``redbot --debuginfo`` and ``[p]debuginfo`` bot command)
Currently, ``redbot-launcher`` only provides auto-restart functionality
which we now document how to do properly on each of the supported systems.
If you wish to continue using auto-restart functionality, we recommend following the instructions for setting up a service dedicated to your operating system:
-`../autostart_windows`
-`../autostart_mac`
-`../autostart_systemd`
Behavior changes
~~~~~~~~~~~~~~~~
x86-64 CPUs are now only supported if they support x86-64-v2 instruction set
This change allowed to us to make enormous performance improvements (subsecond durations
compared to many minutes) to `modlog.get_all_cases()` and commands that use it
such as the commonly used ``[p]casesfor`` command.
With this change, we no longer fetch the whole `discord.Message` object for case's message
and instead only construct a `discord.PartialMessage` object for it. This object is rarely if ever needed so it is unlikely to affect a lot of code. Additionally, this change doesn't apply to `modlog.create_case()` which will still return a `Case` object with `message <Case.message>` attribute set to an instance of `discord.Message` or ``None``.
If you have a reason to use a full message object, you can use :meth:`discord.PartialMessage.fetch()`
This page lists all functionalities that are currently deprecated, features that have been removed in past minor releases, and any other backward incompatible changes that are planned or have been removed in past minor releases. The objective is to give users a clear rationale why a certain change has been made, and what alternatives (if any) should be used instead.
These changes are sorted (in their respective sections) in a reverse chronological order.
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.