https://github.com/lillyschramm/minecord

A Spigot Plugin that connects your server chat with a discord channel.
https://github.com/lillyschramm/minecord

dicord-bot discord minecraft minecraft-plugin minecraft-server papermc papermc-plugin spigot spigot-plugin

Last synced: about 2 months ago
JSON representation

A Spigot Plugin that connects your server chat with a discord channel.

• Host: GitHub
• URL: https://github.com/lillyschramm/minecord
• Owner: LillySchramm
• License: mit
• Created: 2022-03-30T21:40:08.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-08T19:50:05.000Z (6 months ago)
• Last Synced: 2024-10-30T04:29:04.364Z (3 months ago)
• Topics: dicord-bot, discord, minecraft, minecraft-plugin, minecraft-server, papermc, papermc-plugin, spigot, spigot-plugin
• Language: Java
• Homepage:
• Size: 94.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Minecord

A Spigot Plugin that connects your server chat with a discord channel.

## Features

- Connects your in game chat with a channel on your discord server.


![img](https://github.com/LillySchramm/Minecord/blob/main/docs/img.png?raw=true)

- Displays the current player count.


![img](https://github.com/LillySchramm/Minecord/blob/main/docs/img2.png?raw=true)

- Link your in-game username to your discord account.

## Requirements

- A minecraft spigot/paper server with the version 1.18+

- A discord bot token. (How to get one is described in the next section)

- A discord server that you have admin access to

## Installation

### Getting the Bot Token

- Open the discord developer portal at [https://discord.com/developers/applications](https://discord.com/developers/applications)

- Click on 'New Application'

- Give it a name you like. The name of the application does set the bots' name so just chose one you like.

- Take note of the `Application ID` shown. It looks like this: `95997070327569420`.

- Then navigate to 'Bot' and click 'Add Bot'.

- Click `Reset Token`. Take note of the generated token as this will be the one you need for the plugin to work.

- Scroll down and toggle `Message Content Intent` to be active.

- Now visit `https://discord.com/api/oauth2/authorize?client_id=&scope=bot&permissions=2048`.

- There you just chose the server the bot should get added too.

- DONE! Now you should see your bot as an Offline user.

### Plugin Setup

- Download the [latest release](https://github.com/LillySchramm/Minecord/releases/latest)

- Put it in your servers `plugins/` folder

- Start your server one. The plugin should crash because it has no token.

- Edit the generated `config.yml` in the `plugins/Minecord` folder.

- Replace 'aToken' with your discord bot token.

- You also have to set the `channel_id` to the one you want to sync into.

- Restart the server.

- DONE! Now your bot should be online, and it should mirror the contents of your servers.

## Updating

Just replace the minecord-x.x.x.jar file with the [latest one](https://github.com/LillySchramm/Minecord/releases/latest)

## Commands

- `/linkDiscord` Link your discord account to your minecraft name.

- `/unlinkDiscord` Remove the link to your discord account.