Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Added "Available on Modrinth"
- Added a Preview.
  • Loading branch information
Ayont authored Jan 1, 2025
1 parent 8189be2 commit b8bbfb5
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
![V-Discord-Intergration](https://cdn.modrinth.com/data/cached_images/6eddb7b31cf0eeed5156ae4c6ac961da2f02aa7a_0.webp)
![Discord](https://img.shields.io/discord/1322873747535040512)
![Build Status](https://img.shields.io/github/actions/workflow/status/Varilx-Development/VDiscordIntegration/build.yml?branch=main)
![Release](https://img.shields.io/github/v/release/Varilx-Development/VDiscordIntegration)
![V-Discord-Intergration](https://cdn.modrinth.com/data/cached_images/6eddb7b31cf0eeed5156ae4c6ac961da2f02aa7a_0.webp)
<p align="center">
<a href="https://modrinth.com/plugin/vdiscord-intergration">
<img src="https://raw.githubusercontent.com/vLuckyyy/badges/main/avaiable-on-modrinth.svg" alt="Available on Modrinth" />
</a>
</p>

# VDiscord Integration Configuration
# V-Discord Intergration | Simple Discord Chatbridge

A discord chat bridge between minecraft and discord and vice versa
A discord chat bridge between minecraft and discord.

---

## Preview

![preview](https://cdn.modrinth.com/data/dff6O7s8/images/e02e62cd902580828c28580e0e8b571e97e81a09.gif)

## Configuration Overview

Expand All @@ -32,6 +40,16 @@ We currently support: `de` and `en`
### 5. **Commands**
Configure responses for commands like `/discord link` and `/discord reload`.

### 6. **Permissions**
`discord.link`

Allows the user to link their discord account with their minecraft account.


`discord.reload`

Allows the user to reload configurations.

---

## Setup Instructions
Expand Down Expand Up @@ -94,6 +112,7 @@ role-sync:
## Example Message Configuration

```yaml

# Using Minimessage https://docs.advntr.dev/minimessage/format.html

prefix: "<b><gradient:#08FB22:#BBFDAD>[VDiscord]</gradient></b><reset><!i><gray> " # This prefix can be used anywhere as "<prefix>"
Expand Down Expand Up @@ -141,6 +160,7 @@ commands:
disabled: "<prefix><red>This feature is disabled"
format: "<prefix>This command doesnt exists, use the /discord link command"
code-sent: "<prefix>To link your discord account, send the following code to the DiscordBot: <click:copy_to_clipboard:<code>><hover:show_text:Click here to copy><yellow><code></yellow> (click to copy)"

```

---
Expand Down

0 comments on commit b8bbfb5

Please sign in to comment.