From b3ca0a1b33e663dcc0aa5f55aa6b54e7557b3294 Mon Sep 17 00:00:00 2001 From: BruceChen Date: Fri, 4 Nov 2022 16:26:53 +0800 Subject: [PATCH] Fix format error --- docs/guide/README.md | 29 +++-- docs/guide/chat-bots.md | 176 ++++++++++++++++++++-------- docs/guide/configuration.md | 18 +-- docs/guide/creating-bots.md | 2 + docs/guide/installation.md | 9 ++ docs/guide/usage.md | 2 + docs/l10n/af/guide/configuration.md | 2 +- 7 files changed, 163 insertions(+), 75 deletions(-) diff --git a/docs/guide/README.md b/docs/guide/README.md index 0b260ea8..059760b3 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -89,7 +89,7 @@ Click [here](https://github.com/MCCTeam/Minecraft-Console-Client/discussions) to ## Bugs, Ideas, Feature Requests -Bug reporting, idea submitting or feature requesting are done in the [Issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues) section of our [Github repository](<[here](https://github.com/MCCTeam/Minecraft-Console-Client)>). +Bug reporting, idea submitting or feature requesting are done in the [Issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues) section of our [Github repository]([here](https://github.com/MCCTeam/Minecraft-Console-Client)). Navigate to the Issues section, search for a bug, idea or a feature using the search option here in the documentation and in the `Issues` section on Git Hub before making your own. @@ -134,36 +134,32 @@ mobdon, MousePak, TNT-UP, TorchRJ, yayes2, Yoann166, ZizzyDizzyMC and [many more **Bug Hunters** -1092CQ, ambysdotnet, bearbear12345, c0dei, Cat7373, Chtholly, Darkaegis, dbear20, -DigitalSniperz, doranchak, drXor, FantomHD, gerik43, ibspa, iTzMrpitBull, JamieSinn, -k3ldon, KenXeiko, link3321, lyze237, mattman00000, Nicconyancat, Pokechu22, ridgewell, -Ryan6578, Solethia, TNT-UP, TorchRJ, TRTrident, WeedIsGood, xp9kus, Yoann166 and [many more](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+%5BBUG%5D+is%3Aopen+). +1092CQ, ambysdotnet, bearbear12345, c0dei, Cat7373, Chtholly, Darkaegis, dbear20, DigitalSniperz, doranchak, drXor, FantomHD, gerik43, ibspa, iTzMrpitBull, JamieSinn, k3ldon, KenXeiko, link3321, lyze237, mattman00000, Nicconyancat, Pokechu22, ridgewell, Ryan6578, Solethia, TNT-UP, TorchRJ, TRTrident, WeedIsGood, xp9kus, Yoann166 and [many more](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+%5BBUG%5D+is%3Aopen+). **Contributors** -Allyoutoo, Aragas, Bancey, bearbear12345, corbanmailloux, Daenges, dbear20, dogwatch, -initsuj, JamieSinn, justcool393, lokulin, maxpowa, medxo, milutinke, Pokechu22, -ReinforceZwei, repository, TheMeq, TheSnoozer, vkorn, v1RuX, yunusemregul, ZizzyDizzyMC, -BruceChenQAQ, bradbyte -_... And all the [GitHub contributors](https://github.com/MCCTeam/Minecraft-Console-Client/graphs/contributors)!_ +Allyoutoo, Aragas, Bancey, bearbear12345, corbanmailloux, Daenges, dbear20, dogwatch, initsuj, JamieSinn, justcool393, lokulin, maxpowa, medxo, milutinke, Pokechu22, ReinforceZwei, repository, TheMeq, TheSnoozer, vkorn, v1RuX, yunusemregul, ZizzyDizzyMC, BruceChenQAQ, bradbyte _... And all the [GitHub contributors](https://github.com/MCCTeam/Minecraft-Console-Client/graphs/contributors)!_ **Libraries:** Minecraft Console Client also borrows code from the following libraries: -| Name | Purpose | Author | License | -| ------------ | ----------------- | ---------------- | ------- | -| Biko | Proxy handling | Benton Stark | MIT | -| Heijden.Dns | DNS SRV Lookup | Geoffrey Huntley | MIT | -| DotNetZip | Zlib compression | Dino Chiesa | MS-PL | +| Name | Purpose | Author | License | +| ----------- | ---------------- | ---------------- | ------- | +| Biko | Proxy handling | Benton Stark | MIT | +| Heijden.Dns | DNS SRV Lookup | Geoffrey Huntley | MIT | +| DotNetZip | Zlib compression | Dino Chiesa | MS-PL | ## Disclaimer Even if everything should work, we are not responsible for any damage this app could cause to your computer or your server. + This app does not steal your password. If you don't trust it, don't use it or check & compile from the source code. Also, remember that when you connect to a server with this program, you will appear where you left the last time. + This means that **you can die if you log in in an unsafe place on a survival server!** + Use the script scheduler bot to send a teleport command after logging in. We remind you that **you may get banned** by your server for using this program. Use accordingly with server rules. @@ -171,8 +167,11 @@ We remind you that **you may get banned** by your server for using this program. ## License Minecraft Console Client is a totally free of charge, open source project. + The source code is available at [Github Repository](https://github.com/MCCTeam/Minecraft-Console-Client) Unless specifically stated, source code is from the MCC Team or Contributors, and available under CDDL-1.0. + More info about CDDL-1.0: [http://qstuff.blogspot.fr/2007/04/why-cddl.html](http://qstuff.blogspot.fr/2007/04/why-cddl.html) + Full license at [http://opensource.org/licenses/CDDL-1.0](http://opensource.org/licenses/CDDL-1.0) diff --git a/docs/guide/chat-bots.md b/docs/guide/chat-bots.md index 937776f0..26a5f7fd 100644 --- a/docs/guide/chat-bots.md +++ b/docs/guide/chat-bots.md @@ -66,6 +66,7 @@ - **Default:** `false` + #### `Beep_Enabled`

Tip

@@ -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 = , max = }` @@ -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` +

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

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`. - **Type:** `boolean` - **Default:** `false` + #### `Walk_Range` - **Description:** @@ -255,32 +267,33 @@ - **Default:** `5` + #### `Walk_Retries` +

Tip

+ + **This happens on each trigger of the task, so it does not permanently switch to alternative method.** + +
+ - **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. -

Tip

- - **This happens on each trigger of the task, so it does not permanently switch to alternative method.** - -
- - **Default:** `20` ## Auto Attack +

Tip

+ +**You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + +
+ - **Description:** Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. -

Tip

- - **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** - -
- - **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 +

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.** + +
+ - **Description:** Automatically craft items in your inventory or in a crafting table. -

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

Tip

+ + **If you're using `table` you need to set the `CraftingTable` setting.** + +
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` -

