diff --git a/docs/.vuepress/public/images/guide/Discord_Add_Bot.png b/docs/.vuepress/public/images/guide/Discord_Add_Bot.png new file mode 100644 index 00000000..b823b8c2 Binary files /dev/null and b/docs/.vuepress/public/images/guide/Discord_Add_Bot.png differ diff --git a/docs/.vuepress/public/images/guide/Discord_Create_Application.png b/docs/.vuepress/public/images/guide/Discord_Create_Application.png new file mode 100644 index 00000000..a660b782 Binary files /dev/null and b/docs/.vuepress/public/images/guide/Discord_Create_Application.png differ diff --git a/docs/.vuepress/public/images/guide/Discord_Permissions.png b/docs/.vuepress/public/images/guide/Discord_Permissions.png new file mode 100644 index 00000000..e8ae9016 Binary files /dev/null and b/docs/.vuepress/public/images/guide/Discord_Permissions.png differ diff --git a/docs/.vuepress/public/images/guide/Discord_Privileged_Intents.png b/docs/.vuepress/public/images/guide/Discord_Privileged_Intents.png new file mode 100644 index 00000000..47f0514b Binary files /dev/null and b/docs/.vuepress/public/images/guide/Discord_Privileged_Intents.png differ diff --git a/docs/.vuepress/public/images/guide/Discord_Reset_Token.png b/docs/.vuepress/public/images/guide/Discord_Reset_Token.png new file mode 100644 index 00000000..a6f11bb5 Binary files /dev/null and b/docs/.vuepress/public/images/guide/Discord_Reset_Token.png differ diff --git a/docs/.vuepress/public/redirect.html b/docs/.vuepress/public/redirect.html index 0161f350..93747930 100644 --- a/docs/.vuepress/public/redirect.html +++ b/docs/.vuepress/public/redirect.html @@ -1,133 +1,171 @@ - - - - Sign-in | Minecraft Console Client - - - - -

- Minecraft Console Client -

-
- - - + + + + + Sign-in | Minecraft Console Client + + + + +

+ Minecraft Console Client +

