diff --git a/docs/guide/chat-bots.md b/docs/guide/chat-bots.md index 7d3fc522..1e08b2f2 100644 --- a/docs/guide/chat-bots.md +++ b/docs/guide/chat-bots.md @@ -8,17 +8,17 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -::: warning +

Warning

**Recently we have changed the configuration format from INI to TOML, this part of the documentation has only been partially updated, it's work in progress, for the time being please refer to the `MinecraftClient.ini` for setting names, the descriptions and options should be up to date in most cases, but not guaranteed.** -::: +
-::: tip +

Tip

**Settings refer to settings in the [configuration file](configuration.md)** -::: +
## List of built-in Chat Bots @@ -68,16 +68,16 @@ #### `Beep_Enabled` +

Tip

+ + **This might not work depending on your system or a console (terminal emulator).** + +
+ - **Description:** This setting specifies if you want to hear a beep when you get an alert. - ::: tip - - **This might not work depending on your system or a console (terminal emulator).** - - ::: - - **Type:** `boolean` - **Default:** `true` @@ -233,11 +233,11 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - ::: tip +

Tip

**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)** - ::: +
- **Available values:** `true` and `false`. @@ -261,11 +261,11 @@ This is the number of times the bot will try to pathfind, if he can't find a valid path for 20 times, he will use the command method. - ::: tip +

Tip

**This happens on each trigger of the task, so it does not permanently switch to alternative method.** - ::: +
- **Default:** `20` @@ -275,11 +275,11 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - ::: tip +

Tip

**You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** - ::: +
- **Settings:** @@ -426,11 +426,11 @@ Automatically craft items in your inventory or in a crafting table. - ::: tip +

Tip

**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.** - ::: +
- **Commands:** @@ -518,11 +518,11 @@ **Avaliable values:** `player` and `table` - ::: tip +

Tip

