__***Welcome to 'Kumo The Dog' - A chatbot made for asking anything you could possibly imagine!***__  
 **Noteworthy features:**  
• The ability to talk in VOICE or TEXT CHANNELS.  
• Slash commands, message content is not stored to respect user privacy :)  
• Real-Time responsiveness, minimal latency  
• Global Leaderboards  
• **Games** (mainly `1` and `2` player)  

And much more as development progresses.  

At first, the bot was designed as a simple chatbot but becoming immersed with discord.js made me realise the sheer versatility that can be achieved by using it!

A brief explanation of the current features found in Kumo can be found below, alongside the README located in my GitHub:  

- **/help**: Opens a direct message channel, sending all the commands mentioned below alongside an **invite link**, link to the **support server** and a **top.gg** page link, which can also be found at the bottom of this README!

- **/askkumo** `questions`: Talk to Kumo within a text channel.

  A question must be inputted by the user to which Kumo replies in the current text channel.

  A cooldown of 10 seconds has been applied to all users to reduce spam, allowing Kumo to think more about your questions! Upon answering, your leaderboard score is increased.

- **/callkumo**: While in a voice channel, call Kumo into the VC to talk to him directly.

  Operates on speaker updates - The bot listens while a user is talking, providing an appropriate response into the voice channel once finished.
  Base voicelines have been added but I plan to introduce some funnier ones down the line.

  Upon initial call, Kumo responds to the user who activates the command.

  To reduce spamming and the chance for users to get easy points, there is a cooldown of 8 seconds in every voice channel. When a question is asked, the user who asked it gets leaderboard points - the rest must wait for the next chance!

- **/kickkumo**: Simply kick Kumo from the VC - plays a hanging up sound and leaves immediately after. Be sure to kick Kumo, otherwise the bot may stay around in your server all day!

- **/kumopoll `question` `response1` `response2` `total_responses`**: Create a simple two way poll, comprising of a custom question, your two responses and the threshold for which the poll closes as users answer.

- **/leaderboard**: Create a global leaderboard containing the current standings of who has used Kumo the most! Currently shows the top 5 text and voice users in separate leaderboards, as well as your current position if you are not in the top 5. Fight with others to prove who has the strongest bond with Kumo!

- **/kumoinfo**: Find out some miscellaneous statistics about Kumo! Tells you the versions of the core packages used, runtime since last restart alongside the total number of guilds + users in all these guilds.

- **/kumomatch `opponent` `playercolour` `opponentcolour`**: Start a game of Kumo Match! You have the option to play by yourself but I obviously recommend playing with 2 people. The game works by matching the chips corresponding to your colour. You must match **5** of these chips in a row, either horizontally, vertically or diagonally. I MAY add the ability to give extra leaderboard points to the winner but I'm not sure now.

- **/kumoline `opponent` `playercolour` `opponentcolour`**: Start a game of Kumo Line! Quite similar to Match but instead of 5 chips you must match 3 hearts in any direction BUT you can place these hearts in any position in the grid.

- **/kumorps `opponent [OPTIONAL]`**: Begin a short game of Kumo RPS. If no opponent is specified then you start the game playing against Kumo! If a user IS given, dm's are sent to both users asking them to select their choice, which is then collected and placed into a main embed.  

- **/kumoduel `opponent` `basehp`**: Challenge a user to Kumo Duel! Base game + items finished on 10/06/22. Intended to be a turn based fighting game, with player inventories and transcripts.

  - **Items**:
    - **Red Apple**: _A shiny red apple!_ - Restores a constant **60** HP and consumes your turn, passing it to the opponent.
    - **Brown Broom**: _A dusty brown broom. Looks like its been taken out of a janitor closet..._ - Increases your attack by **30%**! However, the damage inflicted when fighting is determined by RNG, so you still may get bad damage :)
    - **Shadow Cloak**: _A rich, dark hued cloak. So disguised that you have to squint to see!_ - Attack normally, putting on the cloak after - this increases your evasion for **1** turn, meaning that the opponent has a **70%** chance of missing their next attack.
    - **Blackcurrant Jam**: _A sample of blackcurrant jam - has colours so rich you could stare at it all day._ - Adds to your current HP a value determined by - your current HP + **10-60%** of said current HP
    - **Hacker's Laptop**: _A 30 year old laptop found on top of a bin. You can't identify the distro it uses._ - Upon use, you have a **10%** chance of ending the duel completely, winning by default. But if you miss, you do no damage to the opponent and open yourself to a free hit.
    - **Coin-Filled Wallet**: _A smooth leather wallet which seems to only be filled with pennies?_ Increases your base attack by however many coins are found in your current wallet - 1 for each coin.

  Keep in mind that for attack-based items, you can still miss the attack completely and your item WILL get consumed with no effect. The only exception to this would be the **Shadow Cloak**, where if you miss, you still put the cloak on to recieve higher evasion.  
  Health-based items are guaranteed to restore, no matter what.

  - **Log Files**:
    - As the duel progress, each turn is saved into a **transcript**, represented using an array, which can then be viewed at the end of the duel inside an ephemeral embed if anyone wants to.
    - The embed displays information such as the items initially held by both users, the amount of turns each user managed to complete and the transcript itself.
  - **Duel Timeout**:

    - For this duel, there are some conditions which warrant a timeout to occur - if this happens, the duel is treated as **abandoned** with no clear winner. Timeouts happen when:

      - The opponent doesn't respond to the initial confirmation.
      - The first player doesn't make a move within 30 seconds.
      - After the first move, no players move within 2 minutes.

    - If a timeout happens, a log file is **NOT** sent.
    - Timeouts can also be extended to the context of the games mentioned above, in that those also have the timeout mechanic implemented, resulting in no clear winner if a timeout should occur.

- **/kumoratio `user`**: Begin a ratio, either directed at a specific user, yourself, the bot or indirectly within a text channel. The ratio begins with a 30 second timer and stops recording contributors after this timer runs out. BUT, every new contributor extends the timer by another 30 seconds! Different responses depending on the success rate of the overall ratio.

- **/feedback**: Provide some helpful feedback to me! Opens a modal in which you must answer what you have enjoyed upon using the bot, any future implementation you would like to see as well as any bugs you have found.

More will soon come as new ideas roll out!

**When I have time I plan to**:

- Create a basic website for Kumo displaying the commands in action alongside displaying miscellaneous links to invite Kumo to your server and its stats.
- More accurate voice recognition - perhaps Kumo can respond to specific questions beginning with a certain command word, like its name?
- Work on creating a more elegant design for Kumo overall, by improving the quality of the pictures!
- Add some new commands, like Kumo's activities( /(total users/servers, runtime stats)...) and interactive games made using Discord JS. WORK IN PROGRESS: I am coming up with command ideas right now!

Hope you enjoy using Kumo! ૮ ˶´ ᵕˋ ˶ა  
- ***Saracen***.

Kumo The Dog

VERIFIED! Ask Kumo anything you want!! Talk to Kumo in VOICE or TEXT CHANNELS. • Slash Commands • Real-Time Feedback • Global Leaderboards

Voting for Kumo The Dog