diff --git a/docs/guide/chat-bots.md b/docs/guide/chat-bots.md index 26a5f7fd..5b59764f 100644 --- a/docs/guide/chat-bots.md +++ b/docs/guide/chat-bots.md @@ -860,15 +860,16 @@ #### `Items` +

Tip

+ + **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + +
+ - **Description:** This setting is where you can specify the list of items which you want to drop, or keep. -

Tip

- - **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** - -
- **Format:** `[ "", "", ...]` @@ -1231,18 +1232,18 @@ #### `Retries` +

Tip

+ + **This might get you banned by the server owners.** + +
+ - **Description:** Number of retries. Use `-1` for infinite retries. -

Tip

- - **This might get you banned by the server owners.** - -
- - **Default:** `-1` @@ -1306,6 +1307,12 @@ #### `Matches_File` +

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.** + +
+ - **Description:** This setting specifies the path to the file which contains the list of rules for detecting of keywords and responding on them. @@ -1314,12 +1321,6 @@ _PS: In the future we will document the rules here with examples too._ -

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` - **Default:** `matches.ini` @@ -1327,6 +1328,12 @@ #### `Match_Colors` +

Tip

+ + **This feature uses the `§` symbol for color matching** + +
+ - **Description:** This setting specifies if the Auto Respond Chat Bot should keep the color formatting send by the server. @@ -1335,12 +1342,6 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) -

Tip

- - **This feature uses the `§` symbol for color matching** - -
- - **Type:** `boolean` - **Default:** `true` @@ -1518,32 +1519,32 @@ #### `FileWords_EN` +

Tip

+ + **This settings file is for English and is not created by the default** + +
+ - **Description:** 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

- - **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) #### `FileWords_FR` +

Tip

+ + **This settings file is for French and is not created by the default** + +
+ - **Description:** This setting is same as the above but for French. -

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) @@ -1728,24 +1729,24 @@ #### `Should_Resize` +

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 image. The default map size is `128x128`. -

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** - -
- - **Available values:** `true` and `false`. - **Type:** `boolean` @@ -1766,16 +1767,16 @@ #### `Auto_Render_On_Update` +

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.** + +
+ - **Description:** This setting specifies if the Map Chat Bot should automatically render maps as they're received from the servers. -

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`. - **Type:** `boolean` @@ -1981,6 +1982,12 @@ ### Defining a task +

Tip

+ + **It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + +
+ - **Description:** Each task is defined as a new subsection `[[ChatBot.ScriptScheduler.TaskList]]` of the section: `[ChatBot.ScriptScheduler]`. @@ -1993,12 +2000,6 @@ = ``` -

Tip

- - **It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** - -
- **Avaliable settings/options:** - `Trigger_On_First_Login` diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 827bf229..b9fdf161 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -85,18 +85,18 @@ If the build has succeeded, the compiled binary `MinecraftClient.exe` will be in ### Linux, macOS +

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`)** + +
+ Requirements: - Git - Linux: -

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) - .NET SDK 6.0 or new-er