diff --git a/docs/guide/chat-bots.md b/docs/guide/chat-bots.md index dc747a86..512f1664 100644 --- a/docs/guide/chat-bots.md +++ b/docs/guide/chat-bots.md @@ -15,7 +15,7 @@ redirectFrom: **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -

Tip

+

Note

**Settings refer to settings in the [configuration file](configuration.md)** @@ -80,7 +80,7 @@ redirectFrom: #### `Beep_Enabled` -

Tip

+

Note

**This might not work depending on your system or a console (terminal emulator).** @@ -243,7 +243,7 @@ redirectFrom: #### `Use_Terrain_Handling` -

Tip

+

Note

**You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** @@ -273,7 +273,7 @@ redirectFrom: #### `Walk_Retries` -

Tip

+

Note

**This happens on each trigger of the task, so it does not permanently switch to alternative method.** @@ -289,7 +289,7 @@ redirectFrom: ## Auto Attack -

Tip

+

Note

**You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** @@ -445,7 +445,7 @@ redirectFrom: ## Auto Craft -

Tip

+

Note

**You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** @@ -530,7 +530,7 @@ redirectFrom: ### Defining a recipe -

Tip

+

Note

**If you're using `table` you need to set the `CraftingTable` setting.** @@ -630,13 +630,13 @@ redirectFrom: Automatically digs block on specified locations. -

Tip

+

Note

**You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.**
-

Tip

+

Note

**Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** @@ -806,7 +806,7 @@ redirectFrom: Automatically drop items you don't need from the inventory. -

Tip

+

Note

**You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** @@ -859,7 +859,7 @@ redirectFrom: #### `Items` -

Tip

+

Note

**All item types can be found [here](https://mccteam.github.io/r/item/#L12).** @@ -885,7 +885,7 @@ redirectFrom: Automatically eat food when your Hunger value is low. -

Tip

+

Note

**You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** @@ -928,19 +928,19 @@ redirectFrom: Automatically catch fish using a fishing rod. -

Tip

+

Note

**You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.**
-

Tip

+

Note

**To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).**
-

Tip

+

Note

**Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** @@ -1227,7 +1227,7 @@ redirectFrom: #### `Retries` -

Tip

+

Note

**This might get you banned by the server owners.** @@ -1304,7 +1304,7 @@ redirectFrom: #### `Matches_File` -

Tip

+

Note

**This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** @@ -1330,7 +1330,7 @@ redirectFrom: #### `Match_Colors` -

Tip

+

Note

**This feature uses the `§` symbol for color matching** @@ -1847,7 +1847,7 @@ redirectFrom: ## Farmer -

Tip

+

Note

