Skip to content

Commit

Permalink
Various new cogs, doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Kreusada committed Nov 15, 2024
1 parent 424d5ee commit 9f8a7ba
Show file tree
Hide file tree
Showing 18 changed files with 1,788 additions and 305 deletions.
5 changes: 4 additions & 1 deletion cogs.csv
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,13 @@ OnThisDay,"Find out what happened today, in multiple different years in history.
PyPi,Get information about a package available on PyPi.,Tools,"Kreusada, OofChair"
QR,Create QR codes.,Tools,Kreusada
Quotes,Get a random quote,Fun,Kreusada
Rhymes,"Generate rhymes.","Fun, Tools",Kreusada
Riddles,Get a random riddle.,Fun,Kreusada
RoleBoards,"Get 'leaderboards' about guild roles, such as the users with the most roles,the roles with the most users, and a full list of all the roles.",Tools,Kreusada
Termino,"Custom shutdown and restart messages, and announcements",Tools,Kreusada
TextEditor,Edit and manipulate with text,"Fun, Tools",Kreusada
TextFont,Change the font of text through unicode alternatives.,"Fun, Tools",Kreusada
TongueTwisters,Generate tongue twisters,Fun,Kreusada
TimeStamps,Produce Discord timestamps.,Tools,Kreusada
WordBase,"Generate rhymes, use a reverse dictionary, and more word related generators.","Fun, Tools",Kreusada
UnicodeLookup,Search the unicode library for characters and names. Supports fuzzy searching.,Tools,Kreusada

8 changes: 5 additions & 3 deletions colour/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Through this guide, ``[p]`` will always represent your prefix. Replace

.. note::

This guide was last updated for version 1.1.0. Ensure
This guide was last updated for version 1.1.1. Ensure
that you are up to date by running ``[p]cog update colour``.

If there is something missing, or something that needs improving
Expand All @@ -24,7 +24,7 @@ Through this guide, ``[p]`` will always represent your prefix. Replace
About this cog
--------------

View information about colours.
View information about a colour.

--------
Commands
Expand All @@ -33,7 +33,9 @@ Commands
Here are all the commands included in this cog (1):

* ``[p]colour <colour>``
View information about a colour.
View information about a colour.

Provide a HEX code or "random".

------------
Installation
Expand Down
70 changes: 70 additions & 0 deletions docs/cog_colour.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
.. _colour:

======
Colour
======

This is the cog guide for the 'Colour' 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::

This guide was last updated for version 1.1.1. Ensure
that you are up to date by running ``[p]cog update colour``.

If there is something missing, or something that needs improving
in this documentation, feel free to create an issue `here <https://github.com/Kreusada/Kreusada-Cogs/issues>`_.

This documentation is auto-generated everytime this cog receives an update.

--------------
About this cog
--------------

View information about a colour.

--------
Commands
--------

Here are all the commands included in this cog (1):

* ``[p]colour <colour>``
View information about a colour.

Provide a HEX code or "random".

------------
Installation
------------

If you haven't added my repo before, lets add it first. We'll call it
"kreusada-cogs" here.

.. code-block:: ini
[p]repo add kreusada-cogs https://github.com/Kreusada/Kreusada-Cogs
Now, we can install Colour.

.. code-block:: ini
[p]cog install kreusada-cogs colour
Once it's installed, it is not loaded by default. Load it by running the following
command:

.. code-block:: ini
[p]load colour
---------------
Further Support
---------------

For more support, head over to the `cog support server <https://discord.gg/GET4DVk>`_,
I have my own channel over there at #support_kreusada-cogs. Feel free to join my
`personal server <https://discord.gg/JmCFyq7>`_ whilst you're here.
44 changes: 13 additions & 31 deletions docs/cog_wordbase.rst → docs/cog_rhymes.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. _wordbase:
.. _rhymes:

========
WordBase
========
======
Rhymes
======

This is the cog guide for the 'WordBase' cog. This guide
This is the cog guide for the 'Rhymes' 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::

This guide was last updated for version 1.1.0. Ensure
that you are up to date by running ``[p]cog update wordbase``.
This guide was last updated for version 1.0.0. Ensure
that you are up to date by running ``[p]cog update rhymes``.

If there is something missing, or something that needs improving
in this documentation, feel free to create an issue `here <https://github.com/Kreusada/Kreusada-Cogs/issues>`_.
Expand All @@ -24,34 +24,16 @@ Through this guide, ``[p]`` will always represent your prefix. Replace
About this cog
--------------

Generate rhymes, use a reverse dictionary, and more word related generators.
Generate rhymes.

--------
Commands
--------

Here are all the commands included in this cog (10):
Here are all the commands included in this cog (1):

* ``[p]consonants <word>``
Get consonant matches for a word.
* ``[p]homophones <word>``
Get homophones for a word.
* ``[p]reversedefine <definition>``
Get a list of words from a definition.
* ``[p]rhymes <word>``
Get rhymes for a word.
* ``[p]triggers <word>``
Get triggers for a word.
* ``[p]wordbase``
Manage WordBase.
* ``[p]wordbase block <word>``
Block profanic words from appearing in WordBase commands.
* ``[p]wordbase blocklist [spoilers=True]``
See the current blocked words.
* ``[p]wordbase clrblock``
Clear the WordBase blocklist.
* ``[p]wordbase unblock <word>``
Unblock profanic words to appear in WordBase commands.
Get rhymes for a word.

