# Minecat

Minecat is a Discord Bot to connect Minecraft with Discord, it works with [SpigotMC](https://www.spigotmc.org)/[PaperMC](https://www.papermc.io)/[Bukkit](https://dev.bukkit.org) compatible Minecraft servers.
The plugin download can be found on SpigotMC's [resources page](https://www.spigotmc.org/resources/minecat.98640/)

## Current Features

The current features connected with Minecraft (may not be updated) include

- See chat from Minecraft in Discord
- See chat from Discord (specified channel) in Minecraft
- See advancements from Minecraft in Discord
- See join messages from Minecraft in Discord
- See leave messages from Minecraft in Discord

## Demonstration images

![Minecat in Discord and Minecraft, side by side](https://i.imgur.com/NtiWxsg.png)

This is Minecat in Minecraft and Discord

![Minecat used in Minecraft](https://i.imgur.com/YIbQHkM.png)

this is Minecraft side, blue means an unlinked account

![Minecat used in discord with advancements and join/leave messages](https://i.imgur.com/uC7xrJt.png)

this is Discord side, **[bot]** means from Minecraft

![An unlinked account with minecat](https://i.imgur.com/GVI6JjR.png)

This is an unlinked account, represented with their Minecraft avatar/profile picture

![Player having fun with minecat](https://i.imgur.com/Hdm4EXr.png)

This is another unlinked account who likes minecat (they should link sometime)

## Current List of Commands

An `argument` may also be referred to as a `parameter`.
For example, `!ban @user` - `@user` is the `argument`/`parameter` to the command `ban`.

- `command <argument>`

  - This is a required argument
  - `command abc` is valid
  - `command` is invalid

- `command [argument]`

  - This is an optional argument
  - `command abc` is valid
  - `command` is also valid

- `command [arg...]`

  - This is a list argument
  - `command a b c` is valid
  - `command` is also valid

- `command {a|b}`

  - This is a choice argument
  - `command a` is valid
  - `command c` is invalid

### About

- `mc help [command]`
  - Sends info about a command/category/group
  - `command` is an optional argument - what you want to search
  - If `command` is not specified, the overall help command is sent

- `mc invite`
  - Sends the Discord OAuth2 invite link to add to your server

 - `mc plugin`
  - Sends the [resource page](https://www.spigotmc.org/resources/minecat.98640/) for the minecat plugin

### Config

- `mc prefix <prefix>`
  - Changes the prefix for this server
  - `prefix` is a required argument - the new prefix
  - This requires admin or manage server permissions
  - Mention prefix will always be available

### Link

- `mc {linkserver|link-server|ls|connectserver} [uuid]`
  - Links your Minecraft server with minecat
  - `uuid` is an optional argument - your Minecraft server's uuid, set by the plugin
  - If `uuid` is not specified, how to get the plugin is [linked](https://www.spigotmc.org/resources/minecat.98640/)

- `mc {linkuser|link-user|connect|lu} [code]`
  - Links your Minecraft server with Discord
  - `code` is an optional argument - your Minecraft account's secret code sent from the server
  - If code is not specified, how to get your secret code is [linked](https://www.spigotmc.org/resources/minecat.98640/)

## Donation

[`:)`](https://paypal.me/tootybot)
<style>:root {--brand: 137,87,255; --brand-raw: #8957ff; --top-gg-colors-ui-100: var(--top-gg-colors-purple-900); --top-gg-colors-brand-100: var(--top-gg-colors-purple-900);} ::-webkit-scrollbar-thumb {background: var(--top-gg-colors-purple-400);} ::-webkit-scrollbar-thumb {background: var(--top-gg-colors-purple-400);} .chakra-button {background-color: var(--top-gg-colors-purple-600); color: #fff;} .chakra-button:hover {background-color: var(--top-gg-colors-purple-800); color: #fff;} .css-1xyu927 {color: #fff;}</style>

minecat

Connect Minecraft with Discord! Send messages from Discord to Minecraft and back :) View achievements, joins and leaves from Minecraft!

التصويت لـminecat

هل ترغب في دعمنا؟