82 lines
No EOL
2.1 KiB
ReStructuredText
82 lines
No EOL
2.1 KiB
ReStructuredText
.. _ip:
|
|
==
|
|
Ip
|
|
==
|
|
|
|
This is the cog guide for the ``Ip`` cog. This guide contains the collection of commands which you can use in the cog.
|
|
Through this guide, ``[p]`` will always represent your prefix. Replace ``[p]`` with your own prefix when you use these commands in Discord.
|
|
|
|
.. note::
|
|
|
|
Ensure that you are up to date by running ``[p]cog update ip``.
|
|
If there is something missing, or something that needs improving in this documentation, feel free to create an issue `here <https://github.com/AAA3A-AAA3A/AAA3A-cogs/issues>`_.
|
|
This documentation is generated everytime this cog receives an update.
|
|
|
|
---------------
|
|
About this cog:
|
|
---------------
|
|
|
|
A cog to get the ip address of the bot's host machine!
|
|
|
|
---------
|
|
Commands:
|
|
---------
|
|
|
|
Here are all the commands included in this cog (7):
|
|
|
|
* ``[p]ip``
|
|
Commands group for Ip.
|
|
|
|
* ``[p]ip ip``
|
|
Get the ip address of the bot's host machine.
|
|
|
|
* ``[p]ip modalconfig [confirmation=False]``
|
|
Set all settings for the cog with a Discord Modal.
|
|
|
|
* ``[p]ip port <port>``
|
|
Set the port.
|
|
|
|
* ``[p]ip resetsetting <setting>``
|
|
Reset a setting.
|
|
|
|
* ``[p]ip showsettings [with_dev=False]``
|
|
Show all settings for the cog with defaults and values.
|
|
|
|
* ``[p]ip website``
|
|
Get the ip address website of the bot's host machine.
|
|
|
|
------------
|
|
Installation
|
|
------------
|
|
|
|
If you haven't added my repo before, lets add it first. We'll call it "AAA3A-cogs" here.
|
|
|
|
.. code-block:: ini
|
|
|
|
[p]repo add AAA3A-cogs https://github.com/AAA3A-AAA3A/AAA3A-cogs
|
|
|
|
Now, we can install Ip.
|
|
|
|
.. code-block:: ini
|
|
|
|
[p]cog install AAA3A-cogs ip
|
|
|
|
Once it's installed, it is not loaded by default. Load it by running the following command:
|
|
|
|
.. code-block:: ini
|
|
|
|
[p]load ip
|
|
|
|
----------------
|
|
Further Support:
|
|
----------------
|
|
|
|
Check out my docs `here <https://aaa3a-cogs.readthedocs.io/en/latest/>`_.
|
|
Mention me in the #support_other-cogs in the `cog support server <https://discord.gg/GET4DVk>`_ if you need any help.
|
|
Additionally, feel free to open an issue or pull request to this repo.
|
|
|
|
--------
|
|
Credits:
|
|
--------
|
|
|
|
Thanks to Kreusada for the Python code to automatically generate this documentation! |