antipetros_discordbot 2.1.4
A Discord Bot for the Antistasi (ArmA 3) Community Discord Server
License: MIT
Requires Python: >=3.9

# <p align="center">Antipetros Discordbot</p>


<p align="center"><img src="art/finished/images/AntiPetros_for_readme.png" alt="Antipetros Discordbot Avatar"/></p>


---

## ToC



  
  - [Installation](#installation)    
    - [PyPi](#pypi)  
  - [Usage](#usage)  
  - [Description](#description)  
  - [Features](#features)  
  - [Dependencies](#dependencies)    
    - [Python dependencies](#python-dependencies)    
    - [External dependencies](#external-dependencies)  
  - [License](#license)  
  - [Development](#development)    
    - [Future Plans](#future-plans)  
  - [See also](#see-also)    
    - [Links](#links)



---



__**Bot-Name:**__

> AntiPetros

__**Version:**__

> 1.3.9





---

## Installation



### PyPi

```shell
pip install antipetros_discordbot==1.3.9
```



---

## Usage




- __**antipetrosbot clean**__
    > Cli command to clean the 'APPDATA' folder that was created.


- __**antipetrosbot get-path**__
    > Get remote path to the User data dir or files withing.


- __**antipetrosbot run**__
    > Standard way to start the bot and connect it to discord.


- __**antipetrosbot stop**__
    > Cli way of autostoping the bot.





---

## Description







---

## Features




<details><summary><b>Currently usable Cogs</b></summary><blockquote>



### <p align="center"><b>[AdministrationCog](antipetros_discordbot/cogs/discord_admin_cogs/discord_admin_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Commands and methods that help in Administrate the Discord Server.</blockquote>

#### Config Name

<blockquote>administration</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- OUTDATED

- NEEDS_REFRACTORING

- FEATURE_MISSING

- UNTESTED

- OPEN_TODOS
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **DELETE_MSG**
    

    
    - **aliases:** *deletemsg*, *delete+msg*, *delete.msg*, *delete-msg*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **MAKE_EMBED**
    
    - **help:**

        Creates a simple embed message in the specified channel.
        
        No support for embed fields, as input would be to complicated.
        
        Args:
            channel (discord.TextChannel): either channel name or channel id (prefered), where the message should be posted.
            --title (str):
            --description (str):
            --url (str):
            --thumbnail (str):
            --image (str):
            --timestamp (str):
            --author-name (str):
            --author-url (str):
            --author-icon (str):
            --footer-text (str):
            --footer-icon (str):
            --thumbnail (str):
            --image (str):
            --disable-mentions (bool):
            --delete-after (int):

    

    
    - **aliases:** *make.embed*, *make-embed*, *makeembed*, *make+embed*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **THE_BOTS_NEW_CLOTHES**
    
    - **help:**

        Sends about a page worth of empty message to a channel, looks like channel got purged.
        
        Optional deletes the empty message after specified seconds (defaults to not deleting)
        
        Args:
            delete_after (int, optional): time in seconds after which to delete the empty message. Defaults to None which means that it does not delete the empty message.

    

    
    - **aliases:** *thebotsnewclothes*, *the+bots+new+clothes*, *the-bots-new-clothes*, *clr-scrn*, *the.bots.new.clothes*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **WRITE_MESSAGE**
    

    
    - **aliases:** *write+message*, *writemessage*, *write-message*, *write.message*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[AntistasiLogWatcherCog](antipetros_discordbot/cogs/antistasi_tool_cogs/antistasi_log_watcher_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>soon</blockquote>

#### Config Name

<blockquote>antistasi_log_watcher</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- FEATURE_MISSING

- UNTESTED

+ WORKING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **GET_NEWEST_LOGS**
    
    - **help:**

        Gets the newest log files from the Dev Drive.
        
        If the log file is bigger than current file size limit, it will provide it zipped.
        
        Tries to fuzzy match both server and sub-folder.
        
        Args:
            server (str): Name of the Server
            sub_folder (str): Name of the sub-folder e.g. Server, HC_0, HC_1,...
            amount (int, optional): The amount of log files to get. standard max is 5 . Defaults to 1.

    

    
    - **aliases:** *get-newest-logs*, *get.newest.logs*, *get+newest+logs*, *getnewestlogs*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros get_newest_logs mainserver_1 server
        ```
    
    <br>


- **GET_NEWEST_MOD_DATA**
    
    - **help:**

        Gets the required mods for the Server.
        
        Provides the list as embed and Arma3 importable html file.
        
        Args:
            server (str): Name of the Antistasi Community Server to retrieve the mod list.

    

    
    - **aliases:** *get+newest+mod+data*, *getnewestmoddata*, *get.newest.mod.data*, *get-newest-mod-data*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros get_newest_mod_data mainserver_1
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[AutoReactionCog](antipetros_discordbot/cogs/general_cogs/auto_reaction_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>WiP</blockquote>

#### Config Name

<blockquote>auto_reaction</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **ADD_CHANNEL_REACTION_INSTRUCTION**
    

    
    - **aliases:** *add-channel-reaction-instruction*, *addchannelreactioninstruction*, *add+channel+reaction+instruction*, *add.channel.reaction.instruction*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **ADD_EXCEPTION_TO_WORD_REACTION_INSTRUCTION**
    

    
    - **aliases:** *add+exception+to+word+reaction+instruction*, *add-exception-to-word-reaction-instruction*, *addexceptiontowordreactioninstruction*, *add.exception.to.word.reaction.instruction*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **ADD_WORD_REACTION_INSTRUCTION**
    

    
    - **aliases:** *add-word-reaction-instruction*, *add.word.reaction.instruction*, *add+word+reaction+instruction*, *addwordreactioninstruction*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **CHANGE_WORD_REACTION_INSTRUCTION_OPTION**
    

    
    - **aliases:** *change.word.reaction.instruction.option*, *change-word-reaction-instruction-option*, *change+word+reaction+instruction+option*, *changewordreactioninstructionoption*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **LIST_ALL_REACTION_INSTRUCTIONS**
    

    
    - **aliases:** *list+all+reaction+instructions*, *listallreactioninstructions*, *list.all.reaction.instructions*, *list-all-reaction-instructions*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **REMOVE_REACTION_INSTRUCTION**
    

    
    - **aliases:** *remove-reaction-instruction*, *remove+reaction+instruction*, *removereactioninstruction*, *remove.reaction.instruction*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[BotAdminCog](antipetros_discordbot/cogs/bot_admin_cogs/bot_admin_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Commands and methods that are needed to Administrate the Bot itself.</blockquote>

#### Config Name

<blockquote>bot_admin</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- FEATURE_MISSING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **ADD_TO_BLACKLIST**
    

    
    - **aliases:** *add+to+blacklist*, *add.to.blacklist*, *addtoblacklist*, *add-to-blacklist*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **ADD_WHO_IS_PHRASE**
    

    
    - **aliases:** *add.who.is.phrase*, *add+who+is+phrase*, *addwhoisphrase*, *add-who-is-phrase*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **ALL_ALIASES**
    

    
    - **aliases:** *allaliases*, *all.aliases*, *all+aliases*, *all-aliases*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **INVOCATION_PREFIXES**
    

    
    - **aliases:** *invocation+prefixes*, *invocationprefixes*, *invocation-prefixes*, *invocation.prefixes*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **LIFE_CHECK**
    

    
    - **aliases:** *you_dead?*, *life-check*, *life+check*, *are-you-there*, *poke-with-stick*, *life.check*, *lifecheck*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **REMOVE_FROM_BLACKLIST**
    

    
    - **aliases:** *remove-from-blacklist*, *remove.from.blacklist*, *remove+from+blacklist*, *removefromblacklist*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **SEND_LOG_FILE**
    
    - **help:**

        Gets the log files of the bot and post it as a file to discord.
        
        You can choose to only get the newest or all logs.
        
        Args:
            which_logs (str, optional): [description]. Defaults to 'newest'. other options = 'all'

    

    
    - **aliases:** *send.log.file*, *sendlogfile*, *send+log+file*, *send-log-file*
    

    - **is hidden:** True

    - **usage:**
        ```python
        @AntiPetros send_log_file all
        ```
    
    <br>


- **SEND_LOOP_INFO**
    

    
    - **aliases:** *sendloopinfo*, *send+loop+info*, *send-loop-info*, *send.loop.info*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **TELL_UPTIME**
    

    
    - **aliases:** *tell+uptime*, *tell-uptime*, *telluptime*, *tell.uptime*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **TELL_VERSION**
    

    
    - **aliases:** *tell+version*, *tell-version*, *tell.version*, *tellversion*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[BotFeedbackCog](antipetros_discordbot/cogs/bot_admin_cogs/bot_feedback_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>WiP</blockquote>

#### Config Name

<blockquote>bot_feedback</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>



</blockquote>

</details>

---



### <p align="center"><b>[CommunityServerInfoCog](antipetros_discordbot/cogs/antistasi_tool_cogs/community_server_info_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>soon</blockquote>

#### Config Name

<blockquote>community_server_info</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **CURRENT_ONLINE_SERVER**
    
    - **help:**

        Shows all server of the Antistasi Community, that are currently online.
        
        Testserver_3 and Eventserver are excluded as they usually are password guarded.

    

    
    - **aliases:** *current-online-server*, *servers*, *currentonlineserver*, *current+online+server*, *server?*, *server*, *current.online.server*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros current_online_server
        ```
    
    <br>


- **CURRENT_PLAYERS**
    
    - **help:**

        Show all players that are currently online on one of the Antistasi Community Server.
        
        Shows Player Name, Player Score and Time Played on that Server.
        
        Args:
            server (str): Name of the Server, case insensitive.

    

    
    - **aliases:** *currentplayers*, *current-players*, *current+players*, *current.players*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros current_players mainserver_1
        ```
    
    <br>


- **EXCLUDE_FROM_SERVER_STATUS_NOTIFICATION**
    

    
    - **aliases:** *exclude-from-server-status-notification*, *exclude+from+server+status+notification*, *excludefromserverstatusnotification*, *exclude.from.server.status.notification*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **UNDO_EXCLUDE_FROM_SERVER_STATUS_NOTIFICATION**
    

    
    - **aliases:** *undoexcludefromserverstatusnotification*, *undo+exclude+from+server+status+notification*, *undo-exclude-from-server-status-notification*, *undo.exclude.from.server.status.notification*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[ConfigCog](antipetros_discordbot/cogs/bot_admin_cogs/config_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Cog with commands to access and manipulate config files, also for changing command aliases.
Almost all are only available in DM's

commands are hidden from the help command.</blockquote>

#### Config Name

<blockquote>config</blockquote>


#### Cog State Tags

```diff
- NEEDS_REFRACTORING

- FEATURE_MISSING

- OPEN_TODOS
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **ADD_ALIAS**
    
    - **help:**

        Adds an alias for a command.
        
        Alias has to be unique and not spaces.
        
        Args:
            command_name (str): name of the command
            alias (str): the new alias.

    

    
    - **aliases:** *addalias*, *add-alias*, *add.alias*, *add+alias*
    

    - **is hidden:** True

    - **usage:**
        ```python
        @AntiPetros add_alias flip_coin flip_it
        ```
    
    <br>


- **CHANGE_SETTING_TO**
    
    - **help:**

        NOT IMPLEMENTED

    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **CONFIG_REQUEST**
    
    - **help:**

        Returns a Config file as and attachment, with additional info in an embed.
        
        Args:
            config_name (str, optional): Name of the config, or 'all' for all configs. Defaults to 'all'.

    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **LIST_CONFIGS**
    
    - **help:**

        NOT IMPLEMENTED

    

    
    - **aliases:** *listconfigs*, *list+configs*, *list.configs*, *list-configs*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **OVERWRITE_CONFIG_FROM_FILE**
    
    - **help:**

        NOT IMPLEMENTED

    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **SHOW_CONFIG_CONTENT**
    
    - **help:**

        NOT IMPLEMENTED

    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **SHOW_CONFIG_CONTENT_RAW**
    
    - **help:**

        NOT IMPLEMENTED

    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[FaqCog](antipetros_discordbot/cogs/special_channels_cogs/faq_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Creates Embed FAQ items.</blockquote>

#### Config Name

<blockquote>faq</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- FEATURE_MISSING

- UNTESTED

+ WORKING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **POST_FAQ_BY_NUMBER**
    
    - **help:**

        Posts an FAQ as an embed on request.
        
        Either as an normal message or as an reply, if the invoking message was also an reply.
        
        Deletes invoking message
        
        Args:
            faq_numbers (commands.Greedy[int]): minimum one faq number to request, maximum as many as you want seperated by one space (i.e. 14 12 3)
            as_template (bool, optional): if the resulting faq item should be created via the templated items or from the direct parsed faqs.

    

    
    - **aliases:** *faq*, *postfaqbynumber*, *post.faq.by.number*, *post+faq+by+number*, *post-faq-by-number*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[FixedAnswerCog](antipetros_discordbot/cogs/general_cogs/fixed_answer_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>WiP</blockquote>

#### Config Name

<blockquote>fixed_answer</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **BOB_STREAMING**
    

    
    - **aliases:** *bobstreaming*, *bob.streaming*, *bob+streaming*, *bob-streaming*, *bobdev*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **NEW_VERSION_ETA**
    

    
    - **aliases:** *newversioneta*, *eta*, *new+version+eta*, *update*, *new.version.eta*, *new-version-eta*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---





### <p align="center"><b>[GithubCog](antipetros_discordbot/cogs/antistasi_tool_cogs/github_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>WiP</blockquote>

#### Config Name

<blockquote>github</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **GET_FILE**
    

    
    - **aliases:** *get-file*, *get.file*, *get+file*, *getfile*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **GITHUB_REFERALS**
    

    
    - **aliases:** *github+referals*, *github.referals*, *github-referals*, *githubreferals*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **GITHUB_TRAFFIC**
    

    
    - **aliases:** *github-traffic*, *githubtraffic*, *github.traffic*, *github+traffic*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[GiveAwayCog](antipetros_discordbot/cogs/community_events_cogs/give_away_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Soon</blockquote>

#### Config Name

<blockquote>give_away</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- FEATURE_MISSING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **ABORT_GIVE_AWAY**
    
    - **help:**

        NOT IMPLEMENTED

    

    
    - **aliases:** *abort+give+away*, *abort-give-away*, *abortgiveaway*, *abort.give.away*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **CREATE_GIVEAWAY**
    

    
    - **aliases:** *giveaway*, *creategiveaway*, *create-giveaway*, *create+giveaway*, *create.giveaway*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **FINISH_GIVE_AWAY**
    
    - **help:**

        NOT IMPLEMENTED

    

    
    - **aliases:** *finishgiveaway*, *finish.give.away*, *finish-give-away*, *finish+give+away*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[ImageManipulatorCog](antipetros_discordbot/cogs/general_cogs/image_manipulation_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Commands that manipulate or generate images.</blockquote>

#### Config Name

<blockquote>image_manipulation</blockquote>


#### Cog State Tags

```diff
- NEEDS_REFRACTORING

- FEATURE_MISSING

- OPEN_TODOS

+ WORKING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **ADD_FONT**
    

    
    - **aliases:** *add-font*, *add+font*, *add.font*, *addfont*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **ADD_STAMP**
    
    - **help:**

        Adds a new stamp image to the available stamps.
        
        This command needs to have the image as an attachment.

    

    
    - **aliases:** *add_image*, *add+stamp*, *add.stamp*, *add-stamp*, *addstamp*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros add_stamp
        ```
    
    <br>


- **AVAILABLE_STAMPS**
    
    - **help:**

        Posts all available stamps.

    

    
    - **aliases:** *available+stamps*, *availablestamps*, *available.stamps*, *available-stamps*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros available_stamps
        ```
    
    ![](art/finished/gifs/available_stamps_command.gif)
    
    <br>


- **GET_STAMP_IMAGE**
    

    
    - **aliases:** *get.stamp.image*, *get_image*, *get-stamp-image*, *getstampimage*, *get+stamp+image*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **LIST_FONTS**
    

    
    - **aliases:** *list+fonts*, *listfonts*, *list-fonts*, *list.fonts*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **MEMBER_AVATAR**
    
    - **help:**

        Stamps the avatar of a Member with the Antistasi Crest.
        
        Returns the new stamped avatar as a .PNG image that the Member can save and replace his orginal avatar with.
        
        Example:
            @AntiPetros member_avatar

    

    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **STAMP_IMAGE**
    
    - **help:**

        Stamps an image with a small image from the available stamps.
        
        Usefull for watermarking images.
        
        Get all available stamps with '@AntiPetros available_stamps'

    

    
    - **aliases:** *stamp.image*, *stamp+image*, *stamp-image*, *stampimage*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros stamp_image -si ASLOGO -fp bottom -sp right -so 0.5 -f 0.25
        ```
    
    <br>


- **TEXT_TO_IMAGE**
    

    
    - **aliases:** *text+to+image*, *text-to-image*, *text.to.image*, *texttoimage*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[InfoCog](antipetros_discordbot/cogs/general_cogs/info_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>WiP</blockquote>

#### Config Name

<blockquote>info</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **CODE_FILE_TO_IMAGE**
    

    
    - **aliases:** *code.file.to.image*, *code-file-to-image*, *code+file+to+image*, *codefiletoimage*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **INFO_BOT**
    

    
    - **aliases:** *infobot*, *info.bot*, *info-bot*, *info+bot*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **INFO_COMMAND**
    

    
    - **aliases:** *info+command*, *infocommand*, *info-command*, *info.command*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **INFO_GUILD**
    

    
    - **aliases:** *info+guild*, *info-guild*, *infoguild*, *info.guild*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **INFO_ME**
    

    
    - **aliases:** *info+me*, *infome*, *info.me*, *info-me*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **INFO_OTHER**
    

    
    - **aliases:** *infoother*, *info-other*, *info.other*, *info+other*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[KlimBimCog](antipetros_discordbot/cogs/general_cogs/klim_bim_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Collection of small commands that either don't fit anywhere else or are just for fun.</blockquote>

#### Config Name

<blockquote>klim_bim</blockquote>


#### Cog State Tags

```diff
+ WORKING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **CHOOSE_RANDOM**
    
    - **help:**

        Selects random items from a semi-colon(`;`) seperated list. No limit on how many items the list can have, except for Discord character limit.
        
        Amount of item to select can be set by specifying a number before the list. Defaults to selecting only 1 item. Max amount is 25.
        
        Args:
        
            choices (str): input list as semi-colon seperated list.
            select_amount (Optional[int], optional): How many items to select. Defaults to 1.
        
        Example:
            `@AntiPetros 2 this is the first item; this is the second; this is the third`

    

    
    - **aliases:** *choose-random*, *choose+random*, *chooserandom*, *choose.random*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    ![](art/finished/gifs/choose_random_command.gif)
    
    <br>


- **FLIP_COIN**
    
    - **help:**

        Simulates a coin flip and posts the result as an image of a Petros Dollar.

    

    
    - **aliases:** *flipcoin*, *flip+coin*, *coinflip*, *flip.coin*, *flip*, *flip-coin*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros flip_coin
        ```
    
    ![](art/finished/gifs/flip_coin_command.gif)
    
    <br>


- **MAKE_FIGLET**
    
    - **help:**

        Posts an ASCII Art version of the input text.
        
        **Warning, your invoking message gets deleted!**
        
        Args:
            text (str): text you want to see as ASCII Art.

    

    
    - **aliases:** *make-figlet*, *make.figlet*, *make+figlet*, *makefiglet*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros make_figlet The text to figlet
        ```
    
    ![](art/finished/gifs/make_figlet_command.gif)
    
    <br>


- **ROLL_DICE**
    
    - **help:**

        Roll Dice and get the result also as Image.
        
        All standard DnD Dice are available, d4, d6, d8, d10, d12, d20, d100.
        
        Args:
            dice_line (str): the dice you want to roll in the format `2d6`, first number is amount. Multiple different dice can be rolled, just seperate them by a space `2d6 4d20 1d4`.

    

    
    - **aliases:** *roll.dice*, *rolldice*, *roll-dice*, *roll+dice*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    ![](art/finished/gifs/roll_dice_command.gif)
    
    <br>


- **THE_DRAGON**
    
    - **help:**

        Posts and awesome ASCII Art Dragon!

    

    
    - **aliases:** *thedragon*, *the.dragon*, *the+dragon*, *the-dragon*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros the_dragon
        ```
    
    ![](art/finished/gifs/the_dragon_command.gif)
    
    <br>


- **URBAN_DICTIONARY**
    
    - **help:**

        Searches Urbandictionary for the search term and post the answer as embed
        
        Args:
        
            term (str): the search term
            entries (int, optional): How many UD entries for that term it should post, max is 5. Defaults to 1.

    

    
    - **aliases:** *urban+dictionary*, *urbandictionary*, *urban-dictionary*, *urban.dictionary*
    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros urban_dictionary Petros 2
        ```
    
    ![](art/finished/gifs/urban_dictionary_command.gif)
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[PerformanceCog](antipetros_discordbot/cogs/bot_admin_cogs/performance_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Collects Latency data and memory usage every 10min and posts every 24h a report of the last 24h as graphs.</blockquote>

#### Config Name

<blockquote>performance</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- NEEDS_REFRACTORING

- FEATURE_MISSING

- OPEN_TODOS
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **GET_COMMAND_STATS**
    

    
    - **aliases:** *get-command-stats*, *get.command.stats*, *getcommandstats*, *get+command+stats*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **INITIAL_MEMORY_USE**
    

    
    - **aliases:** *initial+memory+use*, *initialmemoryuse*, *initial-memory-use*, *initial.memory.use*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **REPORT**
    
    - **help:**

        Reports both current latency and memory usage as Graph.

    

    

    - **is hidden:** True

    - **usage:**
        ```python
        @AntiPetros report
        ```
    
    <br>


- **REPORT_LATENCY**
    

    
    - **aliases:** *report+latency*, *report-latency*, *report.latency*, *reportlatency*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **REPORT_MEMORY**
    

    
    - **aliases:** *report.memory*, *report+memory*, *reportmemory*, *report-memory*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[PurgeMessagesCog](antipetros_discordbot/cogs/discord_admin_cogs/purge_messages_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Soon</blockquote>

#### Config Name

<blockquote>purge_messages</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- FEATURE_MISSING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **PURGE_ANTIPETROS**
    

    
    - **aliases:** *purgeantipetros*, *purge+antipetros*, *purge-antipetros*, *purge.antipetros*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[RulesCog](antipetros_discordbot/cogs/discord_admin_cogs/rules_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>WiP</blockquote>

#### Config Name

<blockquote>rules</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **ALL_RULES**
    

    
    - **aliases:** *all.rules*, *all-rules*, *allrules*, *all+rules*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **BETTER_RULES**
    

    
    - **aliases:** *better-rules*, *betterrules*, *better.rules*, *better+rules*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **COMMUNITY_RULES**
    

    
    - **aliases:** *community-rules*, *community.rules*, *community+rules*, *communityrules*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **EXPLOITS_RULES**
    

    
    - **aliases:** *exploits.rules*, *exploitsrules*, *exploits-rules*, *exploits+rules*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **SERVER_RULES**
    

    
    - **aliases:** *serverrules*, *server-rules*, *server.rules*, *server+rules*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[SaveSuggestionCog](antipetros_discordbot/cogs/general_cogs/save_suggestion_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Provides functionality for each Antistasi Team to save suggestions by reacting with emojis.</blockquote>

#### Config Name

<blockquote>save_suggestion</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- NEEDS_REFRACTORING

- FEATURE_MISSING

- UNTESTED

- OPEN_TODOS

+ WORKING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **AUTO_ACCEPT_SUGGESTIONS**
    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **CLEAR_ALL_SUGGESTIONS**
    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **GET_ALL_SUGGESTIONS**
    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **MARK_DISCUSSED**
    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **REMOVE_ALL_USERDATA**
    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **REQUEST_MY_DATA**
    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **UNSAVE_SUGGESTION**
    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[SubscriptionCog](antipetros_discordbot/cogs/special_channels_cogs/subscription_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Organizes Topic so they can be subscribed and mentioned selectively.</blockquote>

#### Config Name

<blockquote>subscription</blockquote>


#### Cog State Tags

```diff
- DOCUMENTATION_MISSING

- FEATURE_MISSING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **CREATE_SUBSCRIPTION_CHANNEL_HEADER**
    

    
    - **aliases:** *create.subscription.channel.header*, *createsubscriptionchannelheader*, *create+subscription+channel+header*, *create-subscription-channel-header*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **MODIFY_TOPIC_EMBED**
    

    
    - **aliases:** *modify-topic-embed*, *modify.topic.embed*, *modify+topic+embed*, *modifytopicembed*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **NEW_TOPIC**
    

    
    - **aliases:** *newtopic*, *new.topic*, *new+topic*, *new-topic*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **REMOVE_TOPIC**
    

    
    - **aliases:** *removetopic*, *remove-topic*, *remove+topic*, *remove.topic*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **TOPIC_TEMPLATE**
    

    
    - **aliases:** *topictemplate*, *topic-template*, *topic.template*, *topic+template*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **UNSUBSCRIBE**
    

    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **UPDATE_SUBSCRIPTION_CHANNEL_HEADER**
    

    
    - **aliases:** *update.subscription.channel.header*, *update-subscription-channel-header*, *updatesubscriptionchannelheader*, *update+subscription+channel+header*
    

    - **is hidden:** True

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[TeamRosterCog](antipetros_discordbot/cogs/special_channels_cogs/team_roster_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>WiP</blockquote>

#### Config Name

<blockquote>team_roster</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **DELETE_AND_REDO_TEAM_ROSTER**
    

    
    - **aliases:** *delete-and-redo-team-roster*, *delete+and+redo+team+roster*, *deleteandredoteamroster*, *delete.and.redo.team.roster*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **FORCE_UPDATE_TEAM_ROSTER**
    

    
    - **aliases:** *force+update+team+roster*, *forceupdateteamroster*, *force.update.team.roster*, *force-update-team-roster*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **INITIALIZE_TEAM_ROSTER**
    

    
    - **aliases:** *initialize-team-roster*, *initialize.team.roster*, *initializeteamroster*, *initialize+team+roster*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **TEAM_ROSTER_CHANGE_DESCRIPTION**
    

    
    - **aliases:** *team-roster-change-description*, *team+roster+change+description*, *team.roster.change.description*, *teamrosterchangedescription*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **TEAM_ROSTER_CHANGE_EXTRA_ROLE**
    

    
    - **aliases:** *teamrosterchangeextrarole*, *team.roster.change.extra.role*, *team+roster+change+extra+role*, *team-roster-change-extra-role*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **TEAM_ROSTER_CHANGE_IMAGE**
    

    
    - **aliases:** *teamrosterchangeimage*, *team-roster-change-image*, *team.roster.change.image*, *team+roster+change+image*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **TEAM_ROSTER_CHANGE_JOIN_DESCRIPTION**
    

    
    - **aliases:** *team+roster+change+join+description*, *team.roster.change.join.description*, *team-roster-change-join-description*, *teamrosterchangejoindescription*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[TemplateCheckerCog](antipetros_discordbot/cogs/antistasi_tool_cogs/template_checker_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>soon</blockquote>

#### Config Name

<blockquote>template_checker</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **CHECK_TEMPLATE**
    
    - **help:**

        Checks all Classnames inside a provided template.
        
        Needs to have the tempalte as attachment to the invoking message.
        
        Returns the list of classnames it can't find in the config along with possible correction.
        
        Returns also a corrected version of the template file.
        
        Args:
            all_items_file (bool, optional): if it should also provide a file that lists all used classes. Defaults to True.
            case_insensitive (bool, optional): if it should check Case insentive. Defaults to False.

    

    
    - **aliases:** *checktemplate*, *check+template*, *check-template*, *check.template*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[TranslateCog](antipetros_discordbot/cogs/general_cogs/translate_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>Collection of commands that help in translating text to different Languages.</blockquote>

#### Config Name

<blockquote>translate</blockquote>


#### Cog State Tags

```diff
+ WORKING
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **AVAILABLE_LANGUAGES**
    

    
    - **aliases:** *availablelanguages*, *available+languages*, *available.languages*, *available-languages*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>


- **TRANSLATE**
    
    - **help:**

        Translates text into multiple different languages.
        
        Tries to auto-guess input language.
        
        **Warning, your invoking message gets deleted!**
        
        Args:
            text_to_translate (str): the text to translate, quotes are optional
            to_language_id (Optional[LanguageConverter], optional): either can be the name of the language or an language code (iso639-1 language codes). Defaults to "english".

    

    

    - **is hidden:** False

    - **usage:**
        ```python
        @AntiPetros translate german This is the Sentence to translate
        ```
    
    ![](art/finished/gifs/translate_command.gif)
    
    <br>



</blockquote>

</details>

---



### <p align="center"><b>[VoteCog](antipetros_discordbot/cogs/discord_admin_cogs/vote_cog.py)</b></p>

<details><summary><b>Description</b></summary>




#### Short Description

<blockquote>WiP</blockquote>

#### Config Name

<blockquote>vote</blockquote>


#### Cog State Tags

```diff
- EMPTY

- DOCUMENTATION_MISSING

- CRASHING

- OUTDATED

- FEATURE_MISSING

- UNTESTED
```

</details>

<details><summary><b>Commands</b></summary><blockquote>


- **CREATE_VOTE**
    

    
    - **aliases:** *create-vote*, *create+vote*, *create.vote*, *createvote*
    

    - **is hidden:** False

    - **usage:**
        ```python
        None
        ```
    
    <br>



</blockquote>

</details>

---


</blockquote></details>



---

## Dependencies



**Developed with Python Version `3.9.1`**

### Python dependencies


- **Jinja2** *2.11.2*

- **Markdown** *3.3.4*

- **Pillow** *8.1.2*

- **PyGithub** *1.54.1*

- **Pygments** *2.8.1*

- **WeasyPrint** *52.2*

- **aiohttp** *3.7.3*

- **aiosqlite** *0.16.1*

- **antistasi_template_checker** *0.1.1*

- **arrow** *0.17.0*

- **async_property** *0.2.1*

- **asyncstdlib** *3.9.0*

- **beautifulsoup4** *4.9.3*

- **click** *7.1.2*

- **cryptography** *3.3.1*

- **dateparser** *1.0.0*

- **dpytest** *0.0.22*

- **emoji** *1.1.0*

- **fuzzywuzzy** *0.18.0*

- **gidappdata** *0.1.13*

- **gidconfig** *0.1.16*

- **gidlogger** *0.1.9*

- **googletrans** *4.0.0rc1*

- **humanize** *3.2.0*

- **icecream** *2.0.0*

- **imgkit** *1.1.0*

- **marshmallow** *3.10.0*

- **matplotlib** *3.3.3*

- **psutil** *5.8.0*

- **pyfiglet** *0.8.post1*

- **python-youtube** *0.7.0*

- **python_a2s** *1.3.0*

- **python_dotenv** *0.15.0*

- **pytz** *2020.5*

- **rich** *9.13.0*

- **tldextract** *3.1.0*

- **validator_collection** *1.5.0*

- **watchgod** *0.6*

- **webdavclient3** *3.14.5*


### External dependencies


- [Cairo](https://www.cairographics.org/)
    - __Windows__
        follow these instructions `https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer`

    - __Unix__
        sudo apt-get install -y libcairo2-dev

- [Pango](https://pango.gnome.org/)
    - __Windows__
        Follow this `https://github.com/ImageMagick/pango`

    - __Unix__
        sudo apt-get install -y libsdl-pango-dev



---

## License

MIT

---

## Development



### Future Plans


- __pr logging__

    > PR team cog for all the logging, Youtube twitch twitter.

- __database__

    > migrating all the json files to an sql lite DB

- __startup info__

    > auto updating server info in startup info, need to figure out how to seperate development from production with this one

- __github wiki__

    > Automatically create and modify github Wiki

- __auto reaction regex__

    > add an item that can auto react with an emoji to an regex pattern in message

- __auto message cog__

    > add an cog that works like auto reactions but does other things when triggered (than just emojis)




---

## See also



### Links


- [Antistasi Website](https://a3antistasi.enjin.com/)

- [Antistasi Steam Workshop Items](https://steamcommunity.com/id/OfficialAntiStasiCommunity/myworkshopfiles/)

- [A3 Antistasi Official Discord Server](https://discord.gg/8WNsueDKf5)