**If you're using `table` you need to set the `CraftingTable` setting.** - ::: +
- `Result` @@ -545,17 +545,17 @@ Slots = [ "", "", ... ] ``` - ::: tip +

Tip

**If you have a case where you have to leave some fields empty, use `"Null"` to mark them as empty. Example for stone bricks: `Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ]`** - ::: +
- ::: tip +

Tip

**All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** - ::: +
**Slots are indexed as following:** @@ -599,11 +599,11 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - ::: tip +

Tip

**Make sure to provide materials for your bot by placing them in inventory first.** - ::: +
## Auto Dig @@ -611,17 +611,17 @@ Automatically digs block on specified locations. - ::: tip +

Tip

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

Tip

**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.** - ::: +
- **Commands:** @@ -782,11 +782,11 @@ Automatically drop items you don't need from the inventory. - ::: tip +

Tip

**You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** - ::: +
- **Settings:** @@ -836,11 +836,11 @@ This setting is where you can specify the list of items which you want to drop, or keep. - ::: tip +

Tip

**All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** - ::: +
- **Format:** `[ "", "", ...]` @@ -856,11 +856,11 @@ Automatically eat food when your Hunger value is low. - ::: tip +

Tip

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

Tip

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

Tip

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

Tip

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

Tip

**A fishing rod with **Mending enchantment** is strongly recommended.** - ::: +
**Steps for using this bot (with the default setting)** @@ -1192,11 +1192,11 @@ Use `-1` for infinite retries. - ::: tip +

Tip

**This might get you banned by the server owners.** - ::: +
- **Default:** `-1` @@ -1228,17 +1228,17 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - ::: warning +

Warning

**Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** - ::: +
- ::: warning +

Warning

**This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** - ::: +
- **Settings:** @@ -1266,11 +1266,11 @@ _PS: In the future we will document the rules here with examples too._ - ::: tip +

Tip

**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.** - ::: +
- **Type:** `string` @@ -1286,11 +1286,11 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - ::: tip +

Tip

**This feature uses the `ยง` symbol for color matching** - ::: +
- **Type:** `boolean` @@ -1370,17 +1370,17 @@ This bot enables you to make a bot follow a specific player. - ::: tip +

Tip

**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 +

Tip

**You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** - ::: +
- **Settings:** @@ -1430,11 +1430,11 @@ 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 +

Tip

**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.** - ::: +
- **Settings:** @@ -1466,11 +1466,11 @@ This setting specifies the path to the file which Hangman will use for the list of words, each word is added on a separate line. - ::: tip +

Tip

**This settings file is for English and is not created by the default** - ::: +
- **Default:** `hangman-en.txt` - **Example**: [`words-en.txt`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/hangman-en.txt) @@ -1481,11 +1481,11 @@ This setting is same as the above but for French. - ::: tip +

Tip

**This settings file is for French and is not created by the default** - ::: +
- **Default:** `hangman-fr.txt` - **Example**: [`words-fr.txt`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/hangman-fr.txt) @@ -1522,17 +1522,17 @@ Show all ignored players. - ::: warning +

Warning

**The bot identifies players by their name (Not by UUID!). A nickname plugin or a Minecraft rename may cause mails going to the wrong player! Never write something to the bot you wouldn't say in the normal chat (You have been warned!).** - ::: +
- ::: warning +

Warning

**Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** - ::: +
**Mailer Network:** @@ -1631,11 +1631,11 @@ The maps are **rendered** into `Rendered_Maps` folder. - ::: warning +

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.** - ::: +
- **Commands:** @@ -1671,17 +1671,17 @@ The default map size is `128x128`. - ::: tip +

Tip

**The bigger the size, the less is the quality.** - ::: +
- ::: tip +

Tip

**For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** - ::: +
- **Available values:** `true` and `false`. @@ -1705,11 +1705,11 @@ This setting specifies if the Map Chat Bot should automatically render maps as they're received from the servers. - ::: warning +

Warning

**On some versions older than 1.17 this could cause some performance issue on older hardware if there a lot of maps being rendered, since map updates are sent multiple times a second. Be careful.** - ::: +
- **Available values:** `true` and `false`. @@ -1786,11 +1786,11 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - ::: warning +

Warning

**Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** - ::: +
- **Settings:** @@ -1838,23 +1838,23 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - ::: warning +

Warning

**This bot does not work for 1.19, we need maintainers for it.** - ::: +
- ::: tip +

Tip

**Please note that due to technical limitations, the client player (you) will not be shown in the replay file** - ::: +
- ::: warning +

Warning

**You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** - ::: +
- **Settings:** @@ -1920,11 +1920,11 @@ = ``` - ::: tip +

Tip

