Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AviiNL committed Feb 29, 2024
1 parent bc8722c commit 58d7097
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Mosquito Swatter

A minesweeper clone for discord but instead of mines, you'll get stung by a mosquito.

# Invite link

[Add to your server](https://discord.com/oauth2/authorize?client_id=1212506405240836199&scope=bot)

The bot does not require any permissions aside from "create slash commands"

# Usage

In any channel to bot has access to use the `/mosquitoswatter` command

# Options

- `width` Width of the board, between 3 and 11 (default: 11)
- `height` Height of the board, between 3 and 9 (default: 9)
- `mosquitos` Amount of mosquitos, between 1 and (width*height-1) (default: 10)
- `private` Reply with a message only you can see (default: true)

# FAQ:

Q: The board is completely revealed when I issue the command!

A: The bot makes use of discords spoiler tags, make sure they don't auto-reveal in "User Settings -> Chat -> Show Spoiler Content"

0 comments on commit 58d7097

Please sign in to comment.