helpy4/Minecraft-Console-Client
1
0
Fork 0
mirror of https://github.com/MCCTeam/Minecraft-Console-Client synced 2025-11-07 17:36:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix format error

Browse source
This commit is contained in:
BruceChen 2022-11-04 16:26:53 +08:00
parent a23747e236
commit b3ca0a1b33
7 changed files with 163 additions and 75 deletions
Download patch file Download diff file Expand all files Collapse all files

176
docs/guide/chat-bots.md
View file

@ -66,6 +66,7 @@
- **Default:** `false`
#### `Beep_Enabled`
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
@ -82,6 +83,7 @@
- **Default:** `true`
#### `Trigger_By_Words`
- **Description:**
@ -94,6 +96,7 @@
- **Default:** `false`
#### `Trigger_By_Rain`
- **Description:**
@ -106,6 +109,7 @@
- **Default:** `false`
#### `Trigger_By_Thunderstorm`
- **Description:**
@ -118,6 +122,7 @@
- **Default:** `false`
#### `Log_To_File`
- **Description:**
@ -130,6 +135,7 @@
- **Default:** `false`
#### `Log_File`
- **Description:**
@ -140,6 +146,7 @@
- **Default:** `"alerts-log.txt"`
#### `Matches`
- **Description:**
@ -154,6 +161,7 @@
Matches = [ "Yourname", " whispers ", "-> me", "admin", ".com", ]
```
#### `Excludes`
- **Description:**
@ -190,14 +198,14 @@
- **Default:** `false`
#### `Delay`
- **Description:**
The time interval for execution in seconds.
If the `min` and `max` are the same, the time interval will be consistent.
However if they are not the same, the plugin will choose a random number between `min` and `max`, this is useful if you want to have a random interval to trick anti afk plugins.
If the `min` and `max` are the same, the time interval will be consistent. However if they are not the same, the plugin will choose a random number between `min` and `max`, this is useful if you want to have a random interval to trick anti afk plugins.
- **Format:** `{ min = <seconds>, max = <seconds> }`
@ -205,6 +213,7 @@
- **Default:** `{ min = 60.0, max = 60.0 }`
#### `Command`
- **Description:**
@ -215,6 +224,7 @@
- **Default:** `/ping`
#### `Use_Sneak`
- **Description:**
@ -225,26 +235,28 @@
- **Default:** `false`
#### `Use_Terrain_Handling`
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**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)**
</div>
- **Description:**
Should the bot use [Terrain Handling](configuration.md#terrainandmovements) instead of the command method.
This will enable your bot to randomly move about, thus a better anti afk effect.
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**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)**
</div>
- **Available values:** `true` and `false`.
- **Type:** `boolean`
- **Default:** `false`
#### `Walk_Range`
- **Description:**
@ -255,32 +267,33 @@
- **Default:** `5`
#### `Walk_Retries`
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**This happens on each trigger of the task, so it does not permanently switch to alternative method.**
</div>
- **Description:**
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.
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**This happens on each trigger of the task, so it does not permanently switch to alternative method.**
</div>
- **Default:** `20`
## Auto Attack
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.**
</div>
- **Description:**
Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs.
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.**
</div>
- **Settings:**
**Section:** **`ChatBot.AutoAttack`**
@ -297,6 +310,7 @@
- **Default:** `false`
#### `Mode`
- **Description:**
@ -315,6 +329,7 @@
- **Default:** `single`
#### `Priority`
- **Description:**
@ -328,6 +343,7 @@
- **Default:** `distance`
#### `Cooldown_Time`
- **Description:**
@ -346,6 +362,7 @@
- **Default:** `{ Custom = false, value = 1.0 }`
#### `Interaction`
- **Description:**
@ -368,6 +385,7 @@
- **Default:** `Attack`
#### `Attack_Hostile`
- **Description:**
@ -380,6 +398,7 @@
- **Default:** `true`
#### `Attack_Passive`
- **Description:**
@ -392,6 +411,7 @@
- **Default:** `false`
#### `List_Mode`
- **Description:**
@ -404,6 +424,7 @@
- **Default:** `whitelist`
#### `Entites_List`
- **Description:**
@ -422,16 +443,16 @@
## Auto Craft
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**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.**
</div>
- **Description:**
Automatically craft items in your inventory or in a crafting table.
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**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.**
</div>
- **Commands:**
- `/autocraft list`
@ -454,6 +475,7 @@
**Section:** **`ChatBot.AutoCraft`**
#### `Enabled`
- **Description:**
@ -466,6 +488,7 @@
- **Default:** `false`
#### `CraftingTable`
- **Description:**
@ -488,6 +511,7 @@
CraftingTable = { X = 123.0, Y = 65.0, Z = 456.0 }
```
#### `OnFailure`
- **Description:**
@ -502,7 +526,14 @@
- **Default:** `abort`
### Defining a recipe
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**If you're using `table` you need to set the `CraftingTable` setting.**
</div>
The recipes are defines as a separate new sub-section `[[ChatBot.AutoCraft.Recipes]]` of the `[ChatBot.AutoCraft]` section.
@ -518,12 +549,6 @@
**Avaliable values:** `player` and `table`
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**If you're using `table` you need to set the `CraftingTable` setting.**
</div>
- `Result`
This is the type of resulting item.
@ -534,8 +559,7 @@
- `Slots`
This setting is an array/list of material names (strings) that go into an each slot (max 9 elements).
Empty slots should be marked with `"Null"`
This setting is an array/list of material names (strings) that go into an each slot (max 9 elements). Empty slots should be marked with `"Null"`
**Type:** `array of strings`
@ -545,17 +569,6 @@
Slots = [ "<material/item type>", "<material/item type>", ... ]
```
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**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", ]`**
</div>
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).**
</div>
**Slots are indexed as following:**
@ -601,6 +614,10 @@
<div class="custom-container tip"><p class="custom-container-title">Tip</p>
**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", ]`**
**All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).**
**Make sure to provide materials for your bot by placing them in inventory first.**
</div>
@ -633,6 +650,7 @@
**Section:** **`ChatBot.AutoDig`**
#### `Enabled`
- **Description:**
@ -645,6 +663,7 @@
- **Default:** `false`
#### `Mode`
- **Description:**
@ -669,6 +688,7 @@
- **Default:** `lookat`
#### `Locations`
- **Description:**
@ -694,6 +714,7 @@
]
```
#### `Location_Order`
- **Description:**
@ -714,6 +735,7 @@
- **Default:** `distance`
#### `Auto_Start_Delay`
- **Description:**
@ -726,6 +748,7 @@
- **Default:** `3.0`
#### `Dig_Timeout`
- **Description:**
@ -736,6 +759,7 @@
- **Default:** `60.0`
#### `Log_Block_Dig`
- **Description:**
@ -748,6 +772,7 @@
- **Default:** `true`
#### `List_Type`
- **Description:**
@ -760,6 +785,7 @@
- **Default:** `whitelist`
#### `Blocks`
- **Description:**
@ -804,6 +830,7 @@
- **Default:** `false`
#### `Mode`
- **Description:**
@ -830,6 +857,7 @@
- **Default:** `include`
#### `Items`
- **Description:**
@ -878,6 +906,7 @@
- **Default:** `false`
#### `Threshold`
- **Description:**
@ -929,6 +958,7 @@
**Section:** **`ChatBot.AutoFishing`**
#### `Enabled`
- **Description:**
@ -941,6 +971,7 @@
- **Default:** `false`
#### `Antidespawn`
- **Description:**
@ -953,6 +984,7 @@
- **Default:** `false`
#### `Mainhand`
- **Description:**
@ -968,6 +1000,7 @@
- **Default:** `true`
#### `Auto_Start`
- **Description:**
@ -980,6 +1013,7 @@
- **Default:** `true`
#### `Cast_Delay`
- **Description:**
@ -990,6 +1024,7 @@
- **Default:** `0.4`
#### `Fishing_Delay`
- **Description:**
@ -1002,6 +1037,7 @@
- **Default:** `3.0`
#### `Fishing_Timeout`
- **Description:**
@ -1012,6 +1048,7 @@
- **Default:** `300.0`
#### `Durability_Limit`
- **Description:**
@ -1024,6 +1061,7 @@
- **Default:** `2`
#### `Auto_Rod_Switch`
- **Description:**
@ -1036,6 +1074,7 @@
- **Default:** `true`
#### `Stationary_Threshold`
- **Description:**
@ -1052,6 +1091,7 @@
- **Default:** `0.001`
#### `Hook_Threshold`
- **Description:**
@ -1066,6 +1106,7 @@
- **Default:** `0.2`
#### `Log_Fish_Bobber`
- **Description:**
@ -1080,6 +1121,7 @@
- **Default:** `false`
#### `Enable_Move`
- **Description:**
@ -1094,6 +1136,7 @@
- **Default:** `false`
### Adding a position/movement
Each position/movement is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection of `[ChatBot.AutoFishing]`.
@ -1134,6 +1177,7 @@
facing = { yaw = 12.34, pitch = -23.45 }
```
#### Full example
```toml
@ -1167,14 +1211,14 @@
- **Default:** `false`
#### `Delay`
- **Description:**
The delay time before joining the server.
If the `min` and `max` are the same, the time will be consistent, however, if you want a random time, you can set `min` and `max` to different values to get a random time.
The time format is in seconds, and the type is double. (eg. `37.0`)
If the `min` and `max` are the same, the time will be consistent, however, if you want a random time, you can set `min` and `max` to different values to get a random time. The time format is in seconds, and the type is double. (eg. `37.0`)
- **Format:** `{ min = <seconds (double)>, max = <seconds (double)> }`
@ -1184,6 +1228,7 @@
- **Default:** `{ min = 3.0, max = 3.0 }`
#### `Retries`
- **Description:**
@ -1200,6 +1245,7 @@
- **Default:** `-1`
#### `Ignore_Kick_Message`
- **Description:**
@ -1210,6 +1256,7 @@
- **Default:** `false`
#### `Kick_Messages`
- **Description:**
@ -1256,6 +1303,7 @@
- **Default:** `false`
#### `Matches_File`
- **Description:**
@ -1276,6 +1324,7 @@
- **Default:** `matches.ini`
#### `Match_Colors`
- **Description:**
@ -1316,6 +1365,7 @@
- **Default:** `false`
#### `Add_DateTime`
- **Description:**
@ -1326,6 +1376,7 @@
- **Default:** `true`
#### `Log_File`
- **Description:**
@ -1334,6 +1385,7 @@
- **Default:** `chatlog-%username%-%serverip%.txt`
#### `Filter`
- **Description:**
@ -1398,6 +1450,7 @@
- **Default:** `false`
#### `Update_Limit`
- **Description:**
@ -1410,6 +1463,7 @@
- **Default:** `1.5`
#### `Stop_At_Distance`
- **Description:**
@ -1450,6 +1504,7 @@
- **Default:** `false`
#### `English`
- **Description:**
@ -1460,6 +1515,7 @@
- **Default:** `true`
#### `FileWords_EN`
- **Description:**
@ -1475,6 +1531,7 @@
- **Default:** `hangman-en.txt`
- **Example**: [`words-en.txt`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/hangman-en.txt)
#### `FileWords_FR`
- **Description:**
@ -1503,8 +1560,7 @@
- `/tell <Bot> mail [RECIPIENT] [MESSAGE]`: Save your message for future delivery
- `/tell <Bot> tellonym [RECIPIENT] [MESSAGE]`: Same, but the recipient will receive an anonymous mail
The bot will automatically deliver the mail when the recipient is online.
The bot also offers a /mailer command from the MCC command prompt:
The bot will automatically deliver the mail when the recipient is online. The bot also offers a /mailer command from the MCC command prompt:
- `/mailer getmails`
@ -1546,6 +1602,7 @@
**Section:** **`ChatBot.Mailer`**
#### `Enabled`
- **Description:**
@ -1558,6 +1615,7 @@
- **Default:** `false`
#### `DatabaseFile`
- **Description:**
@ -1568,17 +1626,18 @@
- **Default:** `MailerDatabase.ini`
#### `IgnoreListFile`
- **Description:**
This setting specifies the path to the file where the Mailer Chat Bot will load people who are to be ignored by the Chat Bot.
If you want to prevent someone from using this chat bot, add him in this file by writing his nickname on a new line.
This setting specifies the path to the file where the Mailer Chat Bot will load people who are to be ignored by the Chat Bot. If you want to prevent someone from using this chat bot, add him in this file by writing his nickname on a new line.
This file will be auto created by the Mailer Chat Bot.
- **Default:** `MailerIgnoreList.ini`
#### `PublicInteractions`
- **Description:**
@ -1591,6 +1650,7 @@
- **Default:** `false`
#### `MaxMailsPerPlayer`
- **Description:**
@ -1601,6 +1661,7 @@
- **Default:** `10`
#### `MaxDatabaseSize`
- **Description:**
@ -1611,6 +1672,7 @@
- **Default:** `10000` (10 MB)
#### `MailRetentionDays`
- **Description:**
@ -1663,6 +1725,7 @@
- **Default:** `false`
#### `Should_Resize`
- **Description:**
@ -1689,6 +1752,7 @@
- **Default:** `false`
#### `Resize_To`
- **Description:**
@ -1699,6 +1763,7 @@
- **Default:** `256`
#### `Auto_Render_On_Update`
- **Description:**
@ -1717,6 +1782,7 @@
- **Default:** `false`
#### `Delete_All_On_Unload`
- **Description:**
@ -1729,6 +1795,7 @@
- **Default:** `true`
#### `Notify_On_First_Update`
- **Description:**
@ -1760,6 +1827,7 @@
- **Default:** `false`
#### `File`
- **Description:**
@ -1768,6 +1836,7 @@
- **Default:** `playerlog.txt`
#### `Delay`
- **Description:**
@ -1808,6 +1877,7 @@
- **Default:** `false`
#### `AutoTpaccept`
- **Description:**
@ -1820,6 +1890,7 @@
- **Default:** `true`
#### `AutoTpaccept_Everyone`
- **Description:**
@ -1872,6 +1943,7 @@
- **Default:** `false`
#### `Backup_Interval`
- **Description:**
@ -1906,6 +1978,7 @@
- **Default:** `false`
### Defining a task
- **Description:**
@ -1980,6 +2053,7 @@
Trigger_On_Interval = { Enable = true, MinTime = 30.0, MaxTime = 160.0 }
```
### Full example
```toml