------------
Installation
Expand All @@ -64,18 +46,18 @@ If you haven't added my repo before, lets add it first. We'll call it
[p]repo add kreusada-cogs https://github.com/Kreusada/Kreusada-Cogs
Now, we can install WordBase.
Now, we can install Rhymes.

.. code-block:: ini
[p]cog install kreusada-cogs wordbase
[p]cog install kreusada-cogs rhymes
Once it's installed, it is not loaded by default. Load it by running the following
command:

.. code-block:: ini
[p]load wordbase
[p]load rhymes
---------------
Further Support
Expand Down
68 changes: 68 additions & 0 deletions docs/cog_textfont.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
.. _textfont:

========
TextFont
========

This is the cog guide for the 'TextFont' 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::

This guide was last updated for version 1.0.0. Ensure
that you are up to date by running ``[p]cog update textfont``.

If there is something missing, or something that needs improving
in this documentation, feel free to create an issue `here <https://github.com/Kreusada/Kreusada-Cogs/issues>`_.

This documentation is auto-generated everytime this cog receives an update.

--------------
About this cog
--------------

Generate text in different fonts.

--------
Commands
--------

Here are all the commands included in this cog (1):

* ``[p]write <text>``
Write text in different fonts (alphabetic unicode variations).

------------
Installation
------------

If you haven't added my repo before, lets add it first. We'll call it
"kreusada-cogs" here.

.. code-block:: ini
[p]repo add kreusada-cogs https://github.com/Kreusada/Kreusada-Cogs
Now, we can install TextFont.

.. code-block:: ini
[p]cog install kreusada-cogs textfont
Once it's installed, it is not loaded by default. Load it by running the following
command:

.. code-block:: ini
[p]load textfont
---------------
Further Support
---------------

For more support, head over to the `cog support server <https://discord.gg/GET4DVk>`_,
I have my own channel over there at #support_kreusada-cogs. Feel free to join my
`personal server <https://discord.gg/JmCFyq7>`_ whilst you're here.
76 changes: 76 additions & 0 deletions docs/cog_unicodelookup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
.. _unicodelookup:

=============
UnicodeLookup
=============

This is the cog guide for the 'UnicodeLookup' 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::

This guide was last updated for version 1.0.0. Ensure
that you are up to date by running ``[p]cog update unicodelookup``.

If there is something missing, or something that needs improving
in this documentation, feel free to create an issue `here <https://github.com/Kreusada/Kreusada-Cogs/issues>`_.

This documentation is auto-generated everytime this cog receives an update.

--------------
About this cog
--------------

Search the unicode library for characters and names. Supports fuzzy searching.

--------
Commands
--------

Here are all the commands included in this cog (4):

* ``[p]ulookup``
Unicode lookup commands.
* ``[p]ulookup char <name>``
Get the unicode character from the name.
* ``[p]ulookup fuzzy [strength=80] <term>``
Get unicode characters from the fuzzy search term.

Strength must be a number from 50 to 100, used by the fuzzy search algorithm. Defaults to 80 (recommended).
* ``[p]ulookup name <characters>``
Get the unicode names of characters.

------------
Installation
------------

If you haven't added my repo before, lets add it first. We'll call it
"kreusada-cogs" here.

.. code-block:: ini
[p]repo add kreusada-cogs https://github.com/Kreusada/Kreusada-Cogs
Now, we can install UnicodeLookup.

.. code-block:: ini
[p]cog install kreusada-cogs unicodelookup
Once it's installed, it is not loaded by default. Load it by running the following
command:

.. code-block:: ini
[p]load unicodelookup
---------------
Further Support
---------------

For more support, head over to the `cog support server <https://discord.gg/GET4DVk>`_,
I have my own channel over there at #support_kreusada-cogs. Feel free to join my
`personal server <https://discord.gg/JmCFyq7>`_ whilst you're here.
10 changes: 8 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,22 @@ Useful Links
cog_consoleclearer
cog_embedcreator
cog_flags
cog_messagedeleter
cog_minifier
cog_onthisday
cog_pypi
cog_quotes
cog_qr
cog_quotes
cog_rhymes
cog_riddles
cog_roleboards
cog_sendcards
cog_termino
cog_texteditor
cog_textfont
cog_timestamps
cog_wordbase
cog_tonguetwisters
cog_unicodelookup

.. toctree::
:caption: Repository
Expand Down
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
| buck-out
| build
| dist
| adventure\/data
)/
'''

Expand All @@ -38,11 +37,13 @@
'pypi',
'qr',
'quotes',
'rhymes',
'riddles',
'roleboards',
'termino',
'texteditor',
'textfont',
'tonguetwisters',
'timestamps',
'wordbase',
'unicodelookup',
]
Loading

0 comments on commit 9f8a7ba

Please sign in to comment.