+
+ - - + - + navigator.clipboard.writeText(text).then(function () { + console.log('Async: Copying to clipboard was successful!'); + }, function (err) { + console.error('Async: Could not copy text: ', err); + }); + } + + + diff --git a/docs/.vuepress/public/redirect_assets/redirect.css b/docs/.vuepress/public/redirect_assets/redirect.css deleted file mode 100644 index 93228380..00000000 --- a/docs/.vuepress/public/redirect_assets/redirect.css +++ /dev/null @@ -1,29 +0,0 @@ -.messageContainer { - box-shadow: 0px 1px 2px 1px #bdbdbd; - border-radius: 2px; - max-width: 30em; - padding: 2em; - margin: 0 auto; - background-color: white; -} - -.logo { - width: 1.5em; - vertical-align: bottom; - padding-right: 0.5em; -} - -.brand { - background-color: #ffffff78; - padding: 0.5em; - border-radius: 8px; -} - -code { - white-space: pre-wrap; -} - -pre { - box-shadow: 0px 1px 2px 1px #bdbdbd; - padding: 0.5em; -} diff --git a/docs/.vuepress/public/redirect_assets/wallpaper/1.png b/docs/.vuepress/public/redirect_assets/wallpaper/1.png index a8bfcf1d..a49ffba5 100644 Binary files a/docs/.vuepress/public/redirect_assets/wallpaper/1.png and b/docs/.vuepress/public/redirect_assets/wallpaper/1.png differ diff --git a/docs/.vuepress/public/redirect_assets/wallpaper/2.png b/docs/.vuepress/public/redirect_assets/wallpaper/2.png index dc9a2e56..b8885f5c 100644 Binary files a/docs/.vuepress/public/redirect_assets/wallpaper/2.png and b/docs/.vuepress/public/redirect_assets/wallpaper/2.png differ diff --git a/docs/.vuepress/public/redirect_assets/wallpaper/3.png b/docs/.vuepress/public/redirect_assets/wallpaper/3.png index 6437d91b..398a9159 100644 Binary files a/docs/.vuepress/public/redirect_assets/wallpaper/3.png and b/docs/.vuepress/public/redirect_assets/wallpaper/3.png differ diff --git a/docs/.vuepress/public/redirect_assets/wallpaper/4.png b/docs/.vuepress/public/redirect_assets/wallpaper/4.png index 10d4b1dd..825e6bb7 100644 Binary files a/docs/.vuepress/public/redirect_assets/wallpaper/4.png and b/docs/.vuepress/public/redirect_assets/wallpaper/4.png differ diff --git a/docs/.vuepress/public/redirect_assets/wallpaper/5.png b/docs/.vuepress/public/redirect_assets/wallpaper/5.png index 400b1a30..724c52cf 100644 Binary files a/docs/.vuepress/public/redirect_assets/wallpaper/5.png and b/docs/.vuepress/public/redirect_assets/wallpaper/5.png differ diff --git a/docs/.vuepress/public/redirect_assets/wallpaper/6.png b/docs/.vuepress/public/redirect_assets/wallpaper/6.png index 2e2a7570..a851589c 100644 Binary files a/docs/.vuepress/public/redirect_assets/wallpaper/6.png and b/docs/.vuepress/public/redirect_assets/wallpaper/6.png differ diff --git a/docs/.vuepress/public/redirect_assets/wallpaper/7.png b/docs/.vuepress/public/redirect_assets/wallpaper/7.png index 1cf054c8..38d89742 100644 Binary files a/docs/.vuepress/public/redirect_assets/wallpaper/7.png and b/docs/.vuepress/public/redirect_assets/wallpaper/7.png differ diff --git a/docs/.vuepress/public/redirect_assets/wallpaper/8.png b/docs/.vuepress/public/redirect_assets/wallpaper/8.png index 576894d8..fc2dc4d1 100644 Binary files a/docs/.vuepress/public/redirect_assets/wallpaper/8.png and b/docs/.vuepress/public/redirect_assets/wallpaper/8.png differ diff --git a/docs/guide/chat-bots.md b/docs/guide/chat-bots.md index f2f578a5..be1f7483 100644 --- a/docs/guide/chat-bots.md +++ b/docs/guide/chat-bots.md @@ -40,6 +40,8 @@ redirectFrom: - [Auto Relog](#auto-relog) - [Auto Respond](#auto-respond) - [Chat Log](#chat-log) +- [Discord Bridge](#discord-bridge) +- [Farmer](#farmer) - [Follow Player](#follow-player) - [Hangman](#hangman) - [Mailer](#mailer) @@ -73,7 +75,6 @@ redirectFrom: - **Default:** `false` - #### `Beep_Enabled`

Tip

@@ -90,7 +91,6 @@ redirectFrom: - **Default:** `true` - #### `Trigger_By_Words` - **Description:** @@ -103,7 +103,6 @@ redirectFrom: - **Default:** `false` - #### `Trigger_By_Rain` - **Description:** @@ -116,7 +115,6 @@ redirectFrom: - **Default:** `false` - #### `Trigger_By_Thunderstorm` - **Description:** @@ -129,7 +127,6 @@ redirectFrom: - **Default:** `false` - #### `Log_To_File` - **Description:** @@ -142,7 +139,6 @@ redirectFrom: - **Default:** `false` - #### `Log_File` - **Description:** @@ -153,7 +149,6 @@ redirectFrom: - **Default:** `"alerts-log.txt"` - #### `Matches` - **Description:** @@ -168,7 +163,6 @@ redirectFrom: Matches = [ "Yourname", " whispers ", "-> me", "admin", ".com", ] ``` - #### `Excludes` - **Description:** @@ -205,7 +199,6 @@ redirectFrom: - **Default:** `false` - #### `Delay` - **Description:** @@ -220,7 +213,6 @@ redirectFrom: - **Default:** `{ min = 60.0, max = 60.0 }` - #### `Command` - **Description:** @@ -231,7 +223,6 @@ redirectFrom: - **Default:** `/ping` - #### `Use_Sneak` - **Description:** @@ -242,7 +233,6 @@ redirectFrom: - **Default:** `false` - #### `Use_Terrain_Handling`

Tip

@@ -263,7 +253,6 @@ redirectFrom: - **Default:** `false` - #### `Walk_Range` - **Description:** @@ -274,7 +263,6 @@ redirectFrom: - **Default:** `5` - #### `Walk_Retries`

Tip

@@ -317,7 +305,6 @@ redirectFrom: - **Default:** `false` - #### `Mode` - **Description:** @@ -336,7 +323,6 @@ redirectFrom: - **Default:** `single` - #### `Priority` - **Description:** @@ -350,7 +336,6 @@ redirectFrom: - **Default:** `distance` - #### `Cooldown_Time` - **Description:** @@ -369,7 +354,6 @@ redirectFrom: - **Default:** `{ Custom = false, value = 1.0 }` - #### `Interaction` - **Description:** @@ -392,7 +376,6 @@ redirectFrom: - **Default:** `Attack` - #### `Attack_Hostile` - **Description:** @@ -405,7 +388,6 @@ redirectFrom: - **Default:** `true` - #### `Attack_Passive` - **Description:** @@ -418,7 +400,6 @@ redirectFrom: - **Default:** `false` - #### `List_Mode` - **Description:** @@ -431,7 +412,6 @@ redirectFrom: - **Default:** `whitelist` - #### `Entites_List` - **Description:** @@ -482,7 +462,6 @@ redirectFrom: **Section:** **`ChatBot.AutoCraft`** - #### `Enabled` - **Description:** @@ -495,7 +474,6 @@ redirectFrom: - **Default:** `false` - #### `CraftingTable` - **Description:** @@ -518,7 +496,6 @@ redirectFrom: CraftingTable = { X = 123.0, Y = 65.0, Z = 456.0 } ``` - #### `OnFailure` - **Description:** @@ -533,7 +510,6 @@ redirectFrom: - **Default:** `abort` - ### Defining a recipe

Tip

@@ -554,7 +530,7 @@ redirectFrom: - `Type` - **Avaliable values:** `player` and `table` + **Available values:** `player` and `table` - `Result` @@ -657,7 +633,6 @@ redirectFrom: **Section:** **`ChatBot.AutoDig`** - #### `Enabled` - **Description:** @@ -670,7 +645,6 @@ redirectFrom: - **Default:** `false` - #### `Mode` - **Description:** @@ -695,7 +669,6 @@ redirectFrom: - **Default:** `lookat` - #### `Locations` - **Description:** @@ -721,7 +694,6 @@ redirectFrom: ] ``` - #### `Location_Order` - **Description:** @@ -742,7 +714,6 @@ redirectFrom: - **Default:** `distance` - #### `Auto_Start_Delay` - **Description:** @@ -755,7 +726,6 @@ redirectFrom: - **Default:** `3.0` - #### `Dig_Timeout` - **Description:** @@ -766,7 +736,6 @@ redirectFrom: - **Default:** `60.0` - #### `Log_Block_Dig` - **Description:** @@ -779,7 +748,6 @@ redirectFrom: - **Default:** `true` - #### `List_Type` - **Description:** @@ -792,7 +760,6 @@ redirectFrom: - **Default:** `whitelist` - #### `Blocks` - **Description:** @@ -837,7 +804,6 @@ redirectFrom: - **Default:** `false` - #### `Mode` - **Description:** @@ -864,7 +830,6 @@ redirectFrom: - **Default:** `include` - #### `Items`

Tip

@@ -914,7 +879,6 @@ redirectFrom: - **Default:** `false` - #### `Threshold` - **Description:** @@ -966,7 +930,6 @@ redirectFrom: **Section:** **`ChatBot.AutoFishing`** - #### `Enabled` - **Description:** @@ -979,7 +942,6 @@ redirectFrom: - **Default:** `false` - #### `Antidespawn` - **Description:** @@ -992,7 +954,6 @@ redirectFrom: - **Default:** `false` - #### `Mainhand` - **Description:** @@ -1008,7 +969,6 @@ redirectFrom: - **Default:** `true` - #### `Auto_Start` - **Description:** @@ -1021,7 +981,6 @@ redirectFrom: - **Default:** `true` - #### `Cast_Delay` - **Description:** @@ -1032,7 +991,6 @@ redirectFrom: - **Default:** `0.4` - #### `Fishing_Delay` - **Description:** @@ -1045,7 +1003,6 @@ redirectFrom: - **Default:** `3.0` - #### `Fishing_Timeout` - **Description:** @@ -1056,7 +1013,6 @@ redirectFrom: - **Default:** `300.0` - #### `Durability_Limit` - **Description:** @@ -1069,7 +1025,6 @@ redirectFrom: - **Default:** `2` - #### `Auto_Rod_Switch` - **Description:** @@ -1082,7 +1037,6 @@ redirectFrom: - **Default:** `true` - #### `Stationary_Threshold` - **Description:** @@ -1099,7 +1053,6 @@ redirectFrom: - **Default:** `0.001` - #### `Hook_Threshold` - **Description:** @@ -1114,7 +1067,6 @@ redirectFrom: - **Default:** `0.2` - #### `Log_Fish_Bobber` - **Description:** @@ -1129,7 +1081,6 @@ redirectFrom: - **Default:** `false` - #### `Enable_Move` - **Description:** @@ -1144,12 +1095,11 @@ redirectFrom: - **Default:** `false` - ### Adding a position/movement Each position/movement is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection of `[ChatBot.AutoFishing]`. - **Avaliable settings/options:** + **Available settings/options:** - `XYZ` @@ -1185,7 +1135,6 @@ redirectFrom: facing = { yaw = 12.34, pitch = -23.45 } ``` - #### Full example ```toml @@ -1219,7 +1168,6 @@ redirectFrom: - **Default:** `false` - #### `Delay` - **Description:** @@ -1236,7 +1184,6 @@ redirectFrom: - **Default:** `{ min = 3.0, max = 3.0 }` - #### `Retries`

Tip

@@ -1253,7 +1200,6 @@ redirectFrom: - **Default:** `-1` - #### `Ignore_Kick_Message` - **Description:** @@ -1264,7 +1210,6 @@ redirectFrom: - **Default:** `false` - #### `Kick_Messages` - **Description:** @@ -1311,7 +1256,6 @@ redirectFrom: - **Default:** `false` - #### `Matches_File`

Tip

@@ -1332,7 +1276,6 @@ redirectFrom: - **Default:** `matches.ini` - #### `Match_Colors`

Tip

@@ -1373,7 +1316,6 @@ redirectFrom: - **Default:** `false` - #### `Add_DateTime` - **Description:** @@ -1384,7 +1326,6 @@ redirectFrom: - **Default:** `true` - #### `Log_File` - **Description:** @@ -1393,7 +1334,6 @@ redirectFrom: - **Default:** `chatlog-%username%-%serverip%.txt` - #### `Filter` - **Description:** @@ -1424,6 +1364,275 @@ redirectFrom: - **Default:** `messages` +## Discord Bridge + +- **Description:** + + This Chat Bot allows you to send and receive messages and MCC commands via a Discord channel. + +- **Setup:** + + In order for this to work you must create a Discord bot on the [Discord Developers portal](https://discord.com/developers/applications/). + + First go to [Discord Developers portal](https://discord.com/developers/applications/), click on **New Application**, fill out the name of your bot and confirm the terms of service and click **Create**. + + ![Image](/images/guide/Discord_Create_Application.png) + + Copy the **Application ID** and save it somewhere. + + Click on the **Bot** tab in the left menu. + + Click on **Add Bot** + + ![Image](/images/guide/Discord_Add_Bot.png) + + Click on the **Reset Token** button and copy the generated token, then paste it in the `Token` field in the MCC configuration. + + Enable `Message Content Intent`, `Server Members Intent` and `Presence Intent`. + + ![Image](/images/guide/Discord_Reset_Token.png) + ![Image](/images/guide/Discord_Privileged_Intents.png) + +

Warning

+ + **Token is what gives you access to the Bot, do not share it with anyone and keep it safe!** + +
+ +

Warning

+ + **You must Enable `Message Content Intent`, `Server Members Intent` and `Presence Intent` for the bot to work!** + +
+ + Then go to [Discord Permissions Calculator](https://discordapi.com/permissions.html). + Paste the **Application Id** that you've copied into the **Client ID** field, then Check/Enable the **Administrator** field in General Permissions section. + Finally click on the **Link** down bellow and invite the Bot on to a server you want to interact with the MCC on. + + ![Image](/images/guide/Discord_Permissions.png) + + Go to your Discord Client and go to **Settings -> Advanced**, Enable **Developer Mode**. + + Then **right click** on a server where you invited the bot to in the server list and click on **Copy ID**, paste the copied id in `GuildId` in your MCC configuration. + + Then **right click** on a channel where you want to interact with the bot and click on **Copy ID**, paste the copied id in `ChannelId` in your MCC configuration. + + Send a message in that channel and **right click** on your nick and click **Copy ID** and paste the copied id in `OwnersIds` list setting in your MCC configuration. + + Enable the bot by setting `Enabled` to `true` in your MCC configuration and start the MCC. + +- **Usage:** + + To send a message simply type it out in the Discord channel and press enter. + + To execute a MCC command, you must prefix it with a dot (`.`). + Example: `.move 145 64 832` + +- **Settings:** + + **Section:** **`ChatBot.DiscordBrdige`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Discord Bridge Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + #### `Token` + + - **Description:** + + This is the token of your Discord bot. + + - **Type:** `string` + + #### `GuildId` + + - **Description:** + + This is the ID of your server/guild where you have invited the bot to. + + - **Type:** `unsigned long` + + #### `ChannelId` + + - **Description:** + + This is the ID of a channel on your server/guild where you want to interact with the bot. + + - **Type:** `unsigned long` + + #### `OwnersIds` + + - **Description:** + + This is a list of Discord user IDs which can interact with the bot. + + - **Type:** `list/array of: unsigned long` + + #### `PrivateMessageFormat` + + - **Description:** + + This is a format that will be used when someone has sent you a private message on the server. + + Parts of the message that are between `{` and `}` will be replaced by the Chat Bot during runtime, you should not change them in any way! + + For example `{message}` will be replaced with an actual message, `{username}` will be replaced with the username of the person who sent a message on the server and `{timestamp}` will be replaced with the current date and time. + + For Discord message formatting/styling, refer to [this guide](https://www.writebots.com/discord-text-formatting/). + + - **Type:** `string` + + - **Default:** `**[Private Message]** {username}: {message}` + + #### `PublicMessageFormat` + + - **Description:** + + This is a format that will be used when sending a public message to the Discord channel. + + Parts of the message that are between `{` and `}` will be replaced by the Chat Bot during runtime, you should not change them in any way! + + For example `{message}` will be replaced with an actual message, `{username}` will be replaced with the username of the person who sent a message on the server and `{timestamp}` will be replaced with the current date and time. + + For Discord message formatting/styling, refer to [this guide](https://www.writebots.com/discord-text-formatting/). + + - **Type:** `string` + + - **Default:** `{username}: {message}` + + #### `TeleportRequestMessageFormat` + + - **Description:** + + This is a format that will be used when someone has sent you a Teleport Request. + + Parts of the message that are between `{` and `}` will be replaced by the Chat Bot during runtime, you should not change them in any way! + + For example `{message}` will be replaced with an actual message, `{username}` will be replaced with the username of the person who sent a message on the server and `{timestamp}` will be replaced with the current date and time. + + For Discord message formatting/styling, refer to [this guide](https://www.writebots.com/discord-text-formatting/). + + - **Type:** `string` + + - **Default:** `A new Teleport Request from **{username}**!` + +## Farmer + +

Tip

+ + **You need to have [Terrain And Movements](configuration.md#terrainandmovements) and [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this bot to work.** + +
+ +

Warning

+ + **This a newly added bot, it is not perfect and was only tested in 1.19.2, there are some minor issues with it and you should treat it as an experimental bot.** + +
+ +- **Description:** + + This bot can farm crops for you. + When you start it it will plant, break and bonemeal crops in order. + + Supported crops: + + - Beetroot + - Carrot + - Melon + - Netherwart + - Pumpkin + - Potato + - Wheat + + **Current list of issues:** + + - Sometimes the bot will not bone meal carrots/potatoes or melon/pumpkin stems (you will see it in a pattern of crops that have not been bonemealed) + - Sometimes the bot can jump on to the crops and break the farmland when coming form a different height, it's advised to keep the farming area flat and fenced off so the items to not fly out of the farming area + - If you have a farming platform that is 1 block thick and has air bellow, make it a few blocks thick because the bot can fall through sometimes when logging in and standing on farmland + - Sometimes the bot can be kicked for "invalid movement" packets when farming netherwart on soul sand, we haven't been able to figure why this happens in some parts of the world, while on other it's completely fine, it's advised to keep the farming area small and flat. + + _We're working on solving these issues._ + + **What the bot does not do as of the time of writing, but are planned features:** + + - Does not collect items which fly off to the side, (it's advised to fence off the farming area with 2 high wall) + - Does not put items to the chest once the inventory is full + - Does not warn you when the inventory is full + - Does not refill inventory with seeds or bonemeal from chests by it self. + + > **ℹ️ NOTE: The default radius of scanning is `30` blocks, we suggest that you do not use radius too big because it might slow down the bot. The bigger the radius, the slower the scanning and processing is.** + +- **Commands:** + + When enabled will add the `/farmer` command. + + **Usage**: + + ``` + /farmer [radius:] [unsafe:] [teleport:] [debug:]|stop> + ``` + + _Options marked with `[` and `]` are optional and in case of this command can have whatever order you prefer after the `` field._ + + _Options that have `=` means that the value after the `=` is a default value, in case of this command the default radius is 30 blocks._ + + **Examples:** + + Farming `wheat` in a radius of `40` blocks. + + ``` + /farmer start wheat radius:40 + ``` + + Farming `melon` with debug output and direct teleporting: + + ``` + /farmer start melon debug:true teleport:true + ``` + + Stopping the bot: + + ``` + /farmer stop + ``` + +- **Settings:** + + **Section:** **`ChatBot.Farmer`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Farmer Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + #### `Delay_Between_Tasks` + + - **Description:** + + This setting specifies the delay in seconds between each task performed by the bot. + + - **Type:** `integer` + + - **Default:** `1` + + - **Minimum:** `1` + ## Follow player - **Description:** @@ -1458,7 +1667,6 @@ redirectFrom: - **Default:** `false` - #### `Update_Limit` - **Description:** @@ -1471,7 +1679,6 @@ redirectFrom: - **Default:** `1.5` - #### `Stop_At_Distance` - **Description:** @@ -1512,7 +1719,6 @@ redirectFrom: - **Default:** `false` - #### `English` - **Description:** @@ -1523,7 +1729,6 @@ redirectFrom: - **Default:** `true` - #### `FileWords_EN`

Tip

@@ -1539,7 +1744,6 @@ redirectFrom: - **Default:** `hangman-en.txt` - **Example**: [`words-en.txt`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/hangman-en.txt) - #### `FileWords_FR`

Tip

@@ -1610,7 +1814,6 @@ redirectFrom: **Section:** **`ChatBot.Mailer`** - #### `Enabled` - **Description:** @@ -1623,7 +1826,6 @@ redirectFrom: - **Default:** `false` - #### `DatabaseFile` - **Description:** @@ -1634,7 +1836,6 @@ redirectFrom: - **Default:** `MailerDatabase.ini` - #### `IgnoreListFile` - **Description:** @@ -1645,7 +1846,6 @@ redirectFrom: - **Default:** `MailerIgnoreList.ini` - #### `PublicInteractions` - **Description:** @@ -1658,7 +1858,6 @@ redirectFrom: - **Default:** `false` - #### `MaxMailsPerPlayer` - **Description:** @@ -1669,7 +1868,6 @@ redirectFrom: - **Default:** `10` - #### `MaxDatabaseSize` - **Description:** @@ -1680,7 +1878,6 @@ redirectFrom: - **Default:** `10000` (10 MB) - #### `MailRetentionDays` - **Description:** @@ -1695,17 +1892,11 @@ redirectFrom: - **Description:** - This Chat Bot allows you to render items maps into `.jpg` images. + This Chat Bot allows you to render items maps in the console, to `.bmp` images and to relay them to Discord using the [Discord Bridge](#discord-bridge) Chat Bot. This is useful for solving captchas on servers which require it, or saving the map art into an image. - The maps are **rendered** into `Rendered_Maps` folder. - -

Warning

- - **This bot has only been tested on Windows 10, it may not work on Linux or Mac OS due to .NET BitMap API. We're looking forward to swap the underlaying Bitmap API dependency with a library.** - -
+ The maps are **rendered** into `Rendered_Maps` folder which will be auto created in the same folder where the client executable is located. - **Commands:** @@ -1733,26 +1924,31 @@ redirectFrom: - **Default:** `false` + #### `Render_In_Console` - #### `Should_Resize` + - **Description:** -

Tip

+ This setting specifies if the Map Chat Bot should render the map in the console. - **The bigger the size, the less is the quality.** + It is recommended to use something like Power Shell for the best map quality (at least for Windows users). -
+ - **Available values:** `true` and `false`. -

Tip

+ - **Type:** `boolean` - **For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + - **Default:** `true` + + #### `Save_To_File` + +

Warning

+ + **If you want the Discord relay feature, you must enable this setting!**
- **Description:** - This setting specifies if the Map Chat Bot should resize the image. - - The default map size is `128x128`. + This setting specifies if the Map Chat Bot should render the map and save it into a file (`.bmp` format) - **Available values:** `true` and `false`. @@ -1760,18 +1956,6 @@ redirectFrom: - **Default:** `false` - - #### `Resize_To` - - - **Description:** - - Which size the map should be resized to if `Should_Resize` is `true`. - - - **Type:** `integer` - - - **Default:** `256` - - #### `Auto_Render_On_Update`

Warning

@@ -1790,7 +1974,6 @@ redirectFrom: - **Default:** `false` - #### `Delete_All_On_Unload` - **Description:** @@ -1803,7 +1986,6 @@ redirectFrom: - **Default:** `true` - #### `Notify_On_First_Update` - **Description:** @@ -1816,6 +1998,80 @@ redirectFrom: - **Default:** `false` + #### `Rasize_Rendered_Image` + +

Tip

+ + **The bigger the size, the less is the quality.** + +
+ +

Tip

+ + **For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + +
+ + - **Description:** + + This setting specifies if the Map Chat Bot should resize the rendered image (the one that is saved to a file). + + This is useful if you're relying map images to Discord via the [Discord Bridge](#discord-bridge) Chat Bot. + + The default map size is `128x128`. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + #### `Resize_To` + +

Tip

+ + **Might be a bit slow on less powerful systems when rendering a lot of maps. Lower down the resolution if you have any performance issues. If your system is not that powerful and can't handle it, use external tools for upscaling and resizing.** + +
+ + - **Description:** + + Which size the map should be resized to if `Rasize_Rendered_Image` is `true`. + + + - **Type:** `integer` + + - **Default:** `512` + + #### `Send_Rendered_To_Discord` + +

Warning

+ + **The [Discord Bridge](#discord-bridge) Chat Bot must be enabled and configured!** + +
+ +

Warning

+ + **You need to enable `Save_To_File` in order for this to work.** + +
+ +

Tip

+ + **Sometimes when the client connects, the [Discord Bridge](#discord-bridge) will be loaded a tiny bit after. Rendered map images are queued up and sent in order as soon as the [Discord Bridge](#discord-bridge) is ready and connected.** + +
+ + - **Description:** + + Send a rendered map (saved to a file) to a Discord channel via the [Discord Bridge](#discord-bridge) Chat Bot. + + + - **Type:** `boolean` + + - **Default:** `false` + ## PlayerList Logger - **Description:** @@ -1835,7 +2091,6 @@ redirectFrom: - **Default:** `false` - #### `File` - **Description:** @@ -1844,7 +2099,6 @@ redirectFrom: - **Default:** `playerlog.txt` - #### `Delay` - **Description:** @@ -1885,7 +2139,6 @@ redirectFrom: - **Default:** `false` - #### `AutoTpaccept` - **Description:** @@ -1898,7 +2151,6 @@ redirectFrom: - **Default:** `true` - #### `AutoTpaccept_Everyone` - **Description:** @@ -1951,7 +2203,6 @@ redirectFrom: - **Default:** `false` - #### `Backup_Interval` - **Description:** @@ -1986,7 +2237,6 @@ redirectFrom: - **Default:** `false` - ### Defining a task

Tip

@@ -2007,7 +2257,7 @@ redirectFrom: = ``` - **Avaliable settings/options:** + **Available settings/options:** - `Trigger_On_First_Login` @@ -2061,7 +2311,6 @@ redirectFrom: Trigger_On_Interval = { Enable = true, MinTime = 30.0, MaxTime = 160.0 } ``` - ### Full example ```toml diff --git a/docs/guide/usage.md b/docs/guide/usage.md index 25cda816..2f3262bd 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -236,6 +236,28 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /bed sleep 50 ``` +### `blockinfo` + +

Tip

+ +**You need to have [Terrain And Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + +
+ +- **Description:** + + Reports the block type at the given position. + + If you use the `-s` option it will report the types of blocks around the targeted blokcs. + +- **Usage:** + + Basic usage: + + ``` + /blockinfo [-s] + ``` + ### `bots` - **Description:** @@ -364,6 +386,30 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem diamond ``` +### `enchant` + +

Tip

+ + **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + +
+ +- **Description:** + + Allows you to enchant items in an enchanting table. + + You need to first open an enchanting table and then place and item that you want to enchant and lapis in the enchanting table, and then you can execute the command. + + To open an enchanting table you can use the [`useblock`](#useblock) command. + +- **Usage:** + + Basic usage: + + ``` + /enchant + ``` + ### `entity` - **Description:** @@ -440,21 +486,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /execif test2 == "1" ---> send Success 2! ``` - Basic C# expression: ``` /execif 1 + 2 + 3 == 6 ---> send Success! ``` - Using MCC class: ``` /execif MCC.GetHealth() == 20.0 ---> send Success! ``` - Using in combination with [`execmulti`](#execmulti): ```