Tip

- - **If you're using `table` you need to set the `CraftingTable` setting.** - -
- - `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 = [ "", "", ... ] ``` -

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

- - **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:** @@ -601,6 +614,10 @@

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", ]`** + + **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.**
@@ -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 = , max = }` @@ -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 mail [RECIPIENT] [MESSAGE]`: Save your message for future delivery - `/tell 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 diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 9636713e..71a5ed16 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -144,8 +144,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define which language you want to use. - When connecting to 1.6+ servers, you will need a translation file to display properly some chat messages. - These files describe how some messages should be printed depending on your preferred language. + When connecting to 1.6+ servers, you will need a translation file to display properly some chat messages.These files describe how some messages should be printed depending on your preferred language. The client will automatically load `en_GB.lang` from your Minecraft folder if Minecraft is installed on your computer, or download it from Mojang's servers. You may choose another language in the configuration file. @@ -292,8 +291,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Description:** - This setting is where you can change how MCC identifies itself to the server. - It can be whatever you like, example: `vanilla`, `mcc`, `empty`. + This setting is where you can change how MCC identifies itself to the server. It can be whatever you like, example: `vanilla`, `mcc`, `empty`. - **Type:** `string` @@ -468,6 +466,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Description:** Use `no`, `fast` (5s timeout), or `yes`. + Required for joining some servers. - **Type:** `string` @@ -652,6 +651,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Description:** Affects only Minecraft 1.19+. + This section contains settings related to a new chat reporting (signing and verifying) feature introduced by Mojang. #### `LoginWithSecureProfile` @@ -679,6 +679,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Description:** Whether to sign the messages contained in the commands sent by the MCC. + For example, the message in `/msg` and `/me` - **Type:** `boolean` @@ -774,6 +775,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Description:** This setting allows you to define if your want to see info messages. + Most of the messages from MCC. - **Type:** `boolean` @@ -933,8 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Description:** - If Mojang session services or Microsoft login services are blocked on your network or your ip is blacklisted or rate limited by Microsoft, set the value to - `true`. + If Mojang session services or Microsoft login services are blocked on your network or your ip is blacklisted or rate limited by Microsoft, set the value to `true`. - **Type:** `boolean` @@ -963,6 +964,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Description:** The proxy server IP and port. + Proxy server must allow HTTPS for login, and non-443 ports for playing. - **Format:** @@ -998,7 +1000,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** ` ` +- **Default:** `` `` #### `Password` @@ -1008,7 +1010,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** ` ` +- **Default:** `` `` ## MCSettings section diff --git a/docs/guide/creating-bots.md b/docs/guide/creating-bots.md index eb972da1..ae431ca6 100644 --- a/docs/guide/creating-bots.md +++ b/docs/guide/creating-bots.md @@ -100,6 +100,7 @@ Chat Bot (Script) structure is the following: ``` **Script Metadata** is a section with a custom format that mixes in C# with our format using comments. + Every single Chat Bot (Script) must have this section at the beginning in order to work. ### Script Metadata Format @@ -167,6 +168,7 @@ After the end of the **Script Metadata** section, you basically can define any n 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

diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 2cbd9330..827bf229 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -191,7 +191,9 @@ docker run -it -v :/opt/data minecraft-console-cl ``` Now you could login and the Client is running. + To detach from the Client but still keep it running in the Background press: `CTRL + P` and then after `CTRL + Q`. + To reattach use the `docker attach` command. **Start the container using docker-compose:** @@ -225,6 +227,7 @@ docker-compose up -d #for deamonized running in the background ``` Note that you won't be able to interact with the client using `docker-compose up`. If you want that functionality, please use the first method: `docker-compose run MCC`. + As above, you can stop and remove the container using ```bash @@ -317,6 +320,7 @@ bash ubuntu.sh ``` Then you will be asked a question, enter `Y` and press `Enter`. + Once the installation is complete, you can start Ubuntu with: ```bash @@ -504,6 +508,7 @@ To stop MCC from running you can press `CTRL + C` To edit the configuration/settings, you need a text editor, we recommend Nano, as it's very simple to use, if you have followed the installation steps above, you should be familiar with it, if not, check out [this tutorial](https://www.youtube.com/watch?v=DLeATFgGM-A). For downloading files, you can use the `wget` file we have installed, simply run: + `wget your_link_here` (you have examples above, and a video tutorial down bellow). Also, here are some linux tutorials for people who are new to it: @@ -650,6 +655,7 @@ You also may want to search for better deals.
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 @@ -869,7 +875,9 @@ touch authorized_keys ``` Do no close the Git bash/Terminal emulator. + On your PC, make a new folder where you are going to store your SSH keys that you're going to use to log in to the user account. + Open the folder, and right click on the empty white space (not on files), if you're on Windows click **Git Bash here**, on mac OS and Linux click on **Open Terminal** (or whatever it is called). Type the following command: @@ -949,6 +957,7 @@ sudo systemctl status sshd ``` If everything has been configured as it should be you should see `active (running)` as a status of the service. + If not, open the config file again and check for mistakes. Press `q` to exit the log mode. diff --git a/docs/guide/usage.md b/docs/guide/usage.md index 75b6528a..e65294df 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -237,6 +237,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - **Description:** Allows you to list and unload a specific bot or all bots. + Useful when debugging and developing scripts. - **Usage:** @@ -406,6 +407,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Allows you to execute a command if a specific condition is met. The condition is a C# expression and the local variables you set using [`set`](#set), [`setrnd`](#setrnd) or the configuration file can be used. + The condition is always returned as a boolean, so only comparison can be done, if needed cast the expression result to bool. Also the instance of MCC is available with `MCC.`. diff --git a/docs/l10n/af/guide/configuration.md b/docs/l10n/af/guide/configuration.md index 30dd9cd6..9ca991fb 100644 --- a/docs/l10n/af/guide/configuration.md +++ b/docs/l10n/af/guide/configuration.md @@ -144,7 +144,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define which language you want to use. - When connecting to 1.6+ servers, you will need a translation file to display properly some chat messages. These files describe how some messages should be printed depending on your preferred language. + When connecting to 1.6+ servers, you will need a translation file to display properly some chat messages.These files describe how some messages should be printed depending on your preferred language. The client will automatically load `en_GB.lang` from your Minecraft folder if Minecraft is installed on your computer, or download it from Mojang's servers. You may choose another language in the configuration file.