**You need to have [Terrain And Movements](configuration.md#terrainandmovements) and [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this bot to work.** @@ -1965,13 +1965,13 @@ redirectFrom: This bot enables you to make a bot follow a specific player. -

Tip

+

Note

**The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.**
-

Tip

+

Note

**You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** @@ -2030,7 +2030,7 @@ redirectFrom: Also set `enabled` to `true`, then, add your username in the `botowners` INI setting, and finally, connect to the server and use `/tell start` to start the game. -

Tip

+

Note

**If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** @@ -2065,7 +2065,7 @@ redirectFrom: #### `FileWords_EN` -

Tip

+

Note

**This settings file is for English and is not created by the default** @@ -2081,7 +2081,7 @@ redirectFrom: #### `FileWords_FR` -

Tip

+

Note

**This settings file is for French and is not created by the default** @@ -2339,9 +2339,9 @@ redirectFrom: - **Default:** `false` - #### `Rasize_Rendered_Image` + #### `Resize_Rendered_Image` -

Tip

+

Note

**The bigger the size, the less is the quality.** @@ -2369,7 +2369,7 @@ redirectFrom: #### `Resize_To` -

Tip

+

Note

**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.** @@ -2397,7 +2397,7 @@ redirectFrom:
-

Tip

+

Note

**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.** @@ -2527,7 +2527,7 @@ redirectFrom:
-

Tip

+

Note

**Please note that due to technical limitations, the client player (you) will not be shown in the replay file** diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 527776a0..3f8e5b8b 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -11,10 +11,6 @@ redirectFrom: By default, MCC stores its settings in `MinecraftClient.ini`, which is created the first time you run the program. You can also pass a custom configuration file path as the first argument when starting MCC. See [Usage](usage.md#quick-usage-of-mcc-with-examples) for examples. -

Warning

- -
- ## Notes - Some less common settings are not repeated here. The generated config file contains inline descriptions for every setting. @@ -126,7 +122,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } This setting defines the account type: `mojang`, `microsoft`, or `yggdrasil`. -

Tip

+

Note

**Use `microsoft` for normal Microsoft accounts. `yggdrasil` is for custom authlib/Yggdrasil servers.** @@ -391,7 +387,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } MinecraftVersion = "1.18.2" ``` -

Tip

+

Note

**Current code support is `1.4.6` through `26.1`.** @@ -413,7 +409,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `no` -

Tip

+

Note

**Force-enabling only works for MC 1.13 +** @@ -429,7 +425,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `mcc` -

Tip

+

Note

**For playing on Hypixel you need to use `vanilla`** @@ -523,7 +519,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `false` -

Tip

+

Note

**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** @@ -561,7 +557,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `false` -

Tip

+

Note

**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** @@ -615,7 +611,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `true` -

Tip

+

Note

**Only works on Windows XP-8 or Windows 10 with old console** @@ -661,7 +657,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `false` -

Tip

+

Note

**Make sure the spawn point is safe** @@ -966,7 +962,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `.*` -

Tip

+

Note

**Not filtering anything by default** @@ -984,7 +980,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `.*` -

Tip

+

Note

**Not filtering anything by default** @@ -1022,7 +1018,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `console-log.txt` -

Tip

+

Note

**%username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** @@ -1062,7 +1058,7 @@ Coordinate = { x = 145, y = 64, z = 2045 } To define a variable/setting, simply make a new line with the following format under the `[AppVar.VarStirng]` section: -

Tip

+

Note

**`%username%`, `%login%`, `%serverip%`, `%serverport%`, `%datetime%`, `%players%` are reserved read-only variables** diff --git a/docs/guide/creating-bots.md b/docs/guide/creating-bots.md index a7f27188..e374f273 100644 --- a/docs/guide/creating-bots.md +++ b/docs/guide/creating-bots.md @@ -13,7 +13,7 @@ title: Creating Chat Bots ## Notes -

Tip

+

Note

**This page covers the basics of the Chat Bot API. For the full surface area, read [ChatBot.cs](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Scripting/ChatBot.cs) and the example scripts linked below.** @@ -41,7 +41,7 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -

Tip

+

Note

**In this page, "Chat Bot" and "Script" are used interchangeably.** @@ -124,7 +124,7 @@ MCC.LoadBot(new YourChatBotClassNameHere()); The **Script Metadata** section also lets you include namespaces and DLL references with `//using ` and `//dll `. -

Tip

+

Note

**Avoid adding whitespace between `//` and keywords** @@ -176,7 +176,7 @@ When the Chat Bot is initialized for the first time, the `Initialize` method is Use it to initialize state such as dictionaries or cached values. -

Tip

+

Note

**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 38e46f4e..612cf37c 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -38,7 +38,7 @@ Requirements: - [Git](https://www.git-scm.com/) - [.NET 10 SDK](https://dotnet.microsoft.com/en-us/download) or [Visual Studio](https://visualstudio.microsoft.com/) configured for C# app development -::: tip +::: note If you want to modify the code and you are new to C# or programming in general, the tutorials listed in [Creating Bots](creating-bots.md#requirements) are a good starting point. ::: @@ -129,7 +129,7 @@ If the publish step succeeds, the published binary `MinecraftClient.exe` will be
Linux and macOS build instructions -

Tip

+

Note

**If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** @@ -187,7 +187,7 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive dotnet publish MinecraftClient.sln -f net10.0 -r linux-x64 --self-contained=true -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:EnableCompressionInSingleFile=true -p:DebugType=Embedded ``` -

Tip

+

Note

**If you are using Linux on ARM, 32-bit, RHEL-based distributions, or Musl, [pick the appropriate RID](https://learn.microsoft.com/en-us/dotnet/core/rid-catalog#linux-rids) for your platform and replace `-r linux-x64` with it, for example `-r linux-arm64`.** @@ -199,7 +199,7 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive dotnet publish MinecraftClient.sln -f net10.0 -r osx-x64 --self-contained=true -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:EnableCompressionInSingleFile=true -p:DebugType=Embedded ``` -

Tip

+

Note

**If you are not using an Intel Mac, [pick the appropriate RID](https://learn.microsoft.com/en-us/dotnet/core/rid-catalog#macos-rids) for your processor and replace `-r osx-x64` with it, for example `-r osx-arm64`.** @@ -228,7 +228,7 @@ Requirements: - Git - Docker -

Tip

+

Note

**This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** @@ -316,19 +316,19 @@ docker-compose down It is possible to run Minecraft Console Client on Android through Termux and Ubuntu, but it requires a manual setup with a lot of commands, so be careful not to skip any steps. Depending on your technical background, internet speed, and device speed, this can take anywhere from 10 to 20 minutes or more. -

Tip

+

Note

**This section gets a bit technical. If you run into issues, open a discussion on our GitHub repository page.**
-

Tip

+

Note

**You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.**
-

Tip

+

Note

**Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** @@ -351,7 +351,7 @@ It is possible to run Minecraft Console Client on Android through Termux and Ubu **GitHub releases:** Go to [the latest Termux GitHub release](https://github.com/termux/termux-app/releases/latest/), download the APK file whose name contains `universal` (e.g. `termux-app_v...-debug_universal.apk`), and install it. -

Tip

+

Note

**If your file manager does not let you install APK files, install and use `File Manager +` and grant it permission to install third-party applications when asked.** @@ -373,7 +373,7 @@ Open Termux and run the following commands one at a time, in order: 2. `pkg upgrade` 3. `pkg install proot-distro` -

Tip

+

Note

**If you are asked to press Y/N during the update or upgrade step, enter Y and press Enter.** @@ -391,7 +391,7 @@ Once the installation finishes, start Ubuntu with: proot-distro login ubuntu ``` -

Tip

+

Note

**Every time you open Termux after it has been closed, run this command to get back into Ubuntu.** @@ -470,7 +470,7 @@ wget -O MinecraftClient \ | cut -d '"' -f 4)" ``` -

Tip

+

Note

**If you have a 32-bit ARM device, replace `linux-arm64` with `linux-arm` in the command above.** @@ -517,7 +517,7 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -

Tip

+

Note

**This is a newer section. If you spot a mistake, please report it by opening an issue in our [GitHub repository](https://github.com/MCCTeam/Minecraft-Console-Client).** @@ -548,7 +548,7 @@ Here is a [YouTube video](https://youtu.be/42fwh_1KP_o) that explains it in more Download and install [Git Bash](https://git-scm.com/downloads). -

Tip

+

Note

**Make sure to allow the installation to add it to the context menu** @@ -602,7 +602,7 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` -

Tip

+

Note

**If Ubuntu 24.04 LTS is not in the dropdown when ordering, you may need to reinstall later or ask support to do it.** @@ -648,7 +648,7 @@ You also may want to search for better deals.
-

Tip

+

Note

**If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** @@ -665,7 +665,7 @@ Once you're done, you can continue to [Setting up the Amazon VPS](#setting-up-an
AWS EC2 setup steps -

Tip

+

Note

**Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** @@ -673,7 +673,7 @@ Once you're done, you can continue to [Setting up the Amazon VPS](#setting-up-an When you register and open the `AWS Console`, click on the Search field on the top of the page and search for: `EC2` -

Tip

+

Note

**Make sure to select the region closest to you for the minimal latency** @@ -713,7 +713,7 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -

Tip

+

Note

**The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** @@ -737,13 +737,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -

Tip

+

Note

**`<` and `>` are not typed, that is just a notation for a placeholder!**
-

Tip

+

Note

**`ubuntu` is a default root account username for Ubuntu on AWS!** @@ -766,7 +766,7 @@ Now you can continue to [Creating a new user](#creating-a-new-user)
Non-AWS VPS login steps -

Tip

+

Note

**This section if for those who do not use AWS, if you use AWS skip it** @@ -784,7 +784,7 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -

Tip

+

Note

**If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** @@ -815,7 +815,7 @@ Once you've logged in to your VPS you need to create a new user and give it SSH In this tutorial we will be using `mcc` as a name for the user account that will be running the MCC. -

Tip

+

Note

**You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** @@ -833,13 +833,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -

Tip

+

Note

**When you're typing a password it will not be displayed on the screen, but you're typing it for real.**
-

Tip

+

Note

**Make sure you have a strong password!** @@ -993,7 +993,7 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -

Tip

+

Note

**If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** @@ -1012,7 +1012,7 @@ Now you can install the .NET 10 SDK and MCC.
.NET SDK installation on VPS -

Tip

+

Note

**If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** @@ -1073,7 +1073,7 @@ If it was successful, you can now install MCC. Now that you have the .NET SDK and a user account, install the `screen` utility. You will need it if you want MCC to keep running after you close the SSH session. -

Tip

+

Note

**There is also a Docker method, if you're using Docker, you do not need the `screen` program.** @@ -1107,13 +1107,13 @@ To start a screen, type: screen -S mcc ``` -

Tip

+

Note

**`mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.**
-

Tip

+

Note

**You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** diff --git a/docs/guide/usage.md b/docs/guide/usage.md index e57a23e1..7a9248d4 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -106,7 +106,7 @@ MCC also supports a few maintenance and debugging switches such as `--upgrade`, ### Quick usage of MCC with examples -

Tip

+

Note

**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** @@ -120,7 +120,7 @@ MinecraftClient.exe --section.setting=value [--other settings] MinecraftClient.exe [--other settings] ``` -

Tip

+

Note

**Microsoft accounts use the OAuth 2.0 device code flow and do not require a password on the command line. MCC will display a code and a URL for you to sign in through your browser (with full 2FA support). You can simply omit the password or use `""` as a placeholder.** @@ -198,7 +198,7 @@ From chat prompt, commands must by default be prepended with a slash, eg. `/quit In scripts and remote control, no slash is needed to perform the command, eg. `quit`. -

Tip

+

Note

**Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** @@ -261,7 +261,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q
blockinfo -

Tip

+

Note

**You need to have [Terrain And Movements](configuration.md#terrainandmovements) enabled in order for this to work.** @@ -321,7 +321,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. -

Tip

+

Note

**You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** @@ -348,7 +348,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q
-

Tip

+

Note

**You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** @@ -400,7 +400,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Drop all items of a specific type from your inventory. -

Tip

+

Note

**You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** @@ -412,7 +412,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` -

Tip

+

Note

**All item types can be found [here](https://mccteam.github.io/r/item/#L12).** @@ -429,7 +429,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q
enchant -

Tip

+

Note

**You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** @@ -460,7 +460,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Attack an entity, use an entity or get a list of entities around you. -

Tip

+

Note

**You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** @@ -480,7 +480,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` -

Tip

+

Note

**All entity types can be found [here](https://mccteam.github.io/r/entity/#L15).** @@ -509,7 +509,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. -

Tip

+

Note

**All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** @@ -528,7 +528,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /execif 'test == "Something"' "send Success!" ``` -

Tip

+

Note

**You can use single quote (`'`) to wrap your expression if the expression contains double quote (`"`)** @@ -606,7 +606,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` -

Tip

+

Note

**`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** @@ -621,7 +621,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads the active configuration file and chat bots. -

Tip

+

Note

**Some settings are not reloaded because they are used before client initialization. Settings passed on the command line also override file values.** @@ -648,13 +648,13 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` -

Tip

+

Note

**`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)**
-

Tip

+

Note

**`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** @@ -824,7 +824,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Use item in the hand, this can be used to do a right click on items which open menus on servers. -

Tip

+

Note

**You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** @@ -859,13 +859,13 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom -

Tip

+

Note

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

Tip

+

Note

**Not all inventories have a GUI representation in an ASCII art format.** @@ -898,21 +898,21 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. -

Tip

+

Note

**This command is available only when the [Follow Player](chat-bots.md#follow-player) chat bot is enabled.**
-

Tip

+

Note

**You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.**
-

Tip

+

Note

- **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + **You need to have [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.**
@@ -980,7 +980,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for moving when terrain and movements feature is enabled. -

Tip

+

Note

**You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** @@ -1100,7 +1100,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. -

Tip

+

Note

**You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** @@ -1116,7 +1116,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Inventory has slots and each one of them has an id. -

Tip

+

Note

**This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** @@ -1134,7 +1134,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` -

Tip

+

Note

**player and container can be simplified with p and c accordingly** @@ -1157,7 +1157,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle|Shift|ShiftRight] ``` -

Tip

+

Note

**The default click is left click** @@ -1175,7 +1175,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` -

Tip

+

Note

**To drop all items from a slot, you can use: `all`** @@ -1187,7 +1187,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` -

Tip

+

Note

**To find item types, check out [this list](https://mccteam.github.io/r/item/#L12)** @@ -1261,7 +1261,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` -

Tip

+

Note

**To find item types, check out [this list](https://mccteam.github.io/r/item/#L12)** @@ -1297,7 +1297,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. -

Tip

+

Note

**Use "/send /help" for server help** diff --git a/docs/guide/websocket/README.md b/docs/guide/websocket/README.md index a8a6c9d8..1f4af2f1 100644 --- a/docs/guide/websocket/README.md +++ b/docs/guide/websocket/README.md @@ -117,6 +117,14 @@ These are useful if your client needs a name-to-ID lookup for the current MCC ve - [Commands](Commands.md) - full list of available commands - [Events](Events.md) - full list of emitted events +

⭐ Reference Implementation: MCC.js

+ +[MCC.js](https://github.com/milutinke/MCC.js) is a Node.js/TypeScript library built for this bot. It handles authentication, JSON serialization, event subscriptions, and typed command wrappers out of the box. + +If you're writing a client in JavaScript or TypeScript, start there. + +
+ ## Compatibility - Requires any MCC version that supports `/script` (standalone MCCScript 1.0 bots).