**It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** - ::: +
**Avaliable settings/options:** diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index e124e1d2..eab2c212 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -4,11 +4,11 @@ By the default all of the configurations are stored in the configuration file named `MinecraftClient.ini` which is created the first time you run the program, but you also can specify your own configuration file by providing a path to it as a first parameter when starting the MCC, check out [Usage](usage.md#quick-usage-of-mcc-with-examples) for examples. -::: warning +

Warning

**Recently we have changed the configuration format from INI to TOML, the documentation had to be updated. If you spot a mistake, please report it on our Discord or in the repository as an issue.** -::: +
## Notes @@ -102,11 +102,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - ::: tip +

Tip

**Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** - ::: +
- **Type:** `string` @@ -231,11 +231,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - ::: warning +

Warning

**Admins can impersonate players on versions older than 1.19** - ::: +
#### `MinecraftVersion` @@ -259,11 +259,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - ::: tip +

Tip

**MCC supports only 1.4.6 - 1.19.2** - ::: +
#### `EnableForge` @@ -281,11 +281,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - ::: tip +

Tip

**Force-enabling only works for MC 1.13 +** - ::: +
#### `BrandInfo` @@ -298,11 +298,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - ::: tip +

Tip

**For playing on Hypixel you need to use `vanilla`** - ::: +
#### `ChatbotLogFile` @@ -382,21 +382,21 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you can set if you want to enable terrain movement, so you can use command like `/move` and some bots. - ::: warning +

Warning

**This feature is currently not supported in `1.4.6 - 1.6`.** - ::: +
- **Type:** `boolean` - **Default:** `false` -::: tip +

Tip

**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** -::: +
#### `InventoryHandling` @@ -404,11 +404,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you can set if you want to enable inventory handling using the `/inventory` command. - ::: warning +

Warning

**This feature is currently not supported in `1.4.6 - 1.9`.** - ::: +
- **Type:** `boolean` @@ -420,21 +420,21 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you can set if you want to enable interactions with entities such as players, mobs, minecarts, etc.. - ::: warning +

Warning

**This feature is currently not supported in `1.4.6 - 1.9`.** - ::: +
- **Type:** `boolean` - **Default:** `false` - ::: tip +

Tip

**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** - ::: +
#### `SessionCache` @@ -483,11 +483,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - ::: tip +

Tip

**Only works on Windows XP-8 or Windows 10 with old console** - ::: +
#### `ExitOnFailure` @@ -529,11 +529,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - ::: tip +

Tip

**Make sure the spawn point is safe** - ::: +
#### `MinecraftRealms` @@ -585,11 +585,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -::: warning +

Warning

**A movement speed higher than 2 may be considered cheating by some plugins.** -::: +
### Account List section @@ -811,11 +811,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - ::: tip +

Tip

**Not filtering anything by default** - ::: +
#### `DebugFilterRegex` @@ -829,11 +829,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - ::: tip +

Tip

**Not filtering anything by default** - ::: +
#### `FilterMode` @@ -867,11 +867,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - ::: tip +

Tip

**%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`** - ::: +
#### `PrependTimestamp` @@ -905,11 +905,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } To define a variable/setting, simply make a new line with the following format under the `[AppVar.VarStirng]` section: - ::: tip +

Tip

**`%username%`, `%serverip%`, `%datetime%` are reserved variables** - ::: +
- **Section header:** `Logging` @@ -951,11 +951,11 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - ::: warning +

Warning

**Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** - ::: +
#### `Server` diff --git a/docs/guide/creating-bots.md b/docs/guide/creating-bots.md index 1b3c4557..eb972da1 100644 --- a/docs/guide/creating-bots.md +++ b/docs/guide/creating-bots.md @@ -8,11 +8,11 @@ ## Notes -::: tip +

Tip

**For now this page contains only the bare basics of the Chat Bot API, enough of details to teach you how to make basic Chat Bots. For more details you need to take a look at the [ChatBot.cs](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Scripting/ChatBot.cs) and [Examples](#examples). This page will be improved in the future.** -::: +
**Minecraft Console Client** has a rich C# API which allows you to create Chat Bots (effectively plugins) which can help you create complex automations which normal scripts may not be able to do. @@ -36,11 +36,11 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -::: tip +

Tip

**Here we will use terms Chat Bot and Script interchangeably** -::: +
Create a new empty file and name it `ExampleChatBot.cs` in the same folder where you have your MCC installed. @@ -118,11 +118,11 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -::: tip +

Tip

**Avoid adding whitespace between `//` and keywords** -::: +
By the default the following packages are loaded: @@ -169,11 +169,11 @@ There are no required methods, everything is optional. When the Chat Bot (Script) has been initialized for the first time the `Initialize` method will be called. In it you can initialize variables, eg. Dictionaries, etc.. -::: tip +

Tip

**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** -:::. +
. ## Examples diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 501e5f4d..9f8efb67 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -18,13 +18,13 @@ If you're not the kind of person that likes textual tutorials, our community has In order to run **Minecraft Console Client** you need [.NET 6.0 or new-er](https://dotnet.microsoft.com/en-us/download) -::: warning +

Warning

**If you already have .NET, but an older version than `6.0`, please update to `6.0` since MCC might not work as expected or at all.** -::: +
#### How to install .NET on your platform @@ -93,11 +93,11 @@ Requirements: - Linux: - ::: tip +

Tip

**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`)** - ::: +
- [Install Git on macOS](https://git-scm.com/download/mac) @@ -124,11 +124,11 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive dotnet publish MinecraftClient -f net6.0 -r linux-x64 --no-self-contained -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None ``` - ::: tip +

Tip

**If you're using Linux that is either ARM, 32-bit, Rhel based, Using Musl, or Tirzen, [find an appropriate RID](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog#linux-rids) for your platform and replace the `'-r linux-64` with an appropriate `-r ` (Example for arm: `-r linux-arm64`)** - ::: +
- On macOS: @@ -136,11 +136,11 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive dotnet publish MinecraftClient -f net6.0 -r osx-x64 --no-self-contained -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None ``` - ::: tip +

Tip

**If you're not using MAC with Intel, find an appropriate RID for your ARM processor, [find an appropriate RID](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog#macos-rids) and replace the `'-r osx-64` with an appropriate `-r ` (Example for arm: `-r osx.12-arm64`)** - ::: +
If the build has succeeded, the compiled binary `MinecraftClient` will be in: @@ -154,17 +154,17 @@ Requirements: - Git - Docker -::: tip +

Tip

**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.** -::: +
-::: warning +

Warning

**Pay attention at warnings, Docker currently works, but you must start the containers in the interactive mode or MCC will crash, we're working on solving this.** -::: +
1. Clone the [Git Hub Repository](https://github.com/MCCTeam/Minecraft-Console-Client) by typing end executing the following command: @@ -181,11 +181,11 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -::: danger +

Danger

**There is a bug with the ConsoleInteractive which causes a crash when a container is started in a headless mode, so you need to use the interactive mode. Do not restart containers in a classic way, stop then and start them with interactive mode (this command), after that simply detach with `CTRL + P` and then `CTRL + Q`.** -::: +
```bash # You could also ignore the -v parameter if you dont want to mount the volume that is up to you. If you don't it's harder to edit the .ini file if thats something you want to do @@ -237,47 +237,47 @@ docker-compose down It is possible to run the Minecraft Console Client on Android through Termux and Ubuntu 22.04 in it, however it requires a manual setup with a lot of commands, be careful no to skip any steps. Note that this might take anywhere from 10 to 20 minutes or more to do depending on your technical knowledge level, Internet speed and CPU speed. -::: tip +

Tip

**This section is going to get a bit technical, I'll try my best to make everything as simple as possible. If you are having trouble following along or if you encounter any issues, feel free to open up a discussion on our Github repository page.** -::: +
-::: tip +

Tip

**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 +

Tip

**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.** -::: +
### Installation #### Termux -::: warning +

Warning

**The Play Store version of Termux is outdated and not supported, do not use it, use the the [Github one](https://github.com/termux/termux-app/releases/latest/).** -::: +
Go to [the Termux Github latest release](https://github.com/termux/termux-app/releases/latest/), download the `debug_universal.apk`, unzip it and run it. -::: tip +

Tip

**If your file manager does not let you run APK files, install and use `File Manager +` and give it a permission to install 3rd party applications when asked.** -::: +
-::: danger +

Danger

**Once you have installed Termux, open it, bring down the Android menu for notifications, on Termux notification, drag down until you see the following options: `Exit | Acquire wakelock`, press on the `Acquire wakelock` and allow Termux to have a battery optimization exclusion permission when asked. If you do not do this, your performance will be poorer and the Termux might get killed by Android while running in the background!** -::: +
#### Installing Ubuntu 22.04 @@ -286,11 +286,11 @@ At this stage, you have 2 options: 1. Following this textual tutorial 2. Watching a [Youtube tutorial for installing Ubuntu](https://www.youtube.com/watch?v=5yit2t7smpM) -::: tip +

Tip

**If you decide to watch the Youtube tutorial, watch only up to `1:58`, the steps after are not needed and might just confuse you.** -::: +
In order to install Ubuntu 22.04 in Termux you require `wget` and `proot`, we're going to install them in the next step. @@ -300,11 +300,11 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -::: tip +

Tip

**If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** -::: +
Then you need to download an installation script using the following command: @@ -325,11 +325,11 @@ Once the installation is complete, you can start Ubuntu with: ./startubuntu.sh ``` -::: tip +

Tip

**Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** -::: +
#### Installing .NET on ARM @@ -363,46 +363,46 @@ First you need to download .NET 6.0, you can do it with the following command: wget https://download.visualstudio.microsoft.com/download/pr/901f7928-5479-4d32-a9e5-ba66162ca0e4/d00b935ec4dc79a27f5bde00712ed3d7/dotnet-sdk-6.0.400-linux-arm64.tar.gz ``` -::: tip +

Tip

**This tutorial assumes that you have 64 bit version of ARM processor, if you happen to have a 32-bit version replace the link in the command above with [this one](https://download.visualstudio.microsoft.com/download/pr/cf567026-a29a-41aa-bc3a-e4e1ad0df480/0925d411e8e09e31ba7a39a3eb0e29af/aspnetcore-runtime-6.0.8-linux-arm.tar.gz)** -::: +
-::: tip +

Tip

**This tutorial assumes that you're following along and using Ubuntu 22.04, if you're using a different distro, like Alpine, go to [here](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) and copy an appropriate link for your distro.** -::: +
Once the file has been downloaded, you need to run the following commands in order: 1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` - ::: warning +

Warning

**If you're using a different download link, update the file name in this command to match your version.** - ::: +
2. `export DOTNET_ROOT=/root/.dotnet` - ::: warning +

Warning

**Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** - ::: +
3. `mkdir -p "$DOTNET_ROOT" && tar zxf "$DOTNET_FILE" -C "$DOTNET_ROOT"` 4. `export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools` Now we need to tell our shell to know where the `dotnet` command is, for future sessions, since the commands above just tell this current session where the `dotnet` is located. -::: warning +

Warning

**You will need a basic knowledge of Nano text editor, if you do not know how to use it, watch this [Youtube video tutorial](https://www.youtube.com/watch?v=DLeATFgGM-A)** -::: +
To enable this, we need to edit our `/root/.bashrc` file with the following command: @@ -417,11 +417,11 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -::: warning +

Warning

**Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** -::: +
Save the file usign the following combination of keys: `CTRL + X`, type `Y` and press Enter. @@ -453,11 +453,11 @@ path-to-application: Finally, we can install MCC. -::: warning +

Warning

**If you have a 32 ARM processor, you need to build the MCC yourself, take a look at the [Building From Source](#building-from-the-source-code) section. Also make sure to be using the appropriate `-r` parameter value for your architecture.** -::: +
Let's make a folder where the MCC will be stored with the following command: @@ -517,11 +517,11 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -::: tip +

Tip

**This is a new section, if you find a mistake, please report it by opening an Issue in our [Github repository](https://github.com/MCCTeam/Minecraft-Console-Client). Thank you!** -::: +
The **Minecraft Console Client** can be run on a VPS 24 hours, 7 days a week. @@ -548,11 +548,11 @@ Here is a [Youtube video](https://youtu.be/42fwh_1KP_o) that explains it in more Download and install [Gitbash](https://git-scm.com/downloads). - ::: tip +

Tip

**Make sure to allow the installation to add it to the context menu** - ::: +
2. `ssh` and `ssh-keygen` commands (On Windows they're available with Gitbash, on macOs and Linux they should be available by default, it not, search on how to install them) @@ -587,11 +587,11 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -::: danger +

Danger

**In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** -::: +
Some of the reliable and cheap hosting providers (sorted for price/performance): @@ -599,11 +599,11 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - ::: tip +

Tip

**Does not have Ubuntu 22.04 in the dropdown menu when ordering, you will have to re-install later or ask support to do it.** - ::: +
- [OVH Cloud](https://www.ovhcloud.com/de/vps/) @@ -627,48 +627,48 @@ You also may want to search for better deals. #### AWS EC2 VPS -::: danger +

Danger

**This will require you to have a valid debit card that can be used on internet and a mobile phone number, as well as giving that info to Amazon corporation.** -::: +
-::: warning +

Warning

**Scammers often get AWS VPS and use it to mass login on to stolen Microsoft accounts, some AWS IP addresses might be blocked by Microsoft because of that, if so, you might need to switch regions or to use a Proxy. To debug if your IP has been banned by Microsoft, use the `ping ` and `traceroute ` commands.** -::: +
-::: warning +

Warning

**Related to the warning above, if you have issues logging with Microsoft and you're not banned, you may want to check the Security center on your account and approve the login from the VPS, this can be the case for some users.** -::: +
-::: tip +

Tip

**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.** -::: +
Register on AWS and enter all of your billing info and a phone number. Once you're done, you can continue to [Setting up the Amazon VPS](#setting-up-an-aws-vps). ### Initial Amazon VPS setup -::: tip +

Tip

**Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** -::: +
When you register and open the `AWS Console`, click on the Search field on the top of the page and search for: `EC2` -::: tip +

Tip

**Make sure to select the region closest to you for the minimal latency** -::: +
Click on the **Launch instance** button. @@ -678,11 +678,11 @@ Fill out the `Name` field with a name of your preference. For the **Application and OS images** select `Ubuntu Server 22.04 LTS (HVM), SSD Volume Type`. -::: danger +

Danger

**Make sure that it has `Free tier eligible` next to it.** -::: +
![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -690,11 +690,11 @@ For the **Instance type** select `t2.micro`. For the **Key pair (login)** click on **Create new key pair** and name it `VpsRoot`, leave the rest of settings as default and click **Create key pair**, this will generate a RSA private key that will be automatically downloaded. -::: danger +

Danger

**Make sure that you save this file in a safe place and do not loose it, it's of an upmost importance since it's used to access the root/admin account of the VPS. Without it you will not be able to access the root account of the VPS! Also do not let it fall into wrong hands.** -::: +
![VPS Instance Type](/images/guide/VPS_InstanceType.png) @@ -704,11 +704,11 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -::: tip +

Tip

**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.** -::: +
![VPS Network Settings](/images/guide/VPS_NetworkSettings.png) @@ -728,17 +728,17 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -::: tip +

Tip

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

Tip

**`ubuntu` is a default root account username for Ubuntu on AWS!** -::: +
Example: @@ -752,11 +752,11 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -::: tip +

Tip

**This section if for those who do not use AWS, if you use AWS skip it** -::: +
When you order the VPS, most likely you will be asked to provide the root account name and password, if it is the case, name the account as `root` and give it a password of your choice. @@ -770,11 +770,11 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -::: tip +

Tip

**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 @:`)** -::: +
Example: @@ -796,11 +796,11 @@ 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 +

Tip

**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.** -::: +
To create a new user named `mcc` execute the following command: @@ -814,17 +814,17 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -::: tip +

Tip

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

Tip

**Make sure you have a strong password!** -::: +
Now we need to give our user account the admin permissions: @@ -971,11 +971,11 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -::: tip +

Tip

**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`)!** -::: +
If did everything correctly you should see a Linux prompt and a welcome message if there is one on your provider. @@ -985,17 +985,17 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -::: tip +

Tip

**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.** -::: +
-::: warning +

Warning

**With newer versions of .NET Core 6 on Ubuntu 22.04 you might get the following error: `A fatal error occurred, the folder [/usr/share/dotnet/host/fxr] does not contain any version-numbered child folders`, if you get it, use [this solution](https://github.com/dotnet/sdk/issues/27082#issuecomment-1211143446)** -::: +
Log in as the user you've created. @@ -1071,11 +1071,11 @@ If it was successful, you can now install the MCC. Now that you have .NET Core 6.0 and a user account, you should install the `screen` utility, you will need this in order to keep the MCC running once you close down the SSH session (if you do not have it, the MCC will just stop working once you disconnect). You can look at the `screen` like a window, except it's in a terminal, it lets you have multiple "windows" open at the same time. -::: tip +

Tip

**There is also a Docker method, if you're using Docker, you do not need the `screen` program.** -::: +
You also can learn about the screen command from [this Youtube tutorial](https://youtu.be/_ZJiEX4rmN4). @@ -1093,11 +1093,11 @@ Now you can install the MCC: How to use the `screen` command? -::: warning +

Warning

**If you have issues with Screen command, like output not being properly formatted or program handing/freezing, try using tmux, click [here](https://www.youtube.com/watch?v=Yl7NFenTgIo) to learn how to use it.** -::: +
To start a screen, type: @@ -1105,17 +1105,17 @@ To start a screen, type: screen -S mcc ``` -::: tip +

Tip

**`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 +

Tip

**You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** -::: +
Now you will be in the screen, now you can start the MCC and detach from the screen. diff --git a/docs/guide/usage.md b/docs/guide/usage.md index 9b0c3d60..cc1a21ff 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -16,11 +16,11 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -::: tip +

Tip

**On Windows it's best using [Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/install) for the best experience and looks. Some features like emojis in the [`/chunk`](#chunk) command do not work in CMD or Powershell 5** -::: +
## Linux, macOS @@ -95,11 +95,11 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -::: tip +

Tip

**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** -::: +
```bash MinecraftClient.exe --help @@ -178,11 +178,11 @@ 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 +

Tip

**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.** -::: +
### `animation` @@ -265,11 +265,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - ::: tip +

Tip

**You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** - ::: +
- **Usage:** @@ -283,17 +283,17 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Displays the chunk loading status in a nice way. - ::: warning +

Warning

**To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** - ::: +
- ::: tip +

Tip

**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)** - ::: +
- **Usage:** @@ -335,11 +335,11 @@ 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 +

Tip

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

Tip

**All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** - ::: +
- **Example:** @@ -365,11 +365,11 @@ 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 +

Tip

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

Tip

**All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** - ::: +
- **Examples:** @@ -410,11 +410,11 @@ 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 +

Tip

**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** - ::: +
- **Usage:** @@ -492,11 +492,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - ::: tip +

Tip

**`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** - ::: +
### `reload` @@ -504,11 +504,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - ::: tip +

Tip

**Some settings won't be reloaded since they are used before the client initialization. Also, settings provided by the command line paramteres will be overriden. This also does not reload the ReplayBot due to technical limitations.** - ::: +
- **Usage:** @@ -528,17 +528,17 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - ::: tip +

Tip

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

Tip

**`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** - ::: +
### `script` @@ -674,17 +674,17 @@ 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 +

Tip

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

Warning

**The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** - ::: +
- **Usage:** @@ -706,23 +706,23 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - ::: tip +

Tip

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

Tip

**Not all inventories have a GUI representation in an ASCII art format.** - ::: +
- ::: warning +

Warning

**The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** - ::: +
- **Usage:** @@ -742,23 +742,23 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - ::: tip +

Tip

**This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** - ::: +
- ::: tip +

Tip

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

Tip

**You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** - ::: +
- **Usage:** @@ -796,17 +796,17 @@ 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 +

Tip

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

Warning

**The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** - ::: +
- **Usage:** @@ -862,27 +862,27 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - ::: tip +

Tip

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

Warning

**The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** - ::: +
MCC defines inventories as containers internally, so player's inventory, chests, droppers, dispensers, hoppers, chest minecarts, barrels, furnaces, etc... are all considered a container, and each one of them has it's ID, the words container and inventory can be used interchangeably. Inventory has slots and each one of them has an id. - ::: tip +

Tip

**This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** - ::: +
An example of player inventory with annotated IDs in ASCII art and a list of items: @@ -896,11 +896,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - ::: tip +

Tip

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

Tip

**The default click is left click** - ::: +
Close an inventory: @@ -938,11 +938,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - ::: tip +

Tip

**To drop all items from a slot, you can use: `all`** - ::: +
Give an item to the player inventory from a creative menu when in the creative mode: @@ -950,11 +950,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - ::: tip +

Tip

**To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** - ::: +
Delete an item from a player's inventory when in the creative mode: @@ -1024,11 +1024,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - ::: tip +

Tip

**To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** - ::: +
Delete an item from a player's inventory in slot number/id `36` when in the creative mode: @@ -1054,8 +1054,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - ::: tip +

Tip

**Use "/send /help" for server help** - ::: +