quiltservertools / blockbot Goto Github PK

View Code? Open in Web Editor NEW

27.0 3.0 22.0 615 KB

A Minecraft - Discord chat linking mod

License: Creative Commons Zero v1.0 Universal

Java 22.25% Kotlin 77.75%

minecraft discord-bot

blockbot's Introduction

BlockBot

A Minecraft - Discord chat linking mod

Initial Configuration

Start the server to create a config file. Complete the config file (can be found in `config/blockbot-discord.toml) with the following relevant data (Bot token, Guild ID, chat channel ID)

[bot]
# Discord Bot token
token = ""
# Discord guild/server id
guild =

    # Channel IDs for the bot to use. Only the `chat` channel is required, others can be added or deleted
    [bot.channels]
    # Chat relay channel
    chat =

A full list of options can be found in the configuration file.

License

BlockBot is available under the GNU LGPL v3.0 license. See LICENSE

blockbot's People

Contributors

Stargazers

Watchers

Forkers

james76931 cmdrnorthpaw avikav idortnocode patbox altirix voidlighter samolego oliver-makes-code inventory-profiles-next skynetcloud drexhd epolixa nocomment1105 hexxycraft anaxios lackingcats genau6502

blockbot's Issues

Feature request: able to ping players, roles or everyone from Minecraft chat without having to type out someone's user ID

I'd like to just type out @whoever instead of having to copy their user ID, then type <@123456789>, you gotta understand. XD

Feature request: able to use Groovy commands using in game chat

Oh c'mon, this screenshot is just pure sadness. You guys gotta consider this.

[Feature request] Show skins set with mods like Fabrictailor

Unsure of how difficult this would be, but I have a server that uses Fabric Tailor and when players set a custom skin using it, the discord link doesn't update to use that skin, and uses the default skin for that player instead.
Not that big of an issue, and if it's not possible it's fine, but if there is any possibility of this happening it would be appreciated.

kotlinx.serialization.MissingFieldException

BlockBot build: https://github.com/QuiltServerTools/BlockBot/actions/runs/2637088202
Error: https://mclo.gs/Gch7uf1

This error only occurs when someone joins/leaves the voice channel. It's almost the same with other events, such as a user joining a guild.

Messages produced by `/random roll` aren't relayed to Discord.

Is your feature request related to a problem?

Output messages produced from players who run /random roll don't get sent to Discord.

Describe the solution you'd like.

As the message is seen by all online players in-game, I would expect it to be relayed to Discord also.

Describe alternatives you've considered.

There is no alternative as I cannot control or detect what messages players send.

Agreements

I have searched for and ensured there isn't already an open issue regarding this.
I have ensured the feature I'm requesting isn't already in the latest supported mod version.

Feature Request: An API to write different backends for different chat programs, possibly with some way to indicate what features that backend supports

The idea is I'd be able to write another mod that would tell BlockBot what features it supports (IE, skins for avatars, embeds, etc.) and then configure BlockBot to use that backend instead of the built-in Discord one. This could be used for writing Slack, IRC, etc. bridges without having to modify BlockBot itself or write a mod from scratch.

Blockbot ignores player skin changes

Is this gonna get 1.18.1 update

I was wondering if this mod has a working 1.18.1 version just yet?

[Feature Request] Ability to link your Discord account to your Minecraft account

Linking can either be optional or required. If optional it's initiated by an in-game command, if non-optional, it's started on join.

When the user runs the command/gets kicked, they are sent a code (via command or kick message), which they can then DM to the Discord bot, linking their accounts. Among other things, this is more secure than a simple !whitelist command because players can only "whitelist" accounts that they have access to. It also avoids having to use the vanilla whitelist, which, as discussed in Discord, is cursed.

If forcing players to have linked accounts to join is on, this behaviour is disabled if the whitelist is enabled, so you can block people from joining even if their account is linked, and players on the whitelist don't have to have their account linked to join. This would be useful for quickly setting the server to staff-only while doing maintenance. There could also be an option to always let whitelisted players and/or ops through, even if the player is not linked.

Linked accounts get the following features (preferably configurable):

Players with linked accounts can get a role on Discord
Players can only join if they have a given role assigned (useful for a Twitch/Patreon server, for example, obviously only works if account linking is forced)
Players can only join if they are in a specific guild (or in one of a list of guilds)
Linked players can have their Discord nickname set to their Minecraft username
Roles on Discord can sync to a LuckPerms etc. permission group.
Minecraft Bans and Discord bans can sync.

[Feature request] Completely customisable messages in Discord

Similar to how DiscordSRV allows just about everything to be configured for the messages sent to Discord, BlockBot could support something similar.

My idea would be something like this:
Each message corresponds to some form of template file in the configuration directory (eg. config/blockbot-discord/messages/player_join.toml) that allows placeholders to be used (like the current beta config does) but also supports things like changing whether an embed is used or the username and avatar url of the webhook.

I'd be happy to implement something like this and open a pull request, but I thought it would be better to open an issue for discussion first.

Errors using minimal set of mods

latest.log

Config appears to be valid, only fabric language Kotlin and fabric API are present.

[Feature Request] Add support for FabricTailor skins

Display FabricTailor heads on discord.
Hope it is possible, thanks!

Support for vanish mods