mirror of
https://github.com/MCCTeam/Minecraft-Console-Client
synced 2025-10-14 21:22:49 +00:00
Transalted and added detailed comments and instructions and a reference to the documentation article.
Fully tested, ready for merge.
This commit is contained in:
parent
148cb34878
commit
12b317644d
3 changed files with 34 additions and 9 deletions
|
|
@ -24,13 +24,22 @@ namespace MinecraftClient.ChatBots
|
||||||
|
|
||||||
public bool Enabled = false;
|
public bool Enabled = false;
|
||||||
|
|
||||||
|
[TomlInlineComment("$config.ChatBot.DiscordBridge.Token$")]
|
||||||
public string Token = "your bot token here";
|
public string Token = "your bot token here";
|
||||||
|
|
||||||
|
[TomlInlineComment("$config.ChatBot.DiscordBridge.GuildId$")]
|
||||||
public ulong GuildId = 1018553894831403028L;
|
public ulong GuildId = 1018553894831403028L;
|
||||||
|
|
||||||
|
[TomlInlineComment("$config.ChatBot.DiscordBridge.ChannelId$")]
|
||||||
public ulong ChannelId = 1018565295654326364L;
|
public ulong ChannelId = 1018565295654326364L;
|
||||||
|
|
||||||
public ulong[]? OwnerIds = new[] { 978757810781323276UL };
|
[TomlInlineComment("$config.ChatBot.DiscordBridge.OwnersIds$")]
|
||||||
|
public ulong[]? OwnersIds = new[] { 978757810781323276UL };
|
||||||
|
|
||||||
|
[TomlPrecedingComment("$config.ChatBot.DiscordBridge.Formats$")]
|
||||||
|
public string PrivateMessageFormat = "**[Private Message]** {username}: {message}";
|
||||||
|
public string PublicMessageFormat = "{username}: {message}";
|
||||||
|
public string TeleportRequestMessageFormat = "A new Teleport Request from **{username}**!";
|
||||||
}
|
}
|
||||||
|
|
||||||
public override void Initialize()
|
public override void Initialize()
|
||||||
|
|
@ -55,7 +64,7 @@ namespace MinecraftClient.ChatBots
|
||||||
if (_channel != null)
|
if (_channel != null)
|
||||||
_client.SendMessageAsync(_channel, new DiscordEmbedBuilder
|
_client.SendMessageAsync(_channel, new DiscordEmbedBuilder
|
||||||
{
|
{
|
||||||
Description = $"Disconnected from the MCC!",
|
Description = Translations.TryGet("bot.DiscordBridge.disconnected"),
|
||||||
Color = new DiscordColor(0xFF0000)
|
Color = new DiscordColor(0xFF0000)
|
||||||
}).Wait();
|
}).Wait();
|
||||||
|
|
||||||
|
|
@ -75,12 +84,12 @@ namespace MinecraftClient.ChatBots
|
||||||
bool teleportRequest = false;
|
bool teleportRequest = false;
|
||||||
|
|
||||||
if (IsPrivateMessage(text, ref message, ref username))
|
if (IsPrivateMessage(text, ref message, ref username))
|
||||||
message = $"**[Private Message]** {username}: `{message}`";
|
message = Config.PrivateMessageFormat.Replace("{username}", username).Replace("{message}", message).Replace("{timestamp}", GetTimestamp()).Trim();
|
||||||
else if (IsChatMessage(text, ref message, ref username))
|
else if (IsChatMessage(text, ref message, ref username))
|
||||||
message = $"{username}: `{message}`";
|
message = Config.PublicMessageFormat.Replace("{username}", username).Replace("{message}", message).Replace("{timestamp}", GetTimestamp()).Trim();
|
||||||
else if (IsTeleportRequest(text, ref username))
|
else if (IsTeleportRequest(text, ref username))
|
||||||
{
|
{
|
||||||
message = $"A new Teleport Request from **{username}**";
|
message = Config.TeleportRequestMessageFormat.Replace("{username}", username).Replace("{timestamp}", GetTimestamp()).Trim();
|
||||||
teleportRequest = true;
|
teleportRequest = true;
|
||||||
}
|
}
|
||||||
else message = text;
|
else message = text;
|
||||||
|
|
@ -169,7 +178,7 @@ namespace MinecraftClient.ChatBots
|
||||||
if (e.Channel.Id != Config.ChannelId)
|
if (e.Channel.Id != Config.ChannelId)
|
||||||
return;
|
return;
|
||||||
|
|
||||||
if (!Config.OwnerIds!.Contains(e.Author.Id))
|
if (!Config.OwnersIds!.Contains(e.Author.Id))
|
||||||
return;
|
return;
|
||||||
|
|
||||||
string message = e.Message.Content.Trim();
|
string message = e.Message.Content.Trim();
|
||||||
|
|
@ -185,7 +194,7 @@ namespace MinecraftClient.ChatBots
|
||||||
|
|
||||||
await e.Message.DeleteOwnReactionAsync(DiscordEmoji.FromName(_client, ":gear:"));
|
await e.Message.DeleteOwnReactionAsync(DiscordEmoji.FromName(_client, ":gear:"));
|
||||||
await e.Message.CreateReactionAsync(DiscordEmoji.FromName(_client, ":white_check_mark:"));
|
await e.Message.CreateReactionAsync(DiscordEmoji.FromName(_client, ":white_check_mark:"));
|
||||||
await e.Message.RespondAsync($"The command was executed with the result:\n```{result}```");
|
await e.Message.RespondAsync($"{Translations.TryGet("bot.DiscordBridge.command_executed")}:\n```{result}```");
|
||||||
}
|
}
|
||||||
else SendText(message);
|
else SendText(message);
|
||||||
};
|
};
|
||||||
|
|
@ -204,7 +213,7 @@ namespace MinecraftClient.ChatBots
|
||||||
|
|
||||||
await _client.SendMessageAsync(_channel, new DiscordEmbedBuilder
|
await _client.SendMessageAsync(_channel, new DiscordEmbedBuilder
|
||||||
{
|
{
|
||||||
Description = $"Succesfully connected with the MCC!",
|
Description = Translations.TryGet("bot.DiscordBridge.connected"),
|
||||||
Color = new DiscordColor(0x00FF00)
|
Color = new DiscordColor(0x00FF00)
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -597,6 +597,14 @@ bot.autoRespond.match=match: {0}\nregex: {1}\naction: {2}\nactionPrivate: {3}\na
|
||||||
# ChatLog
|
# ChatLog
|
||||||
bot.chatLog.invalid_file=Path '{0}' contains invalid characters.
|
bot.chatLog.invalid_file=Path '{0}' contains invalid characters.
|
||||||
|
|
||||||
|
# DiscordBridge
|
||||||
|
bot.DiscordBridge.command_executed=The command was executed with the result
|
||||||
|
bot.DiscordBridge.connected=Succesfully connected with MCC!
|
||||||
|
bot.DiscordBridge.missing_token=Please provide a valid token!
|
||||||
|
bot.DiscordBridge.guild_not_found=The provided guild/server with an id '{0}' has not been found!
|
||||||
|
bot.DiscordBridge.channel_not_found=The provided channel with an id '{0}' has not been found!
|
||||||
|
bot.DiscordBridge.unknown_error=An unknown error has occured!
|
||||||
|
|
||||||
# Mailer
|
# Mailer
|
||||||
bot.mailer.init=Initializing Mailer with settings:
|
bot.mailer.init=Initializing Mailer with settings:
|
||||||
bot.mailer.init.db= - Database File: {0}
|
bot.mailer.init.db= - Database File: {0}
|
||||||
|
|
@ -904,6 +912,14 @@ config.ChatBot.AutoRespond.Match_Colors=Do not remove colors from text (Note: Yo
|
||||||
# ChatBot.ChatLog
|
# ChatBot.ChatLog
|
||||||
config.ChatBot.ChatLog=Logs chat messages in a file on disk.
|
config.ChatBot.ChatLog=Logs chat messages in a file on disk.
|
||||||
|
|
||||||
|
# ChatBot.DiscordBridge
|
||||||
|
config.ChatBot.DiscordBridge=This bot allows you to send and recieve messages and commands via a Discord channel.\n# For Setup you can either use the documentation or read here (Documentation has images).\n# Documentation: https://mccteam.github.io/guide/chat-bots.html#discord-bridge\n# Setup:\n# First you need to create a Bot on the Discord Developers Portal, here is a video tutorial: https://www.youtube.com/watch?v=2FgMnZViNPA .\n# IMPORTANT: When creating a bot, you MUST ENABLE "Message Content Intent" and "Presence Intent" in order for bot to work! Also follow along carefully do not miss any steps!\n# When making a bot, copy the generated token and paste it here in "Token" field (tokens are important, keep them safe).\n# Copy the "Application ID" and go to: https://bit.ly/2Spn2Q3 .\n# Paste the id you have copied and check the "Administrator" field in permissions, then click on the link at the bottom.\n# This will open an invitation menu with your servers, choose the server you want to invite the bot on and invite him.\n# Once you've invited the bot, go to your Discord client and go to Settings -> Advanced and Enable "Developer Mode".\n# Exit the settings and right click on a server you have invited the bot to in the server list, then click "Copy ID", and paste the id here in "GuildId".\n# Then right click on a channel where you want to interact with the bot and again right click -> "Copy ID", pase the copied id here in "ChannelId".\n# And for the end, send a message in the channel, right click on your nick and again right click -> "Copy ID", then paste the id here in "OwnersIds".\n# How to use:\n# To execute an MCC command, prefix it with a dot ".", example: ".move 143 64 735" .\n# To send a message, simply type it out and hit enter.
|
||||||
|
config.ChatBot.DiscordBridge.Token=Your Discord Bot token.
|
||||||
|
config.ChatBot.DiscordBridge.GuildId=The ID of a server/guild where you have invited the bot to.
|
||||||
|
config.ChatBot.DiscordBridge.ChannelId=The ID of a channel where you want to interact with the MCC using the bot.
|
||||||
|
config.ChatBot.DiscordBridge.OwnersIds=A list of IDs of people you want to be able to interact with the MCC using the bot.
|
||||||
|
config.ChatBot.DiscordBridge.Formats=Message formats\n# Words wrapped with { and } are going to be replaced during the code execution, do not change them!\n# For example. {message} is going to be replace with an actual message, {username} will be replaced with an username, {timestamp} with the current time.\n# For Discord message formatting, check the following: https://bit.ly/3F8CUCm
|
||||||
|
|
||||||
# ChatBot.Farmer
|
# ChatBot.Farmer
|
||||||
config.ChatBot.Farmer=Automatically farms crops for you (plants, breaks and bonemeals them).\n# Crop types available: Beetroot, Carrot, Melon, Netherwart, Pumpkin, Potato, Wheat.\n# Usage: "/farmer start" command and "/farmer stop" command.\n# NOTE: This a newly added bot, it is not perfect and was only tested in 1.19.2, there are some minor issues like not being able to bonemeal carrots/potatoes sometimes.\n# or bot jumps onto the farm land and breaks it (this happens rarely but still happens). We are looking forward at improving this.\n# It is recommended to keep the farming area walled off and flat to avoid the bot jumping.\n# Also, if you have your farmland that is one block high, make it 2 or more blocks high so the bot does not fall through, as it can happen sometimes when the bot reconnects.\n# The bot also does not pickup all items if they fly off to the side, we have a plan to implement this option in the future as well as drop off and bonemeal refill chest(s).
|
config.ChatBot.Farmer=Automatically farms crops for you (plants, breaks and bonemeals them).\n# Crop types available: Beetroot, Carrot, Melon, Netherwart, Pumpkin, Potato, Wheat.\n# Usage: "/farmer start" command and "/farmer stop" command.\n# NOTE: This a newly added bot, it is not perfect and was only tested in 1.19.2, there are some minor issues like not being able to bonemeal carrots/potatoes sometimes.\n# or bot jumps onto the farm land and breaks it (this happens rarely but still happens). We are looking forward at improving this.\n# It is recommended to keep the farming area walled off and flat to avoid the bot jumping.\n# Also, if you have your farmland that is one block high, make it 2 or more blocks high so the bot does not fall through, as it can happen sometimes when the bot reconnects.\n# The bot also does not pickup all items if they fly off to the side, we have a plan to implement this option in the future as well as drop off and bonemeal refill chest(s).
|
||||||
config.ChatBot.Farmer.Delay_Between_Tasks=Delay between tasks in seconds (Minimum 1 second)
|
config.ChatBot.Farmer.Delay_Between_Tasks=Delay between tasks in seconds (Minimum 1 second)
|
||||||
|
|
|
||||||
|
|
@ -1090,7 +1090,7 @@ namespace MinecraftClient
|
||||||
set { ChatBots.ChatLog.Config = value; ChatBots.ChatLog.Config.OnSettingUpdate(); }
|
set { ChatBots.ChatLog.Config = value; ChatBots.ChatLog.Config.OnSettingUpdate(); }
|
||||||
}
|
}
|
||||||
|
|
||||||
//[TomlPrecedingComment("$config.ChatBot.DiscordBridge")]
|
[TomlPrecedingComment("$config.ChatBot.DiscordBridge$")]
|
||||||
public ChatBots.DiscordBridge.Configs DiscordBridge
|
public ChatBots.DiscordBridge.Configs DiscordBridge
|
||||||
{
|
{
|
||||||
get { return ChatBots.DiscordBridge.Config; }
|
get { return ChatBots.DiscordBridge.Config; }
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue