https://github.com/viral32111/discord-relay

Minecraft mod to relay chat messages between Minecraft & Discord.
https://github.com/viral32111/discord-relay

discord-bot fabricmc minecraft-mod

Last synced: 11 days ago
JSON representation

Minecraft mod to relay chat messages between Minecraft & Discord.

• Host: GitHub
• URL: https://github.com/viral32111/discord-relay
• Owner: viral32111
• License: agpl-3.0
• Created: 2021-06-21T13:55:18.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-01T21:50:08.000Z (8 months ago)
• Last Synced: 2024-04-01T22:42:19.473Z (8 months ago)
• Topics: discord-bot, fabricmc, minecraft-mod
• Language: Kotlin
• Homepage:
• Size: 402 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Discord Relay

[![CI](https://github.com/viral32111/discord-relay/actions/workflows/ci.yml/badge.svg)](https://github.com/viral32111/discord-relay/actions/workflows/ci.yml)

[![CodeQL](https://github.com/viral32111/discord-relay/actions/workflows/codeql.yml/badge.svg)](https://github.com/viral32111/discord-relay/actions/workflows/codeql.yml)

![GitHub tag (with filter)](https://img.shields.io/github/v/tag/viral32111/discord-relay?label=Latest)

![GitHub repository size](https://img.shields.io/github/repo-size/viral32111/discord-relay?label=Size)

![GitHub release downloads](https://img.shields.io/github/downloads/viral32111/discord-relay/total?label=Downloads)

![GitHub commit activity](https://img.shields.io/github/commit-activity/m/viral32111/discord-relay?label=Commits)

This is a [Minecraft Fabric](https://fabricmc.net/) mod that relays in-game chat messages to & from a Discord channel, allowing for easy communication between players on a Minecraft server & members in a Discord server.

This mod depends on [my Events mod](https://github.com/viral32111/events) for mixin callbacks.

## 📅 History

Development of the [Paper](https://papermc.io/) plugin concluded in June of 2021. It is still available on the [paper branch](https://github.com/viral32111/discord-relay/tree/paper) and [0.2.0 release](https://github.com/viral32111/discord-relay/releases/tag/0.2.0).

## 📥 Usage








1. Download the JAR file from [the latest release](https://github.com/viral32111/discord-relay/releases/latest).

2. Download [my Events mod](https://github.com/viral32111/events).

3. Place the JAR files in the server's `mods` directory.

4. Start the server to initialise the mod for the first time.

5. Configure appropriately in the `config/viral32111/discordrelay.json` file.

6. Restart the server.

## ⚖️ License

Copyright (C) 2021-2023 [viral32111](https://viral32111.com).

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU Affero General Public License as

published by the Free Software Foundation, either version 3 of the

License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License

along with this program. If not, see https://www.gnu.org/licenses.