From 27c40f27d2758e7af35d2ff65fb2b7a5944ba981 Mon Sep 17 00:00:00 2001 From: BruceChen Date: Fri, 4 Nov 2022 13:26:15 +0800 Subject: [PATCH] Update from Crowdin --- README/README-Chinese_Traditional.md | 10 +- README/README-Russian.md | 6 +- docs/.vuepress/translations/af.json | 7 +- docs/.vuepress/translations/ar.json | 7 +- docs/.vuepress/translations/ca.json | 7 +- docs/.vuepress/translations/cs.json | 7 +- docs/.vuepress/translations/da.json | 7 +- docs/.vuepress/translations/de.json | 7 +- docs/.vuepress/translations/el.json | 7 +- docs/.vuepress/translations/es.json | 7 +- docs/.vuepress/translations/fi.json | 7 +- docs/.vuepress/translations/fr.json | 7 +- docs/.vuepress/translations/he.json | 7 +- docs/.vuepress/translations/hu.json | 7 +- docs/.vuepress/translations/it.json | 7 +- docs/.vuepress/translations/ja.json | 7 +- docs/.vuepress/translations/ko.json | 7 +- docs/.vuepress/translations/lv.json | 7 +- docs/.vuepress/translations/nl.json | 7 +- docs/.vuepress/translations/no.json | 7 +- docs/.vuepress/translations/pl.json | 7 +- docs/.vuepress/translations/pt-BR.json | 7 +- docs/.vuepress/translations/pt.json | 7 +- docs/.vuepress/translations/ro.json | 7 +- docs/.vuepress/translations/ru.json | 7 +- docs/.vuepress/translations/sr-Cyrl.json | 7 +- docs/.vuepress/translations/sv.json | 7 +- docs/.vuepress/translations/tr.json | 7 +- docs/.vuepress/translations/uk.json | 7 +- docs/.vuepress/translations/vi.json | 7 +- docs/.vuepress/translations/zh-Hans.json | 7 +- docs/.vuepress/translations/zh-Hant.json | 7 +- docs/l10n/af/guide/chat-bots.md | 125 +- docs/l10n/af/guide/configuration.md | 64 +- docs/l10n/af/guide/creating-bots.md | 15 +- docs/l10n/af/guide/installation.md | 194 ++- docs/l10n/af/guide/usage.md | 105 +- docs/l10n/ar/guide/README.md | 10 +- docs/l10n/ar/guide/chat-bots.md | 189 ++- docs/l10n/ar/guide/configuration.md | 80 +- docs/l10n/ar/guide/creating-bots.md | 45 +- docs/l10n/ar/guide/installation.md | 192 ++- docs/l10n/ar/guide/usage.md | 107 +- docs/l10n/ca/guide/chat-bots.md | 125 +- docs/l10n/ca/guide/configuration.md | 64 +- docs/l10n/ca/guide/creating-bots.md | 15 +- docs/l10n/ca/guide/installation.md | 194 ++- docs/l10n/ca/guide/usage.md | 105 +- docs/l10n/cs/guide/chat-bots.md | 125 +- docs/l10n/cs/guide/configuration.md | 64 +- docs/l10n/cs/guide/creating-bots.md | 15 +- docs/l10n/cs/guide/installation.md | 194 ++- docs/l10n/cs/guide/usage.md | 105 +- docs/l10n/da/guide/chat-bots.md | 125 +- docs/l10n/da/guide/configuration.md | 64 +- docs/l10n/da/guide/creating-bots.md | 15 +- docs/l10n/da/guide/installation.md | 194 ++- docs/l10n/da/guide/usage.md | 105 +- docs/l10n/de/guide/chat-bots.md | 125 +- docs/l10n/de/guide/configuration.md | 64 +- docs/l10n/de/guide/creating-bots.md | 15 +- docs/l10n/de/guide/installation.md | 192 ++- docs/l10n/de/guide/usage.md | 105 +- docs/l10n/el/guide/chat-bots.md | 125 +- docs/l10n/el/guide/configuration.md | 64 +- docs/l10n/el/guide/creating-bots.md | 15 +- docs/l10n/el/guide/installation.md | 194 ++- docs/l10n/el/guide/usage.md | 105 +- docs/l10n/es/guide/chat-bots.md | 125 +- docs/l10n/es/guide/configuration.md | 64 +- docs/l10n/es/guide/creating-bots.md | 43 +- docs/l10n/es/guide/installation.md | 194 ++- docs/l10n/es/guide/usage.md | 107 +- docs/l10n/fi/guide/chat-bots.md | 125 +- docs/l10n/fi/guide/configuration.md | 64 +- docs/l10n/fi/guide/creating-bots.md | 15 +- docs/l10n/fi/guide/installation.md | 194 ++- docs/l10n/fi/guide/usage.md | 105 +- docs/l10n/fr/guide/chat-bots.md | 125 +- docs/l10n/fr/guide/configuration.md | 64 +- docs/l10n/fr/guide/creating-bots.md | 15 +- docs/l10n/fr/guide/installation.md | 192 ++- docs/l10n/fr/guide/usage.md | 105 +- docs/l10n/he/guide/chat-bots.md | 125 +- docs/l10n/he/guide/configuration.md | 64 +- docs/l10n/he/guide/creating-bots.md | 15 +- docs/l10n/he/guide/installation.md | 194 ++- docs/l10n/he/guide/usage.md | 105 +- docs/l10n/hu/guide/chat-bots.md | 125 +- docs/l10n/hu/guide/configuration.md | 64 +- docs/l10n/hu/guide/creating-bots.md | 15 +- docs/l10n/hu/guide/installation.md | 194 ++- docs/l10n/hu/guide/usage.md | 105 +- docs/l10n/it/guide/chat-bots.md | 125 +- docs/l10n/it/guide/configuration.md | 64 +- docs/l10n/it/guide/creating-bots.md | 15 +- docs/l10n/it/guide/installation.md | 192 ++- docs/l10n/it/guide/usage.md | 105 +- docs/l10n/ja/guide/chat-bots.md | 125 +- docs/l10n/ja/guide/configuration.md | 64 +- docs/l10n/ja/guide/creating-bots.md | 15 +- docs/l10n/ja/guide/installation.md | 192 ++- docs/l10n/ja/guide/usage.md | 105 +- docs/l10n/ko/guide/chat-bots.md | 125 +- docs/l10n/ko/guide/configuration.md | 64 +- docs/l10n/ko/guide/creating-bots.md | 15 +- docs/l10n/ko/guide/installation.md | 192 ++- docs/l10n/ko/guide/usage.md | 105 +- docs/l10n/lv/guide/chat-bots.md | 125 +- docs/l10n/lv/guide/configuration.md | 64 +- docs/l10n/lv/guide/creating-bots.md | 15 +- docs/l10n/lv/guide/installation.md | 194 ++- docs/l10n/lv/guide/usage.md | 105 +- docs/l10n/nl/guide/chat-bots.md | 125 +- docs/l10n/nl/guide/configuration.md | 64 +- docs/l10n/nl/guide/creating-bots.md | 15 +- docs/l10n/nl/guide/installation.md | 192 ++- docs/l10n/nl/guide/usage.md | 105 +- docs/l10n/no/guide/chat-bots.md | 125 +- docs/l10n/no/guide/configuration.md | 64 +- docs/l10n/no/guide/creating-bots.md | 15 +- docs/l10n/no/guide/installation.md | 194 ++- docs/l10n/no/guide/usage.md | 105 +- docs/l10n/pl/guide/chat-bots.md | 127 +- docs/l10n/pl/guide/configuration.md | 64 +- docs/l10n/pl/guide/creating-bots.md | 15 +- docs/l10n/pl/guide/installation.md | 192 ++- docs/l10n/pl/guide/usage.md | 105 +- docs/l10n/pt-BR/guide/README.md | 10 +- docs/l10n/pt-BR/guide/chat-bots.md | 191 ++- docs/l10n/pt-BR/guide/configuration.md | 86 +- docs/l10n/pt-BR/guide/creating-bots.md | 49 +- docs/l10n/pt-BR/guide/installation.md | 204 ++- docs/l10n/pt-BR/guide/usage.md | 121 +- docs/l10n/pt/guide/README.md | 10 +- docs/l10n/pt/guide/chat-bots.md | 191 ++- docs/l10n/pt/guide/configuration.md | 86 +- docs/l10n/pt/guide/creating-bots.md | 49 +- docs/l10n/pt/guide/installation.md | 204 ++- docs/l10n/pt/guide/usage.md | 121 +- docs/l10n/ro/guide/chat-bots.md | 125 +- docs/l10n/ro/guide/configuration.md | 64 +- docs/l10n/ro/guide/creating-bots.md | 15 +- docs/l10n/ro/guide/installation.md | 194 ++- docs/l10n/ro/guide/usage.md | 105 +- docs/l10n/ru/guide/chat-bots.md | 146 +- docs/l10n/ru/guide/configuration.md | 64 +- docs/l10n/ru/guide/creating-bots.md | 15 +- docs/l10n/ru/guide/installation.md | 192 ++- docs/l10n/ru/guide/usage.md | 105 +- docs/l10n/sr-Cyrl/guide/chat-bots.md | 125 +- docs/l10n/sr-Cyrl/guide/configuration.md | 64 +- docs/l10n/sr-Cyrl/guide/creating-bots.md | 15 +- docs/l10n/sr-Cyrl/guide/installation.md | 194 ++- docs/l10n/sr-Cyrl/guide/usage.md | 105 +- docs/l10n/sv/guide/chat-bots.md | 125 +- docs/l10n/sv/guide/configuration.md | 64 +- docs/l10n/sv/guide/creating-bots.md | 15 +- docs/l10n/sv/guide/installation.md | 194 ++- docs/l10n/sv/guide/usage.md | 105 +- docs/l10n/tr/guide/chat-bots.md | 125 +- docs/l10n/tr/guide/configuration.md | 64 +- docs/l10n/tr/guide/creating-bots.md | 15 +- docs/l10n/tr/guide/installation.md | 192 ++- docs/l10n/tr/guide/usage.md | 105 +- docs/l10n/uk/guide/chat-bots.md | 125 +- docs/l10n/uk/guide/configuration.md | 64 +- docs/l10n/uk/guide/creating-bots.md | 15 +- docs/l10n/uk/guide/installation.md | 194 ++- docs/l10n/uk/guide/usage.md | 105 +- docs/l10n/vi/guide/chat-bots.md | 125 +- docs/l10n/vi/guide/configuration.md | 64 +- docs/l10n/vi/guide/creating-bots.md | 15 +- docs/l10n/vi/guide/installation.md | 194 ++- docs/l10n/vi/guide/usage.md | 105 +- docs/l10n/zh-Hans/README.md | 28 + docs/l10n/zh-Hans/guide/README.md | 163 ++ docs/l10n/zh-Hans/guide/chat-bots.md | 1964 ++++++++++++++++++++++ docs/l10n/zh-Hans/guide/configuration.md | 1207 +++++++++++++ docs/l10n/zh-Hans/guide/contibuting.md | 76 + docs/l10n/zh-Hans/guide/creating-bots.md | 205 +++ docs/l10n/zh-Hans/guide/installation.md | 1033 ++++++++++++ docs/l10n/zh-Hans/guide/usage.md | 958 +++++++++++ docs/l10n/zh-Hant/guide/README.md | 18 +- docs/l10n/zh-Hant/guide/chat-bots.md | 147 +- docs/l10n/zh-Hant/guide/configuration.md | 92 +- docs/l10n/zh-Hant/guide/contibuting.md | 4 +- docs/l10n/zh-Hant/guide/creating-bots.md | 47 +- docs/l10n/zh-Hant/guide/installation.md | 230 ++- docs/l10n/zh-Hant/guide/usage.md | 117 +- 190 files changed, 16264 insertions(+), 4806 deletions(-) create mode 100644 docs/l10n/zh-Hans/README.md create mode 100644 docs/l10n/zh-Hans/guide/README.md create mode 100644 docs/l10n/zh-Hans/guide/chat-bots.md create mode 100644 docs/l10n/zh-Hans/guide/configuration.md create mode 100644 docs/l10n/zh-Hans/guide/contibuting.md create mode 100644 docs/l10n/zh-Hans/guide/creating-bots.md create mode 100644 docs/l10n/zh-Hans/guide/installation.md create mode 100644 docs/l10n/zh-Hans/guide/usage.md diff --git a/README/README-Chinese_Traditional.md b/README/README-Chinese_Traditional.md index 9b92459e..752b82b8 100644 --- a/README/README-Chinese_Traditional.md +++ b/README/README-Chinese_Traditional.md @@ -31,7 +31,7 @@ ## 取得幫助 🙋 -Check out the [Website](https://mccteam.github.io/), [README](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#minecraft-console-client-user-manual) and existing [Discussions](https://github.com/MCCTeam/Minecraft-Console-Client/discussions): Maybe your question is answered there. If not, please open a [New Discussion](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/new) and ask your question. If you find a bug, please report it in the [Issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues) section. If not, please open a [New Discussion](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/new) and ask your question. If you find a bug, please report it in the [Issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues) section. 如果沒有，請建立[新討論串](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/new)來提出你的問題。 如果你找到程式錯誤，請到[問題頁面](https://github.com/MCCTeam/Minecraft-Console-Client/issues)回報。 +Check out the [Website](https://mccteam.github.io/), [README](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#minecraft-console-client-user-manual) and existing [Discussions](https://github.com/MCCTeam/Minecraft-Console-Client/discussions): Maybe your question is answered there. If not, please open a [New Discussion](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/new) and ask your question. If you find a bug, please report it in the [Issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues) section. If not, please open a [New Discussion](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/new) and ask your question. If you find a bug, please report it in the [Issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues) section. 如果沒有，請建立[新討論串](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/new)來提出你的問題。 如果沒有，請建立[新討論串](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/new)來提出你的問題。 如果你找到程式錯誤，請到[問題頁面](https://github.com/MCCTeam/Minecraft-Console-Client/issues)回報。 ## Discord @@ -39,11 +39,11 @@ Check out the [Website](https://mccteam.github.io/), [README](https://github.com ## 幫助我們 ❤️ -We are a small community so we need help to implement upgrades for new Minecraft versions, fixing bugs and expanding the project. We are always looking for motivated people to contribute. We are a small community so we need help to implement upgrades for new Minecraft versions, fixing bugs and expanding the project. We are always looking for motivated people to contribute. If you feel like it could be you, please have a look at the [issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+is%3Aopen+label%3Awaiting-for%3Acontributor) section :) 我們一直在尋找有動力的人來參與貢獻。 如果你覺得你是那個人，請查看[問題頁面](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+is%3Aopen+label%3Awaiting-for%3Acontributor) :) +We are a small community so we need help to implement upgrades for new Minecraft versions, fixing bugs and expanding the project. We are always looking for motivated people to contribute. We are a small community so we need help to implement upgrades for new Minecraft versions, fixing bugs and expanding the project. We are always looking for motivated people to contribute. If you feel like it could be you, please have a look at the [issues](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+is%3Aopen+label%3Awaiting-for%3Acontributor) section :) 我們一直在尋找有動力的人來參與貢獻。 我們一直在尋找有動力的人來參與貢獻。 如果你覺得你是那個人，請查看[問題頁面](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+is%3Aopen+label%3Awaiting-for%3Acontributor) :) ## 如何貢獻 📝 -If you'd like to contribute to Minecraft Console Client, great, just fork the repository and submit a pull request on the _Master_ branch. To contribute to the website / online documentation see also the [Website repository](https://github.com/MCCTeam/MCCTeam.github.io). To contribute to the website / online documentation see also the [Website repository](https://github.com/MCCTeam/MCCTeam.github.io). 如果你希望為網站 / 線上文檔做出貢獻，請參閱[網站的 git 倉庫](https://github.com/MCCTeam/MCCTeam.github.io)。 +If you'd like to contribute to Minecraft Console Client, great, just fork the repository and submit a pull request on the _Master_ branch. To contribute to the website / online documentation see also the [Website repository](https://github.com/MCCTeam/MCCTeam.github.io). To contribute to the website / online documentation see also the [Website repository](https://github.com/MCCTeam/MCCTeam.github.io). 如果你希望為網站 / 線上文檔做出貢獻，請參閱[網站的 git 倉庫](https://github.com/MCCTeam/MCCTeam.github.io)。 如果你希望為網站 / 線上文檔做出貢獻，請參閱[網站的 git 倉庫](https://github.com/MCCTeam/MCCTeam.github.io)。 ![Alt](https://repobeats.axiom.co/api/embed/c8a6c7c47fde8fcbe3727a21eab46e6b39dff60d.svg "Repobeats analytics image") @@ -69,8 +69,8 @@ MCC 現在支援以下的語言（按英文字母排序）： Unless specifically stated, the code is from the MCC Team or Contributors, and available under CDDL-1.0. Else, the license and original author are mentioned in source file headers. The main terms of the CDDL-1.0 license are basically the following: Else, the license and original author are mentioned in source file headers. The main terms of the CDDL-1.0 license are basically the following: 否則，許可證和原始作者將在原始文件開頭中提及。 CDDL-1.0 許可的主要條款基本上是以下內容： -- You may use the licensed code in whole or in part in any program you desire, regardless of the license of the program as a whole (or rather, as excluding the code you are borrowing). The program itself may be open or closed source, free or commercial. The program itself may be open or closed source, free or commercial. The program itself may be open or closed source, free or commercial. +- You may use the licensed code in whole or in part in any program you desire, regardless of the license of the program as a whole (or rather, as excluding the code you are borrowing). The program itself may be open or closed source, free or commercial. The program itself may be open or closed source, free or commercial. The program itself may be open or closed source, free or commercial. The program itself may be open or closed source, free or commercial. - However, in all cases, any modifications, improvements, or additions to the CDDL code (any code that is referenced in direct modifications to the CDDL code is considered an addition to the CDDL code, and so is bound by this requirement; e.g. a modification of a math function to use a fast lookup table makes that table itself an addition to the CDDL code, regardless of whether it's in a source code file of its own) must be made publicly and freely available in source, under the CDDL license itself. -- In any program (source or binary) that uses CDDL code, recognition must be given to the source (either project or author) of the CDDL code. In any program (source or binary) that uses CDDL code, recognition must be given to the source (either project or author) of the CDDL code. As well, modifications to the CDDL code (which must be distributed as source) may not remove notices indicating the ancestry of the code. In any program (source or binary) that uses CDDL code, recognition must be given to the source (either project or author) of the CDDL code. As well, modifications to the CDDL code (which must be distributed as source) may not remove notices indicating the ancestry of the code. +- In any program (source or binary) that uses CDDL code, recognition must be given to the source (either project or author) of the CDDL code. In any program (source or binary) that uses CDDL code, recognition must be given to the source (either project or author) of the CDDL code. As well, modifications to the CDDL code (which must be distributed as source) may not remove notices indicating the ancestry of the code. In any program (source or binary) that uses CDDL code, recognition must be given to the source (either project or author) of the CDDL code. As well, modifications to the CDDL code (which must be distributed as source) may not remove notices indicating the ancestry of the code. In any program (source or binary) that uses CDDL code, recognition must be given to the source (either project or author) of the CDDL code. As well, modifications to the CDDL code (which must be distributed as source) may not remove notices indicating the ancestry of the code. More info at http://qstuff.blogspot.fr/2007/04/why-cddl.html Full license at http://opensource.org/licenses/CDDL-1.0 diff --git a/README/README-Russian.md b/README/README-Russian.md index c62254b4..024deff2 100644 --- a/README/README-Russian.md +++ b/README/README-Russian.md @@ -2,11 +2,7 @@ Логотип -# Клиент консоли Minecraft (MCC) - -[Documentation](https://mccteam.github.io/) | [Download](#скачать) | [Installation](https://mccteam.github.io/guide/installation.html) | [Configuration](https://mccteam.github.io/guide/configuration.html) | [Usage](https://mccteam.github.io/guide/usage. tml) - -[English](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/README.md) | [Nederlands](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/README/README-Dutch.md) | [Српски](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/README/README-Serbian_Cyrillic. d) | [Türkçe](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/README/README-Turkish.md) | [Tie ́ng Vie t](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/README/README-README-Vietnamese.md) | [简体中文](https://github.com/MCC/Minecraft-Console-Client/blob/master/README/README-Chinese_Simplified.md) +t](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/README/README-README-Vietnamese.md) | [简体中文](https://github.com/MCC/Minecraft-Console-Client/blob/master/README/README-Chinese_Simplified.md) [![GitHub Actions build status](https://github.com/MCCTeam/Minecraft-Console-Client/workflows/build-and-release.yml/badge.svg)](https://github.com/MCCTeam/Minecraft- Наш дискорд сервер diff --git a/docs/.vuepress/translations/af.json b/docs/.vuepress/translations/af.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/af.json +++ b/docs/.vuepress/translations/af.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/ar.json b/docs/.vuepress/translations/ar.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/ar.json +++ b/docs/.vuepress/translations/ar.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/ca.json b/docs/.vuepress/translations/ca.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/ca.json +++ b/docs/.vuepress/translations/ca.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/cs.json b/docs/.vuepress/translations/cs.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/cs.json +++ b/docs/.vuepress/translations/cs.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/da.json b/docs/.vuepress/translations/da.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/da.json +++ b/docs/.vuepress/translations/da.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/de.json b/docs/.vuepress/translations/de.json index 558f831f..101ae239 100644 --- a/docs/.vuepress/translations/de.json +++ b/docs/.vuepress/translations/de.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/el.json b/docs/.vuepress/translations/el.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/el.json +++ b/docs/.vuepress/translations/el.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/es.json b/docs/.vuepress/translations/es.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/es.json +++ b/docs/.vuepress/translations/es.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/fi.json b/docs/.vuepress/translations/fi.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/fi.json +++ b/docs/.vuepress/translations/fi.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/fr.json b/docs/.vuepress/translations/fr.json index 126c2071..440f3e47 100644 --- a/docs/.vuepress/translations/fr.json +++ b/docs/.vuepress/translations/fr.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/he.json b/docs/.vuepress/translations/he.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/he.json +++ b/docs/.vuepress/translations/he.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/hu.json b/docs/.vuepress/translations/hu.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/hu.json +++ b/docs/.vuepress/translations/hu.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/it.json b/docs/.vuepress/translations/it.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/it.json +++ b/docs/.vuepress/translations/it.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/ja.json b/docs/.vuepress/translations/ja.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/ja.json +++ b/docs/.vuepress/translations/ja.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/ko.json b/docs/.vuepress/translations/ko.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/ko.json +++ b/docs/.vuepress/translations/ko.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/lv.json b/docs/.vuepress/translations/lv.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/lv.json +++ b/docs/.vuepress/translations/lv.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/nl.json b/docs/.vuepress/translations/nl.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/nl.json +++ b/docs/.vuepress/translations/nl.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/no.json b/docs/.vuepress/translations/no.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/no.json +++ b/docs/.vuepress/translations/no.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/pl.json b/docs/.vuepress/translations/pl.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/pl.json +++ b/docs/.vuepress/translations/pl.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/pt-BR.json b/docs/.vuepress/translations/pt-BR.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/pt-BR.json +++ b/docs/.vuepress/translations/pt-BR.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/pt.json b/docs/.vuepress/translations/pt.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/pt.json +++ b/docs/.vuepress/translations/pt.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/ro.json b/docs/.vuepress/translations/ro.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/ro.json +++ b/docs/.vuepress/translations/ro.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/ru.json b/docs/.vuepress/translations/ru.json index b0d55035..415c5abd 100644 --- a/docs/.vuepress/translations/ru.json +++ b/docs/.vuepress/translations/ru.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/sr-Cyrl.json b/docs/.vuepress/translations/sr-Cyrl.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/sr-Cyrl.json +++ b/docs/.vuepress/translations/sr-Cyrl.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/sv.json b/docs/.vuepress/translations/sv.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/sv.json +++ b/docs/.vuepress/translations/sv.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/tr.json b/docs/.vuepress/translations/tr.json index dcbfcac5..d4184062 100644 --- a/docs/.vuepress/translations/tr.json +++ b/docs/.vuepress/translations/tr.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/uk.json b/docs/.vuepress/translations/uk.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/uk.json +++ b/docs/.vuepress/translations/uk.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/vi.json b/docs/.vuepress/translations/vi.json index f5ecc6bd..4cbb45e9 100644 --- a/docs/.vuepress/translations/vi.json +++ b/docs/.vuepress/translations/vi.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/.vuepress/translations/zh-Hans.json b/docs/.vuepress/translations/zh-Hans.json index 808a279b..55391018 100644 --- a/docs/.vuepress/translations/zh-Hans.json +++ b/docs/.vuepress/translations/zh-Hans.json @@ -1,6 +1,7 @@ { "title": "Minecraft命令行客户端", "description": "Minecraft Console Client (MCC) 文档站点", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "简体中文", "selectLanguageText": "选择语言", @@ -8,9 +9,9 @@ "editLinkText": "在 GitHub 上编辑此页", "lastUpdatedText": "上次更新", "contributorsText": "贡献者", - "tip": "提示", - "warning": "注意", - "danger": "警告", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "这里什么都没有", "我们怎么到这来了？", diff --git a/docs/.vuepress/translations/zh-Hant.json b/docs/.vuepress/translations/zh-Hant.json index 634cf7e6..dac74e09 100644 --- a/docs/.vuepress/translations/zh-Hant.json +++ b/docs/.vuepress/translations/zh-Hant.json @@ -1,6 +1,7 @@ { "title": "Minecraft Console Client", "description": "Documentation website for the Minecraft Console Client (MCC)", + "helpUsTranslate": "Help us translate", "theme": { "selectLanguageName": "English", "selectLanguageText": "Languages", @@ -8,9 +9,9 @@ "editLinkText": "Edit this page", "lastUpdatedText": "Last Updated", "contributorsText": "Contributors", - "tip": "tip", - "warning": "warning", - "danger": "danger", + "tip": "Tip", + "warning": "Warning", + "danger": "Danger", "notFound": [ "There's nothing here.", "How did we get here?", diff --git a/docs/l10n/af/guide/chat-bots.md b/docs/l10n/af/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/af/guide/chat-bots.md +++ b/docs/l10n/af/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/af/guide/configuration.md b/docs/l10n/af/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/af/guide/configuration.md +++ b/docs/l10n/af/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/af/guide/creating-bots.md b/docs/l10n/af/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/af/guide/creating-bots.md +++ b/docs/l10n/af/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/af/guide/installation.md b/docs/l10n/af/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/af/guide/installation.md +++ b/docs/l10n/af/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/af/guide/usage.md b/docs/l10n/af/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/af/guide/usage.md +++ b/docs/l10n/af/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/ar/guide/README.md b/docs/l10n/ar/guide/README.md index 81e1aee3..2a306e9d 100644 --- a/docs/l10n/ar/guide/README.md +++ b/docs/l10n/ar/guide/README.md @@ -142,11 +142,11 @@ Allyoutoo, Aragas, Bancey, bearbear12345, corbanmailloux, Daenges, dbear20, dogw 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 diff --git a/docs/l10n/ar/guide/chat-bots.md b/docs/l10n/ar/guide/chat-bots.md index c5f2d5d4..06c95dd4 100644 --- a/docs/l10n/ar/guide/chat-bots.md +++ b/docs/l10n/ar/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -44,7 +48,7 @@ - **Settings:** - **Section:** **`ChatBot.Alerts`** + **Section:** **`ChatBot. Alerts`** #### `Enabled` @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -172,7 +177,7 @@ - **Settings:** - **Section:** **`ChatBot.AntiAFK`** + **Section:** **`ChatBot. AntiAFK`** #### `Enabled` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,11 +275,12 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: 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`** + **Section:** **`ChatBot. AutoAttack`** #### `Enabled` @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -445,7 +454,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoCraft`** + **Section:** **`ChatBot. AutoCraft`** #### `Enabled` @@ -501,9 +510,9 @@ ### Defining a recipe - The recipes are defines as a separate new sub-section `[[ChatBot.AutoCraft.Recipes]]` of the `[ChatBot.AutoCraft]` section. + The recipes are defines as a separate new sub-section `[[ChatBot. AutoCraft. Recipes]]` of the `[ChatBot. AutoCraft]` section. - The `[[ChatBot.AutoCraft.Recipes]]` section needs to contain the following settings: + The `[[ChatBot. AutoCraft. Recipes]]` section needs to contain the following settings: - `Name` @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -569,21 +581,22 @@ ```toml # Stone Bricks using the player inventory - [[ChatBot.AutoCraft.Recipes]] + [[ChatBot. AutoCraft. Recipes]] Name = "Recipe-Name-1" Type = "player" Result = "StoneBricks" Slots = [ "Stone", "Stone", "Stone", "Stone", ] # Stone Bricks using a crafting table - [[ChatBot.AutoCraft.Recipes]] + [[ChatBot. AutoCraft. Recipes]] Name = "Recipe-Name-2" Type = "table" Result = "StoneBricks" Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -603,7 +618,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoDig`** + **Section:** **`ChatBot. AutoDig`** #### `Enabled` @@ -763,11 +778,12 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** - **Section:** **`ChatBot.AutoDrop`** + **Section:** **`ChatBot. AutoDrop`** #### `Enabled` @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,11 +848,12 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** - **Section:** **`ChatBot.AutoEat`** + **Section:** **`ChatBot. AutoEat`** #### `Enabled` @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -883,7 +905,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoFishing`** + **Section:** **`ChatBot. AutoFishing`** #### `Enabled` @@ -1055,7 +1077,7 @@ Some plugins do not allow the player to fish in one place for a long time. This setting allows the player to change position/angle after each catch. - Each position is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection, more on that bellow. + Each position is added as a new `[[ChatBot. AutoFishing. Movements]]` subsection, more on that bellow. - **Available values:** `true` and `false`. @@ -1066,7 +1088,7 @@ ### Adding a position/movement - Each position/movement is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection of `[ChatBot.AutoFishing]`. + Each position/movement is added as a new `[[ChatBot. AutoFishing. Movements]]` subsection of `[ChatBot. AutoFishing]`. **Avaliable settings/options:** @@ -1108,10 +1130,10 @@ #### Full example ```toml - [[ChatBot.AutoFishing.Movements]] + [[ChatBot. AutoFishing. Movements]] facing = { yaw = 12.34, pitch = -23.45 } - [[ChatBot.AutoFishing.Movements]] + [[ChatBot. AutoFishing. Movements]] XYZ = { x = 123.45, y = 64.0, z = -654.32 } facing = { yaw = -25.14, pitch = 36.25 } ``` @@ -1124,7 +1146,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoRelog`** + **Section:** **`ChatBot. AutoRelog`** #### `Enabled` @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,13 +1221,15 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** - **Section:** **`ChatBot.AutoRespond`** + **Section:** **`ChatBot. AutoRespond`** #### `Enabled` @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1260,7 +1287,7 @@ - **Settings:** - **Section:** **`ChatBot.ChatLog`** + **Section:** **`ChatBot. ChatLog`** #### `Enabled` @@ -1329,13 +1356,15 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** - **Section:** **`ChatBot.FollowPlayer`** + **Section:** **`ChatBot. FollowPlayer`** #### `Enabled` @@ -1383,11 +1412,12 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** - **Section:** **`ChatBot.HangmanGame`** + **Section:** **`ChatBot. HangmanGame`** #### `Enabled` @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1479,7 +1513,7 @@ * **Settings:** - **Section:** **`ChatBot.Mailer`** + **Section:** **`ChatBot. Mailer`** #### `Enabled` @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1586,7 +1621,7 @@ - **Settings:** - **Section:** **`ChatBot.Map`** + **Section:** **`ChatBot. Map`** #### `Enabled` @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1678,7 +1716,7 @@ - **Settings:** - **Section:** **`ChatBot.PlayerListLogger`** + **Section:** **`ChatBot. PlayerListLogger`** #### `Enabled` @@ -1718,11 +1756,12 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** - **Section:** **`ChatBot.RemoteControl`** + **Section:** **`ChatBot. RemoteControl`** #### `Enabled` @@ -1768,15 +1807,18 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** - **Section:** **`ChatBot.ReplayCapture`** + **Section:** **`ChatBot. ReplayCapture`** #### `Enabled` @@ -1811,7 +1853,7 @@ - **Settings:** - **Section:** **`ChatBot.ScriptScheduler`** + **Section:** **`ChatBot. ScriptScheduler`** #### `Enabled` @@ -1830,17 +1872,18 @@ - **Description:** - Each task is defined as a new subsection `[[ChatBot.ScriptScheduler.TaskList]]` of the section: `[ChatBot.ScriptScheduler]`. + Each task is defined as a new subsection `[[ChatBot. ScriptScheduler. TaskList]]` of the section: `[ChatBot. ScriptScheduler]`. **Subsection format:** ```toml - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] = = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: tip **It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** +::: **Avaliable settings/options:** @@ -1900,10 +1943,10 @@ ### Full example ```toml - [ChatBot.ScriptScheduler] + [ChatBot. ScriptScheduler] Enabled = true - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] Task_Name = "Task Name 1" Trigger_On_First_Login = false Trigger_On_Login = false @@ -1911,7 +1954,7 @@ Trigger_On_Interval = { Enable = true, MinTime = 3.6, MaxTime = 4.8 } Action = "send /hello" - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] Task_Name = "Task Name 2" Trigger_On_First_Login = false Trigger_On_Login = true diff --git a/docs/l10n/ar/guide/configuration.md b/docs/l10n/ar/guide/configuration.md index 927413fa..77646e47 100644 --- a/docs/l10n/ar/guide/configuration.md +++ b/docs/l10n/ar/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -40,7 +42,7 @@ Other_Setting = true # This also is a comment Section_Enabled = true colors = [ "red", "yellow", "green" ] -[ThirdSection.Subsection] +[ThirdSection. Subsection] Coordinate = { x = 145, y = 64, y = 2045 } ``` @@ -48,7 +50,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Main General section -- **Section header:** `Main.General` +- **Section header:** `Main. General` #### `Account` @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -128,7 +131,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Main Advanced section -- **Section header:** `Main.Advanced` +- **Section header:** `Main. Advanced` #### `Language` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -234,7 +238,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Type:** `string` -- **Version format:** `1.X.X` +- **Version format:** `1. X. X` - **Type:** `string` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,11 +545,13 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section -- **Section header:** `Main.Advanced.AccountList` +- **Section header:** `Main. Advanced. AccountList` - **Description:** @@ -560,7 +577,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Server List section -- **Section header:** `Main.Advanced.ServerList` +- **Section header:** `Main. Advanced. ServerList` - **Description:** @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -829,9 +849,10 @@ Coordinate = { x = 145, y = 64, y = 2045 } This section allows you to define your own custom settings/variables which you can use in scripts, bots or other setting fields. - To define a variable/setting, simply make a new line with the following format under the `[AppVar.VarStirng]` section: + To define a variable/setting, simply make a new line with the following format under the `[AppVar. VarStirng]` section: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section @@ -1018,7 +1040,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ## MCSettings Skin section -- **Section header:** `MCSettings.Skin` +- **Section header:** `MCSettings. Skin` - **Description:** diff --git a/docs/l10n/ar/guide/creating-bots.md b/docs/l10n/ar/guide/creating-bots.md index d803c849..0a93a3d0 100644 --- a/docs/l10n/ar/guide/creating-bots.md +++ b/docs/l10n/ar/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -41,14 +45,14 @@ Paste the following example code: ```csharp //MCCScript 1.0 -MCC.LoadBot(new ExampleChatBot()); +MCC. LoadBot(new ExampleChatBot()); //MCCScript Extensions // The code and comments above are defining a "Script Metadata" section // Every single chat bot (script) must be a class which extends the ChatBot class. -// Your class must be instantiates in the "Script Metadata" section and passed to MCC.LoadBot function. +// Your class must be instantiates in the "Script Metadata" section and passed to MCC. LoadBot function. class ExampleChatBot : ChatBot { // This method will be called when the script has been initialized for the first time, it's called only once @@ -99,38 +103,40 @@ Chat Bot (Script) structure is the following: `//MCCScript Extensions` marks the end of the **Script Metadata** section, this must be defined before a Chat Bot (Script) class. -In order for your Chat Bot (Script) to properly load in-between the `//MCCScript 1.0` and the `//MCCScript Extensions` lines you must instantiate your Chat Bot (Script) class and pass it to the `MCC.LoadBot` function. +In order for your Chat Bot (Script) to properly load in-between the `//MCCScript 1.0` and the `//MCCScript Extensions` lines you must instantiate your Chat Bot (Script) class and pass it to the `MCC. LoadBot` function. Example code: ``` -MCC.LoadBot(new YourChatBotClassNameHere()); +MCC. LoadBot(new YourChatBotClassNameHere()); ``` **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: ```csharp using System; -using System.Collections.Generic; -using System.Text.RegularExpressions; -using System.Linq; -using System.Text; +using System. Collections. Generic; +using System. Text. RegularExpressions; +using System. Linq; +using System. Text; using System.IO; -using System.Net; -using System.Threading; +using System. Net; +using System. Threading; using MinecraftClient; -using MinecraftClient.Mapping; -using MinecraftClient.Inventory; +using MinecraftClient. Mapping; +using MinecraftClient. ``` Example: ```csharp -//using System.Collections.Immutable +//using System. Collections. Immutable //dll MyDll.dll ``` @@ -139,10 +145,10 @@ Full Example: ```csharp //MCCScript 1.0 -//using System.Collections.Immutable +//using System. Collections. Immutable //dll MyDll.dll -MCC.LoadBot(new ExampleChatBot()); +MCC. LoadBot(new ExampleChatBot()); //MCCScript Extensions ``` @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/ar/guide/installation.md b/docs/l10n/ar/guide/installation.md index 4994224c..71a8ec32 100644 --- a/docs/l10n/ar/guide/installation.md +++ b/docs/l10n/ar/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/ar/guide/usage.md b/docs/l10n/ar/guide/usage.md index cf371ff0..04c5e18f 100644 --- a/docs/l10n/ar/guide/usage.md +++ b/docs/l10n/ar/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -397,7 +411,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Using MCC class: ``` - /execif MCC.GetHealth() == 20.0 ---> send Success! + /execif MCC. GetHealth() == 20.0 ---> send Success! ``` @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/ca/guide/chat-bots.md b/docs/l10n/ca/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/ca/guide/chat-bots.md +++ b/docs/l10n/ca/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/ca/guide/configuration.md b/docs/l10n/ca/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/ca/guide/configuration.md +++ b/docs/l10n/ca/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/ca/guide/creating-bots.md b/docs/l10n/ca/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/ca/guide/creating-bots.md +++ b/docs/l10n/ca/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/ca/guide/installation.md b/docs/l10n/ca/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/ca/guide/installation.md +++ b/docs/l10n/ca/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/ca/guide/usage.md b/docs/l10n/ca/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/ca/guide/usage.md +++ b/docs/l10n/ca/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/cs/guide/chat-bots.md b/docs/l10n/cs/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/cs/guide/chat-bots.md +++ b/docs/l10n/cs/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/cs/guide/configuration.md b/docs/l10n/cs/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/cs/guide/configuration.md +++ b/docs/l10n/cs/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/cs/guide/creating-bots.md b/docs/l10n/cs/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/cs/guide/creating-bots.md +++ b/docs/l10n/cs/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/cs/guide/installation.md b/docs/l10n/cs/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/cs/guide/installation.md +++ b/docs/l10n/cs/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/cs/guide/usage.md b/docs/l10n/cs/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/cs/guide/usage.md +++ b/docs/l10n/cs/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/da/guide/chat-bots.md b/docs/l10n/da/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/da/guide/chat-bots.md +++ b/docs/l10n/da/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/da/guide/configuration.md b/docs/l10n/da/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/da/guide/configuration.md +++ b/docs/l10n/da/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/da/guide/creating-bots.md b/docs/l10n/da/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/da/guide/creating-bots.md +++ b/docs/l10n/da/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/da/guide/installation.md b/docs/l10n/da/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/da/guide/installation.md +++ b/docs/l10n/da/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/da/guide/usage.md b/docs/l10n/da/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/da/guide/usage.md +++ b/docs/l10n/da/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/de/guide/chat-bots.md b/docs/l10n/de/guide/chat-bots.md index d4a1d0ee..d512d70e 100644 --- a/docs/l10n/de/guide/chat-bots.md +++ b/docs/l10n/de/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/de/guide/configuration.md b/docs/l10n/de/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/de/guide/configuration.md +++ b/docs/l10n/de/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/de/guide/creating-bots.md b/docs/l10n/de/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/de/guide/creating-bots.md +++ b/docs/l10n/de/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/de/guide/installation.md b/docs/l10n/de/guide/installation.md index 4994224c..71a8ec32 100644 --- a/docs/l10n/de/guide/installation.md +++ b/docs/l10n/de/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/de/guide/usage.md b/docs/l10n/de/guide/usage.md index ba3a9043..cfb51701 100644 --- a/docs/l10n/de/guide/usage.md +++ b/docs/l10n/de/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Benutzung:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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)** +::: - **Benutzung:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Benutzung:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Benutzung:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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** +::: - **Benutzung:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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.** +::: - **Benutzung:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Benutzung:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Benutzung:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Benutzung:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Benutzung:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/el/guide/chat-bots.md b/docs/l10n/el/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/el/guide/chat-bots.md +++ b/docs/l10n/el/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/el/guide/configuration.md b/docs/l10n/el/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/el/guide/configuration.md +++ b/docs/l10n/el/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/el/guide/creating-bots.md b/docs/l10n/el/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/el/guide/creating-bots.md +++ b/docs/l10n/el/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/el/guide/installation.md b/docs/l10n/el/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/el/guide/installation.md +++ b/docs/l10n/el/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/el/guide/usage.md b/docs/l10n/el/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/el/guide/usage.md +++ b/docs/l10n/el/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/es/guide/chat-bots.md b/docs/l10n/es/guide/chat-bots.md index c5f2d5d4..1196702b 100644 --- a/docs/l10n/es/guide/chat-bots.md +++ b/docs/l10n/es/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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!). Never write something to the bot you wouldn't say in the normal chat (You have been warned!).** +::: - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/es/guide/configuration.md b/docs/l10n/es/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/es/guide/configuration.md +++ b/docs/l10n/es/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/es/guide/creating-bots.md b/docs/l10n/es/guide/creating-bots.md index d803c849..87ec1486 100644 --- a/docs/l10n/es/guide/creating-bots.md +++ b/docs/l10n/es/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -41,14 +45,14 @@ Paste the following example code: ```csharp //MCCScript 1.0 -MCC.LoadBot(new ExampleChatBot()); +MCC. LoadBot(new ExampleChatBot()); //MCCScript Extensions // The code and comments above are defining a "Script Metadata" section // Every single chat bot (script) must be a class which extends the ChatBot class. -// Your class must be instantiates in the "Script Metadata" section and passed to MCC.LoadBot function. +// Your class must be instantiates in the "Script Metadata" section and passed to MCC. LoadBot function. class ExampleChatBot : ChatBot { // This method will be called when the script has been initialized for the first time, it's called only once @@ -109,28 +113,30 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: ```csharp using System; -using System.Collections.Generic; -using System.Text.RegularExpressions; -using System.Linq; -using System.Text; -using System.IO; -using System.Net; -using System.Threading; +using System. Collections.Generic; +using System. Text.RegularExpressions; +using System. Linq; +using System. Text; +using System. IO; +using System. Net; +using System. Threading; using MinecraftClient; -using MinecraftClient.Mapping; -using MinecraftClient.Inventory; +using MinecraftClient. Mapping; +using MinecraftClient. ``` Example: ```csharp -//using System.Collections.Immutable +//using System. Collections.Immutable //dll MyDll.dll ``` @@ -139,10 +145,10 @@ Full Example: ```csharp //MCCScript 1.0 -//using System.Collections.Immutable +//using System. Collections.Immutable //dll MyDll.dll -MCC.LoadBot(new ExampleChatBot()); +MCC. LoadBot(new ExampleChatBot()); //MCCScript Extensions ``` @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/es/guide/installation.md b/docs/l10n/es/guide/installation.md index 4994224c..26d2bdb1 100644 --- a/docs/l10n/es/guide/installation.md +++ b/docs/l10n/es/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -457,7 +496,7 @@ Here is a [Youtube video](https://youtu.be/42fwh_1KP_o) that explains it in more If you're new to this, you can learn about it here: - - [What is Linux? by Bennett Bytes](https://www.youtube.com/watch?v=JsWQUOEL0N8) + - [What is Linux? by Bennett Bytes by Bennett Bytes](https://www.youtube.com/watch?v=JsWQUOEL0N8) - [Linux Terminal Introduction by ExplainingComputers](https://www.youtube.com/watch?v=SkB-eRCzWIU) - [Linux Crash Course - nano (command-line text editor) by Learn Linux TV](https://www.youtube.com/watch?v=DLeATFgGM-A) - [Linux Crash Course - The wget Command by Learn Linux TV](https://www.youtube.com/watch?v=F80Z5qd2b_4) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/es/guide/usage.md b/docs/l10n/es/guide/usage.md index cf371ff0..04c5e18f 100644 --- a/docs/l10n/es/guide/usage.md +++ b/docs/l10n/es/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -397,7 +411,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Using MCC class: ``` - /execif MCC.GetHealth() == 20.0 ---> send Success! + /execif MCC. GetHealth() == 20.0 ---> send Success! ``` @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/fi/guide/chat-bots.md b/docs/l10n/fi/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/fi/guide/chat-bots.md +++ b/docs/l10n/fi/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/fi/guide/configuration.md b/docs/l10n/fi/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/fi/guide/configuration.md +++ b/docs/l10n/fi/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/fi/guide/creating-bots.md b/docs/l10n/fi/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/fi/guide/creating-bots.md +++ b/docs/l10n/fi/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/fi/guide/installation.md b/docs/l10n/fi/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/fi/guide/installation.md +++ b/docs/l10n/fi/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/fi/guide/usage.md b/docs/l10n/fi/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/fi/guide/usage.md +++ b/docs/l10n/fi/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/fr/guide/chat-bots.md b/docs/l10n/fr/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/fr/guide/chat-bots.md +++ b/docs/l10n/fr/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/fr/guide/configuration.md b/docs/l10n/fr/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/fr/guide/configuration.md +++ b/docs/l10n/fr/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/fr/guide/creating-bots.md b/docs/l10n/fr/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/fr/guide/creating-bots.md +++ b/docs/l10n/fr/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/fr/guide/installation.md b/docs/l10n/fr/guide/installation.md index 4994224c..71a8ec32 100644 --- a/docs/l10n/fr/guide/installation.md +++ b/docs/l10n/fr/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/fr/guide/usage.md b/docs/l10n/fr/guide/usage.md index ed542f69..136bdd1d 100644 --- a/docs/l10n/fr/guide/usage.md +++ b/docs/l10n/fr/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Utilisation:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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)** +::: - **Utilisation:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Utilisation:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Utilisation:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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** +::: - **Utilisation:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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.** +::: - **Utilisation:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Utilisation:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Utilisation:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Utilisation:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Utilisation:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/he/guide/chat-bots.md b/docs/l10n/he/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/he/guide/chat-bots.md +++ b/docs/l10n/he/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/he/guide/configuration.md b/docs/l10n/he/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/he/guide/configuration.md +++ b/docs/l10n/he/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/he/guide/creating-bots.md b/docs/l10n/he/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/he/guide/creating-bots.md +++ b/docs/l10n/he/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/he/guide/installation.md b/docs/l10n/he/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/he/guide/installation.md +++ b/docs/l10n/he/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/he/guide/usage.md b/docs/l10n/he/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/he/guide/usage.md +++ b/docs/l10n/he/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/hu/guide/chat-bots.md b/docs/l10n/hu/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/hu/guide/chat-bots.md +++ b/docs/l10n/hu/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/hu/guide/configuration.md b/docs/l10n/hu/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/hu/guide/configuration.md +++ b/docs/l10n/hu/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/hu/guide/creating-bots.md b/docs/l10n/hu/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/hu/guide/creating-bots.md +++ b/docs/l10n/hu/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/hu/guide/installation.md b/docs/l10n/hu/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/hu/guide/installation.md +++ b/docs/l10n/hu/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/hu/guide/usage.md b/docs/l10n/hu/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/hu/guide/usage.md +++ b/docs/l10n/hu/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/it/guide/chat-bots.md b/docs/l10n/it/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/it/guide/chat-bots.md +++ b/docs/l10n/it/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/it/guide/configuration.md b/docs/l10n/it/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/it/guide/configuration.md +++ b/docs/l10n/it/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/it/guide/creating-bots.md b/docs/l10n/it/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/it/guide/creating-bots.md +++ b/docs/l10n/it/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/it/guide/installation.md b/docs/l10n/it/guide/installation.md index 4994224c..71a8ec32 100644 --- a/docs/l10n/it/guide/installation.md +++ b/docs/l10n/it/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/it/guide/usage.md b/docs/l10n/it/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/it/guide/usage.md +++ b/docs/l10n/it/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/ja/guide/chat-bots.md b/docs/l10n/ja/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/ja/guide/chat-bots.md +++ b/docs/l10n/ja/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/ja/guide/configuration.md b/docs/l10n/ja/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/ja/guide/configuration.md +++ b/docs/l10n/ja/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/ja/guide/creating-bots.md b/docs/l10n/ja/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/ja/guide/creating-bots.md +++ b/docs/l10n/ja/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/ja/guide/installation.md b/docs/l10n/ja/guide/installation.md index 4994224c..71a8ec32 100644 --- a/docs/l10n/ja/guide/installation.md +++ b/docs/l10n/ja/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/ja/guide/usage.md b/docs/l10n/ja/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/ja/guide/usage.md +++ b/docs/l10n/ja/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/ko/guide/chat-bots.md b/docs/l10n/ko/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/ko/guide/chat-bots.md +++ b/docs/l10n/ko/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/ko/guide/configuration.md b/docs/l10n/ko/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/ko/guide/configuration.md +++ b/docs/l10n/ko/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/ko/guide/creating-bots.md b/docs/l10n/ko/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/ko/guide/creating-bots.md +++ b/docs/l10n/ko/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/ko/guide/installation.md b/docs/l10n/ko/guide/installation.md index 4994224c..71a8ec32 100644 --- a/docs/l10n/ko/guide/installation.md +++ b/docs/l10n/ko/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/ko/guide/usage.md b/docs/l10n/ko/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/ko/guide/usage.md +++ b/docs/l10n/ko/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/lv/guide/chat-bots.md b/docs/l10n/lv/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/lv/guide/chat-bots.md +++ b/docs/l10n/lv/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/lv/guide/configuration.md b/docs/l10n/lv/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/lv/guide/configuration.md +++ b/docs/l10n/lv/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/lv/guide/creating-bots.md b/docs/l10n/lv/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/lv/guide/creating-bots.md +++ b/docs/l10n/lv/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/lv/guide/installation.md b/docs/l10n/lv/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/lv/guide/installation.md +++ b/docs/l10n/lv/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/lv/guide/usage.md b/docs/l10n/lv/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/lv/guide/usage.md +++ b/docs/l10n/lv/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/nl/guide/chat-bots.md b/docs/l10n/nl/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/nl/guide/chat-bots.md +++ b/docs/l10n/nl/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/nl/guide/configuration.md b/docs/l10n/nl/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/nl/guide/configuration.md +++ b/docs/l10n/nl/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/nl/guide/creating-bots.md b/docs/l10n/nl/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/nl/guide/creating-bots.md +++ b/docs/l10n/nl/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/nl/guide/installation.md b/docs/l10n/nl/guide/installation.md index 29038f48..d974a830 100644 --- a/docs/l10n/nl/guide/installation.md +++ b/docs/l10n/nl/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/nl/guide/usage.md b/docs/l10n/nl/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/nl/guide/usage.md +++ b/docs/l10n/nl/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/no/guide/chat-bots.md b/docs/l10n/no/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/no/guide/chat-bots.md +++ b/docs/l10n/no/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/no/guide/configuration.md b/docs/l10n/no/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/no/guide/configuration.md +++ b/docs/l10n/no/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/no/guide/creating-bots.md b/docs/l10n/no/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/no/guide/creating-bots.md +++ b/docs/l10n/no/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/no/guide/installation.md b/docs/l10n/no/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/no/guide/installation.md +++ b/docs/l10n/no/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/no/guide/usage.md b/docs/l10n/no/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/no/guide/usage.md +++ b/docs/l10n/no/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/pl/guide/chat-bots.md b/docs/l10n/pl/guide/chat-bots.md index c5f2d5d4..bb06c28e 100644 --- a/docs/l10n/pl/guide/chat-bots.md +++ b/docs/l10n/pl/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1145,7 +1167,7 @@ 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`) (eg. `37.0`) - **Format:** `{ min = , max = }` @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/pl/guide/configuration.md b/docs/l10n/pl/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/pl/guide/configuration.md +++ b/docs/l10n/pl/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/pl/guide/creating-bots.md b/docs/l10n/pl/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/pl/guide/creating-bots.md +++ b/docs/l10n/pl/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/pl/guide/installation.md b/docs/l10n/pl/guide/installation.md index 4994224c..71a8ec32 100644 --- a/docs/l10n/pl/guide/installation.md +++ b/docs/l10n/pl/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/pl/guide/usage.md b/docs/l10n/pl/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/pl/guide/usage.md +++ b/docs/l10n/pl/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/pt-BR/guide/README.md b/docs/l10n/pt-BR/guide/README.md index 81e1aee3..2a306e9d 100644 --- a/docs/l10n/pt-BR/guide/README.md +++ b/docs/l10n/pt-BR/guide/README.md @@ -142,11 +142,11 @@ Allyoutoo, Aragas, Bancey, bearbear12345, corbanmailloux, Daenges, dbear20, dogw 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 diff --git a/docs/l10n/pt-BR/guide/chat-bots.md b/docs/l10n/pt-BR/guide/chat-bots.md index c5f2d5d4..72eaa5da 100644 --- a/docs/l10n/pt-BR/guide/chat-bots.md +++ b/docs/l10n/pt-BR/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -44,7 +48,7 @@ - **Settings:** - **Section:** **`ChatBot.Alerts`** + **Section:** **`ChatBot. Alerts`** #### `Enabled` @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -172,7 +177,7 @@ - **Settings:** - **Section:** **`ChatBot.AntiAFK`** + **Section:** **`ChatBot. AntiAFK`** #### `Enabled` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,11 +275,12 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: 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`** + **Section:** **`ChatBot. AutoAttack`** #### `Enabled` @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -445,7 +454,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoCraft`** + **Section:** **`ChatBot. AutoCraft`** #### `Enabled` @@ -501,9 +510,9 @@ ### Defining a recipe - The recipes are defines as a separate new sub-section `[[ChatBot.AutoCraft.Recipes]]` of the `[ChatBot.AutoCraft]` section. + The recipes are defines as a separate new sub-section `[[ChatBot. AutoCraft. Recipes]]` of the `[ChatBot. AutoCraft]` section. - The `[[ChatBot.AutoCraft.Recipes]]` section needs to contain the following settings: + The `[[ChatBot. AutoCraft. Recipes]]` section needs to contain the following settings: - `Name` @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -569,21 +581,22 @@ ```toml # Stone Bricks using the player inventory - [[ChatBot.AutoCraft.Recipes]] + [[ChatBot. AutoCraft. Recipes]] Name = "Recipe-Name-1" Type = "player" Result = "StoneBricks" Slots = [ "Stone", "Stone", "Stone", "Stone", ] # Stone Bricks using a crafting table - [[ChatBot.AutoCraft.Recipes]] + [[ChatBot. AutoCraft. Recipes]] Name = "Recipe-Name-2" Type = "table" Result = "StoneBricks" Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -603,7 +618,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoDig`** + **Section:** **`ChatBot. AutoDig`** #### `Enabled` @@ -763,11 +778,12 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** - **Section:** **`ChatBot.AutoDrop`** + **Section:** **`ChatBot. AutoDrop`** #### `Enabled` @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,11 +848,12 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** - **Section:** **`ChatBot.AutoEat`** + **Section:** **`ChatBot. AutoEat`** #### `Enabled` @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -883,7 +905,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoFishing`** + **Section:** **`ChatBot. AutoFishing`** #### `Enabled` @@ -1055,7 +1077,7 @@ Some plugins do not allow the player to fish in one place for a long time. This setting allows the player to change position/angle after each catch. - Each position is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection, more on that bellow. + Each position is added as a new `[[ChatBot. AutoFishing. Movements]]` subsection, more on that bellow. - **Available values:** `true` and `false`. @@ -1066,7 +1088,7 @@ ### Adding a position/movement - Each position/movement is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection of `[ChatBot.AutoFishing]`. + Each position/movement is added as a new `[[ChatBot. AutoFishing. Movements]]` subsection of `[ChatBot. AutoFishing]`. **Avaliable settings/options:** @@ -1108,10 +1130,10 @@ #### Full example ```toml - [[ChatBot.AutoFishing.Movements]] + [[ChatBot. AutoFishing. Movements]] facing = { yaw = 12.34, pitch = -23.45 } - [[ChatBot.AutoFishing.Movements]] + [[ChatBot. AutoFishing. Movements]] XYZ = { x = 123.45, y = 64.0, z = -654.32 } facing = { yaw = -25.14, pitch = 36.25 } ``` @@ -1124,7 +1146,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoRelog`** + **Section:** **`ChatBot. AutoRelog`** #### `Enabled` @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,13 +1221,15 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** - **Section:** **`ChatBot.AutoRespond`** + **Section:** **`ChatBot. AutoRespond`** #### `Enabled` @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1260,7 +1287,7 @@ - **Settings:** - **Section:** **`ChatBot.ChatLog`** + **Section:** **`ChatBot. ChatLog`** #### `Enabled` @@ -1329,13 +1356,15 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** - **Section:** **`ChatBot.FollowPlayer`** + **Section:** **`ChatBot. FollowPlayer`** #### `Enabled` @@ -1383,11 +1412,12 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** - **Section:** **`ChatBot.HangmanGame`** + **Section:** **`ChatBot. HangmanGame`** #### `Enabled` @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1479,7 +1513,7 @@ * **Settings:** - **Section:** **`ChatBot.Mailer`** + **Section:** **`ChatBot. Mailer`** #### `Enabled` @@ -1510,7 +1544,7 @@ - **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. 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. @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1586,7 +1621,7 @@ - **Settings:** - **Section:** **`ChatBot.Map`** + **Section:** **`ChatBot. Map`** #### `Enabled` @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1678,7 +1716,7 @@ - **Settings:** - **Section:** **`ChatBot.PlayerListLogger`** + **Section:** **`ChatBot. PlayerListLogger`** #### `Enabled` @@ -1718,11 +1756,12 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** - **Section:** **`ChatBot.RemoteControl`** + **Section:** **`ChatBot. RemoteControl`** #### `Enabled` @@ -1768,15 +1807,18 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** - **Section:** **`ChatBot.ReplayCapture`** + **Section:** **`ChatBot. ReplayCapture`** #### `Enabled` @@ -1811,7 +1853,7 @@ - **Settings:** - **Section:** **`ChatBot.ScriptScheduler`** + **Section:** **`ChatBot. ScriptScheduler`** #### `Enabled` @@ -1830,17 +1872,18 @@ - **Description:** - Each task is defined as a new subsection `[[ChatBot.ScriptScheduler.TaskList]]` of the section: `[ChatBot.ScriptScheduler]`. + Each task is defined as a new subsection `[[ChatBot. ScriptScheduler. TaskList]]` of the section: `[ChatBot. ScriptScheduler]`. **Subsection format:** ```toml - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] = = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: tip **It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** +::: **Avaliable settings/options:** @@ -1900,10 +1943,10 @@ ### Full example ```toml - [ChatBot.ScriptScheduler] + [ChatBot. ScriptScheduler] Enabled = true - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] Task_Name = "Task Name 1" Trigger_On_First_Login = false Trigger_On_Login = false @@ -1911,7 +1954,7 @@ Trigger_On_Interval = { Enable = true, MinTime = 3.6, MaxTime = 4.8 } Action = "send /hello" - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] Task_Name = "Task Name 2" Trigger_On_First_Login = false Trigger_On_Login = true diff --git a/docs/l10n/pt-BR/guide/configuration.md b/docs/l10n/pt-BR/guide/configuration.md index 927413fa..7b2c1c0c 100644 --- a/docs/l10n/pt-BR/guide/configuration.md +++ b/docs/l10n/pt-BR/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -29,18 +31,16 @@ Full Example: ```toml [SectionNameHere] -Setting_Name = "this is some name" -Setting_Something = 15 +Setting_Name = "this is some name" Setting_Something = 15 [OtherSection] -# This is a comment explaining what this setting/option does -Other_Setting = true # This also is a comment +# This is a comment explaining what this setting/option does Other_Setting = true # This also is a comment [ThirdSection] Section_Enabled = true colors = [ "red", "yellow", "green" ] -[ThirdSection.Subsection] +[ThirdSection. Subsection] Coordinate = { x = 145, y = 64, y = 2045 } ``` @@ -48,7 +48,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Main General section -- **Section header:** `Main.General` +- **Section header:** `Main. General` #### `Account` @@ -98,7 +98,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -128,7 +129,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Main Advanced section -- **Section header:** `Main.Advanced` +- **Section header:** `Main. Advanced` #### `Language` @@ -222,7 +223,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -234,7 +236,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Type:** `string` -- **Version format:** `1.X.X` +- **Version format:** `1. X.X` - **Type:** `string` @@ -246,7 +248,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +267,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +280,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +361,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +378,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +391,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +447,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +490,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,11 +543,13 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section -- **Section header:** `Main.Advanced.AccountList` +- **Section header:** `Main. Advanced. AccountList` - **Description:** @@ -560,7 +575,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Server List section -- **Section header:** `Main.Advanced.ServerList` +- **Section header:** `Main. Advanced. ServerList` - **Description:** @@ -749,7 +764,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +779,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +814,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -829,9 +847,10 @@ Coordinate = { x = 145, y = 64, y = 2045 } This section allows you to define your own custom settings/variables which you can use in scripts, bots or other setting fields. - To define a variable/setting, simply make a new line with the following format under the `[AppVar.VarStirng]` section: + To define a variable/setting, simply make a new line with the following format under the `[AppVar. VarStirng]` section: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +891,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +933,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +943,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section @@ -1018,7 +1038,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ## MCSettings Skin section -- **Section header:** `MCSettings.Skin` +- **Section header:** `MCSettings. Skin` - **Description:** diff --git a/docs/l10n/pt-BR/guide/creating-bots.md b/docs/l10n/pt-BR/guide/creating-bots.md index d803c849..265e5560 100644 --- a/docs/l10n/pt-BR/guide/creating-bots.md +++ b/docs/l10n/pt-BR/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,23 +34,23 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. Paste the following example code: ```csharp -//MCCScript 1.0 - -MCC.LoadBot(new ExampleChatBot()); +//MCCScript 1.0 MCC. LoadBot(new ExampleChatBot()); //MCCScript Extensions // The code and comments above are defining a "Script Metadata" section // Every single chat bot (script) must be a class which extends the ChatBot class. -// Your class must be instantiates in the "Script Metadata" section and passed to MCC.LoadBot function. +// Your class must be instantiates in the "Script Metadata" section and passed to MCC. LoadBot function. class ExampleChatBot : ChatBot { // This method will be called when the script has been initialized for the first time, it's called only once @@ -99,38 +101,40 @@ Chat Bot (Script) structure is the following: `//MCCScript Extensions` marks the end of the **Script Metadata** section, this must be defined before a Chat Bot (Script) class. -In order for your Chat Bot (Script) to properly load in-between the `//MCCScript 1.0` and the `//MCCScript Extensions` lines you must instantiate your Chat Bot (Script) class and pass it to the `MCC.LoadBot` function. +In order for your Chat Bot (Script) to properly load in-between the `//MCCScript 1.0` and the `//MCCScript Extensions` lines you must instantiate your Chat Bot (Script) class and pass it to the `MCC. LoadBot` function. Example code: ``` -MCC.LoadBot(new YourChatBotClassNameHere()); +MCC. LoadBot(new YourChatBotClassNameHere()); ``` **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: ```csharp using System; -using System.Collections.Generic; -using System.Text.RegularExpressions; -using System.Linq; -using System.Text; +using System. Collections. Generic; +using System. Text. RegularExpressions; +using System. Linq; +using System. Text; using System.IO; -using System.Net; -using System.Threading; +using System. Net; +using System. Threading; using MinecraftClient; -using MinecraftClient.Mapping; -using MinecraftClient.Inventory; +using MinecraftClient. Mapping; +using MinecraftClient. ``` Example: ```csharp -//using System.Collections.Immutable +//using System. Collections. Immutable //dll MyDll.dll ``` @@ -139,10 +143,8 @@ Full Example: ```csharp //MCCScript 1.0 -//using System.Collections.Immutable -//dll MyDll.dll - -MCC.LoadBot(new ExampleChatBot()); +//using System. Collections. Immutable +//dll MyDll.dll MCC. LoadBot(new ExampleChatBot()); //MCCScript Extensions ``` @@ -155,7 +157,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/pt-BR/guide/installation.md b/docs/l10n/pt-BR/guide/installation.md index 4994224c..0c9766b7 100644 --- a/docs/l10n/pt-BR/guide/installation.md +++ b/docs/l10n/pt-BR/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -340,12 +374,8 @@ dotnet You should get a help page: ```bash -root@localhost:~# dotnet - -Usage: dotnet [options] -Usage: dotnet [path-to-application] - -Options: +root@localhost:~# dotnet Usage: dotnet [options] +Usage: dotnet [path-to-application] Options: -h|--help Display help. --info Display .NET information. --list-sdks Display the installed SDKs. @@ -359,7 +389,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +450,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +479,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +515,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +525,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +550,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +588,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +598,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +610,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +632,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +652,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +668,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +692,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +708,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +858,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +870,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -856,9 +932,7 @@ You should get: ``` Usage: dotnet [options] -Usage: dotnet [path-to-application] - -Options: +Usage: dotnet [path-to-application] Options: -h|--help Display help. --info Display .NET information. --list-sdks Display the installed SDKs. @@ -876,7 +950,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +970,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +980,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/pt-BR/guide/usage.md b/docs/l10n/pt-BR/guide/usage.md index cf371ff0..80a9f15f 100644 --- a/docs/l10n/pt-BR/guide/usage.md +++ b/docs/l10n/pt-BR/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,13 +91,12 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash -MinecraftClient.exe --help -MinecraftClient.exe -MinecraftClient.exe "/mycommand" -MinecraftClient.exe --setting=value [--other settings] +MinecraftClient.exe --help MinecraftClient.exe MinecraftClient.exe "/mycommand" MinecraftClient.exe --setting=value [--other settings] MinecraftClient.exe --section.setting=value [--other settings] MinecraftClient.exe [--other settings] ``` @@ -103,14 +104,11 @@ MinecraftClient.exe [--other settings] Examples: ```bash -# Logging in as a user: notch, with a password: password123 onto a server with the ip: mc.someserver.com:25565 -MinecraftClient.exe notch password123 mc.someserver.com:25565 +# Logging in as a user: notch, with a password: password123 onto a server with the ip: mc.someserver.com:25565 MinecraftClient.exe notch password123 mc.someserver.com:25565 -# Overriding a setting from MinecraftClient.ini using a command line parameter -MinecraftClient.exe --debugmessages=false +# Overriding a setting from MinecraftClient.ini using a command line parameter MinecraftClient.exe --debugmessages=false -# Providing a custom settings ini file and overriding a language to Chinese -MinecraftClient.exe CustomSettingsFile.ini --language=zh +# Providing a custom settings ini file and overriding a language to Chinese MinecraftClient.exe CustomSettingsFile.ini --language=zh ``` ### Rules of using the command line parameters @@ -168,7 +166,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +250,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +265,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +311,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +320,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +335,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +352,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +373,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -397,7 +405,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Using MCC class: ``` - /execif MCC.GetHealth() == 20.0 ---> send Success! + /execif MCC. GetHealth() == 20.0 ---> send Success! ``` @@ -444,7 +452,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +461,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +482,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +622,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +648,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +675,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +720,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +780,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +805,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +826,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +841,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +850,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +921,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +948,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/pt/guide/README.md b/docs/l10n/pt/guide/README.md index 81e1aee3..2a306e9d 100644 --- a/docs/l10n/pt/guide/README.md +++ b/docs/l10n/pt/guide/README.md @@ -142,11 +142,11 @@ Allyoutoo, Aragas, Bancey, bearbear12345, corbanmailloux, Daenges, dbear20, dogw 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 diff --git a/docs/l10n/pt/guide/chat-bots.md b/docs/l10n/pt/guide/chat-bots.md index c5f2d5d4..72eaa5da 100644 --- a/docs/l10n/pt/guide/chat-bots.md +++ b/docs/l10n/pt/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -44,7 +48,7 @@ - **Settings:** - **Section:** **`ChatBot.Alerts`** + **Section:** **`ChatBot. Alerts`** #### `Enabled` @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -172,7 +177,7 @@ - **Settings:** - **Section:** **`ChatBot.AntiAFK`** + **Section:** **`ChatBot. AntiAFK`** #### `Enabled` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,11 +275,12 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: 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`** + **Section:** **`ChatBot. AutoAttack`** #### `Enabled` @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -445,7 +454,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoCraft`** + **Section:** **`ChatBot. AutoCraft`** #### `Enabled` @@ -501,9 +510,9 @@ ### Defining a recipe - The recipes are defines as a separate new sub-section `[[ChatBot.AutoCraft.Recipes]]` of the `[ChatBot.AutoCraft]` section. + The recipes are defines as a separate new sub-section `[[ChatBot. AutoCraft. Recipes]]` of the `[ChatBot. AutoCraft]` section. - The `[[ChatBot.AutoCraft.Recipes]]` section needs to contain the following settings: + The `[[ChatBot. AutoCraft. Recipes]]` section needs to contain the following settings: - `Name` @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -569,21 +581,22 @@ ```toml # Stone Bricks using the player inventory - [[ChatBot.AutoCraft.Recipes]] + [[ChatBot. AutoCraft. Recipes]] Name = "Recipe-Name-1" Type = "player" Result = "StoneBricks" Slots = [ "Stone", "Stone", "Stone", "Stone", ] # Stone Bricks using a crafting table - [[ChatBot.AutoCraft.Recipes]] + [[ChatBot. AutoCraft. Recipes]] Name = "Recipe-Name-2" Type = "table" Result = "StoneBricks" Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -603,7 +618,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoDig`** + **Section:** **`ChatBot. AutoDig`** #### `Enabled` @@ -763,11 +778,12 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** - **Section:** **`ChatBot.AutoDrop`** + **Section:** **`ChatBot. AutoDrop`** #### `Enabled` @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,11 +848,12 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** - **Section:** **`ChatBot.AutoEat`** + **Section:** **`ChatBot. AutoEat`** #### `Enabled` @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -883,7 +905,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoFishing`** + **Section:** **`ChatBot. AutoFishing`** #### `Enabled` @@ -1055,7 +1077,7 @@ Some plugins do not allow the player to fish in one place for a long time. This setting allows the player to change position/angle after each catch. - Each position is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection, more on that bellow. + Each position is added as a new `[[ChatBot. AutoFishing. Movements]]` subsection, more on that bellow. - **Available values:** `true` and `false`. @@ -1066,7 +1088,7 @@ ### Adding a position/movement - Each position/movement is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection of `[ChatBot.AutoFishing]`. + Each position/movement is added as a new `[[ChatBot. AutoFishing. Movements]]` subsection of `[ChatBot. AutoFishing]`. **Avaliable settings/options:** @@ -1108,10 +1130,10 @@ #### Full example ```toml - [[ChatBot.AutoFishing.Movements]] + [[ChatBot. AutoFishing. Movements]] facing = { yaw = 12.34, pitch = -23.45 } - [[ChatBot.AutoFishing.Movements]] + [[ChatBot. AutoFishing. Movements]] XYZ = { x = 123.45, y = 64.0, z = -654.32 } facing = { yaw = -25.14, pitch = 36.25 } ``` @@ -1124,7 +1146,7 @@ - **Settings:** - **Section:** **`ChatBot.AutoRelog`** + **Section:** **`ChatBot. AutoRelog`** #### `Enabled` @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,13 +1221,15 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** - **Section:** **`ChatBot.AutoRespond`** + **Section:** **`ChatBot. AutoRespond`** #### `Enabled` @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1260,7 +1287,7 @@ - **Settings:** - **Section:** **`ChatBot.ChatLog`** + **Section:** **`ChatBot. ChatLog`** #### `Enabled` @@ -1329,13 +1356,15 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** - **Section:** **`ChatBot.FollowPlayer`** + **Section:** **`ChatBot. FollowPlayer`** #### `Enabled` @@ -1383,11 +1412,12 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** - **Section:** **`ChatBot.HangmanGame`** + **Section:** **`ChatBot. HangmanGame`** #### `Enabled` @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1479,7 +1513,7 @@ * **Settings:** - **Section:** **`ChatBot.Mailer`** + **Section:** **`ChatBot. Mailer`** #### `Enabled` @@ -1510,7 +1544,7 @@ - **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. 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. @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1586,7 +1621,7 @@ - **Settings:** - **Section:** **`ChatBot.Map`** + **Section:** **`ChatBot. Map`** #### `Enabled` @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1678,7 +1716,7 @@ - **Settings:** - **Section:** **`ChatBot.PlayerListLogger`** + **Section:** **`ChatBot. PlayerListLogger`** #### `Enabled` @@ -1718,11 +1756,12 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** - **Section:** **`ChatBot.RemoteControl`** + **Section:** **`ChatBot. RemoteControl`** #### `Enabled` @@ -1768,15 +1807,18 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** - **Section:** **`ChatBot.ReplayCapture`** + **Section:** **`ChatBot. ReplayCapture`** #### `Enabled` @@ -1811,7 +1853,7 @@ - **Settings:** - **Section:** **`ChatBot.ScriptScheduler`** + **Section:** **`ChatBot. ScriptScheduler`** #### `Enabled` @@ -1830,17 +1872,18 @@ - **Description:** - Each task is defined as a new subsection `[[ChatBot.ScriptScheduler.TaskList]]` of the section: `[ChatBot.ScriptScheduler]`. + Each task is defined as a new subsection `[[ChatBot. ScriptScheduler. TaskList]]` of the section: `[ChatBot. ScriptScheduler]`. **Subsection format:** ```toml - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] = = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: tip **It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** +::: **Avaliable settings/options:** @@ -1900,10 +1943,10 @@ ### Full example ```toml - [ChatBot.ScriptScheduler] + [ChatBot. ScriptScheduler] Enabled = true - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] Task_Name = "Task Name 1" Trigger_On_First_Login = false Trigger_On_Login = false @@ -1911,7 +1954,7 @@ Trigger_On_Interval = { Enable = true, MinTime = 3.6, MaxTime = 4.8 } Action = "send /hello" - [[ChatBot.ScriptScheduler.TaskList]] + [[ChatBot. ScriptScheduler. TaskList]] Task_Name = "Task Name 2" Trigger_On_First_Login = false Trigger_On_Login = true diff --git a/docs/l10n/pt/guide/configuration.md b/docs/l10n/pt/guide/configuration.md index 927413fa..7b2c1c0c 100644 --- a/docs/l10n/pt/guide/configuration.md +++ b/docs/l10n/pt/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -29,18 +31,16 @@ Full Example: ```toml [SectionNameHere] -Setting_Name = "this is some name" -Setting_Something = 15 +Setting_Name = "this is some name" Setting_Something = 15 [OtherSection] -# This is a comment explaining what this setting/option does -Other_Setting = true # This also is a comment +# This is a comment explaining what this setting/option does Other_Setting = true # This also is a comment [ThirdSection] Section_Enabled = true colors = [ "red", "yellow", "green" ] -[ThirdSection.Subsection] +[ThirdSection. Subsection] Coordinate = { x = 145, y = 64, y = 2045 } ``` @@ -48,7 +48,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Main General section -- **Section header:** `Main.General` +- **Section header:** `Main. General` #### `Account` @@ -98,7 +98,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -128,7 +129,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Main Advanced section -- **Section header:** `Main.Advanced` +- **Section header:** `Main. Advanced` #### `Language` @@ -222,7 +223,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -234,7 +236,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Type:** `string` -- **Version format:** `1.X.X` +- **Version format:** `1. X.X` - **Type:** `string` @@ -246,7 +248,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +267,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +280,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +361,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +378,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +391,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +447,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +490,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,11 +543,13 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section -- **Section header:** `Main.Advanced.AccountList` +- **Section header:** `Main. Advanced. AccountList` - **Description:** @@ -560,7 +575,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ### Server List section -- **Section header:** `Main.Advanced.ServerList` +- **Section header:** `Main. Advanced. ServerList` - **Description:** @@ -749,7 +764,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +779,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +814,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -829,9 +847,10 @@ Coordinate = { x = 145, y = 64, y = 2045 } This section allows you to define your own custom settings/variables which you can use in scripts, bots or other setting fields. - To define a variable/setting, simply make a new line with the following format under the `[AppVar.VarStirng]` section: + To define a variable/setting, simply make a new line with the following format under the `[AppVar. VarStirng]` section: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +891,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +933,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +943,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section @@ -1018,7 +1038,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } ## MCSettings Skin section -- **Section header:** `MCSettings.Skin` +- **Section header:** `MCSettings. Skin` - **Description:** diff --git a/docs/l10n/pt/guide/creating-bots.md b/docs/l10n/pt/guide/creating-bots.md index d803c849..265e5560 100644 --- a/docs/l10n/pt/guide/creating-bots.md +++ b/docs/l10n/pt/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,23 +34,23 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. Paste the following example code: ```csharp -//MCCScript 1.0 - -MCC.LoadBot(new ExampleChatBot()); +//MCCScript 1.0 MCC. LoadBot(new ExampleChatBot()); //MCCScript Extensions // The code and comments above are defining a "Script Metadata" section // Every single chat bot (script) must be a class which extends the ChatBot class. -// Your class must be instantiates in the "Script Metadata" section and passed to MCC.LoadBot function. +// Your class must be instantiates in the "Script Metadata" section and passed to MCC. LoadBot function. class ExampleChatBot : ChatBot { // This method will be called when the script has been initialized for the first time, it's called only once @@ -99,38 +101,40 @@ Chat Bot (Script) structure is the following: `//MCCScript Extensions` marks the end of the **Script Metadata** section, this must be defined before a Chat Bot (Script) class. -In order for your Chat Bot (Script) to properly load in-between the `//MCCScript 1.0` and the `//MCCScript Extensions` lines you must instantiate your Chat Bot (Script) class and pass it to the `MCC.LoadBot` function. +In order for your Chat Bot (Script) to properly load in-between the `//MCCScript 1.0` and the `//MCCScript Extensions` lines you must instantiate your Chat Bot (Script) class and pass it to the `MCC. LoadBot` function. Example code: ``` -MCC.LoadBot(new YourChatBotClassNameHere()); +MCC. LoadBot(new YourChatBotClassNameHere()); ``` **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: ```csharp using System; -using System.Collections.Generic; -using System.Text.RegularExpressions; -using System.Linq; -using System.Text; +using System. Collections. Generic; +using System. Text. RegularExpressions; +using System. Linq; +using System. Text; using System.IO; -using System.Net; -using System.Threading; +using System. Net; +using System. Threading; using MinecraftClient; -using MinecraftClient.Mapping; -using MinecraftClient.Inventory; +using MinecraftClient. Mapping; +using MinecraftClient. ``` Example: ```csharp -//using System.Collections.Immutable +//using System. Collections. Immutable //dll MyDll.dll ``` @@ -139,10 +143,8 @@ Full Example: ```csharp //MCCScript 1.0 -//using System.Collections.Immutable -//dll MyDll.dll - -MCC.LoadBot(new ExampleChatBot()); +//using System. Collections. Immutable +//dll MyDll.dll MCC. LoadBot(new ExampleChatBot()); //MCCScript Extensions ``` @@ -155,7 +157,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/pt/guide/installation.md b/docs/l10n/pt/guide/installation.md index 4994224c..0c9766b7 100644 --- a/docs/l10n/pt/guide/installation.md +++ b/docs/l10n/pt/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -340,12 +374,8 @@ dotnet You should get a help page: ```bash -root@localhost:~# dotnet - -Usage: dotnet [options] -Usage: dotnet [path-to-application] - -Options: +root@localhost:~# dotnet Usage: dotnet [options] +Usage: dotnet [path-to-application] Options: -h|--help Display help. --info Display .NET information. --list-sdks Display the installed SDKs. @@ -359,7 +389,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +450,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +479,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +515,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +525,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +550,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +588,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +598,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +610,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +632,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +652,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +668,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +692,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +708,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +858,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +870,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -856,9 +932,7 @@ You should get: ``` Usage: dotnet [options] -Usage: dotnet [path-to-application] - -Options: +Usage: dotnet [path-to-application] Options: -h|--help Display help. --info Display .NET information. --list-sdks Display the installed SDKs. @@ -876,7 +950,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +970,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +980,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/pt/guide/usage.md b/docs/l10n/pt/guide/usage.md index cf371ff0..80a9f15f 100644 --- a/docs/l10n/pt/guide/usage.md +++ b/docs/l10n/pt/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,13 +91,12 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash -MinecraftClient.exe --help -MinecraftClient.exe -MinecraftClient.exe "/mycommand" -MinecraftClient.exe --setting=value [--other settings] +MinecraftClient.exe --help MinecraftClient.exe MinecraftClient.exe "/mycommand" MinecraftClient.exe --setting=value [--other settings] MinecraftClient.exe --section.setting=value [--other settings] MinecraftClient.exe [--other settings] ``` @@ -103,14 +104,11 @@ MinecraftClient.exe [--other settings] Examples: ```bash -# Logging in as a user: notch, with a password: password123 onto a server with the ip: mc.someserver.com:25565 -MinecraftClient.exe notch password123 mc.someserver.com:25565 +# Logging in as a user: notch, with a password: password123 onto a server with the ip: mc.someserver.com:25565 MinecraftClient.exe notch password123 mc.someserver.com:25565 -# Overriding a setting from MinecraftClient.ini using a command line parameter -MinecraftClient.exe --debugmessages=false +# Overriding a setting from MinecraftClient.ini using a command line parameter MinecraftClient.exe --debugmessages=false -# Providing a custom settings ini file and overriding a language to Chinese -MinecraftClient.exe CustomSettingsFile.ini --language=zh +# Providing a custom settings ini file and overriding a language to Chinese MinecraftClient.exe CustomSettingsFile.ini --language=zh ``` ### Rules of using the command line parameters @@ -168,7 +166,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +250,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +265,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +311,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +320,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +335,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +352,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +373,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -397,7 +405,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Using MCC class: ``` - /execif MCC.GetHealth() == 20.0 ---> send Success! + /execif MCC. GetHealth() == 20.0 ---> send Success! ``` @@ -444,7 +452,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +461,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +482,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +622,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +648,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +675,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +720,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +780,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +805,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +826,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +841,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +850,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +921,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +948,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/ro/guide/chat-bots.md b/docs/l10n/ro/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/ro/guide/chat-bots.md +++ b/docs/l10n/ro/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/ro/guide/configuration.md b/docs/l10n/ro/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/ro/guide/configuration.md +++ b/docs/l10n/ro/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/ro/guide/creating-bots.md b/docs/l10n/ro/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/ro/guide/creating-bots.md +++ b/docs/l10n/ro/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/ro/guide/installation.md b/docs/l10n/ro/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/ro/guide/installation.md +++ b/docs/l10n/ro/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/ro/guide/usage.md b/docs/l10n/ro/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/ro/guide/usage.md +++ b/docs/l10n/ro/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/ru/guide/chat-bots.md b/docs/l10n/ru/guide/chat-bots.md index 7f4de73e..c087f2c4 100644 --- a/docs/l10n/ru/guide/chat-bots.md +++ b/docs/l10n/ru/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -569,21 +581,20 @@ ```toml # Stone Bricks using the player inventory - [[ChatBot.AutoCraft.Recipes]] - Name = "Recipe-Name-1" + [[ChatBot.AutoCraft.Recipes]] Name = "Recipe-Name-1" Type = "player" Result = "StoneBricks" Slots = [ "Stone", "Stone", "Stone", "Stone", ] # Stone Bricks using a crafting table - [[ChatBot.AutoCraft.Recipes]] - Name = "Recipe-Name-2" + [[ChatBot.AutoCraft.Recipes]] Name = "Recipe-Name-2" Type = "table" Result = "StoneBricks" Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +602,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +776,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +829,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +846,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +882,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1108,11 +1128,9 @@ #### Full example ```toml - [[ChatBot.AutoFishing.Movements]] - facing = { yaw = 12.34, pitch = -23.45 } + [[ChatBot.AutoFishing.Movements]] facing = { yaw = 12.34, pitch = -23.45 } - [[ChatBot.AutoFishing.Movements]] - XYZ = { x = 123.45, y = 64.0, z = -654.32 } + [[ChatBot.AutoFishing.Movements]] XYZ = { x = 123.45, y = 64.0, z = -654.32 } facing = { yaw = -25.14, pitch = 36.25 } ``` @@ -1164,7 +1182,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1217,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1250,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1268,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1352,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1408,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1443,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1456,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1493,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1602,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1640,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1670,8 @@ 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.** + ::: 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`. @@ -1718,7 +1752,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1803,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1835,12 +1873,12 @@ **Subsection format:** ```toml - [[ChatBot.ScriptScheduler.TaskList]] - = + [[ChatBot.ScriptScheduler.TaskList]] = = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: tip **It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** +::: **Avaliable settings/options:** @@ -1903,16 +1941,14 @@ [ChatBot.ScriptScheduler] Enabled = true - [[ChatBot.ScriptScheduler.TaskList]] - Task_Name = "Task Name 1" + [[ChatBot.ScriptScheduler.TaskList]] Task_Name = "Task Name 1" Trigger_On_First_Login = false Trigger_On_Login = false Trigger_On_Times = { Enable = true, Times = [ 14:00:00, ] } Trigger_On_Interval = { Enable = true, MinTime = 3.6, MaxTime = 4.8 } Action = "send /hello" - [[ChatBot.ScriptScheduler.TaskList]] - Task_Name = "Task Name 2" + [[ChatBot.ScriptScheduler.TaskList]] Task_Name = "Task Name 2" Trigger_On_First_Login = false Trigger_On_Login = true Trigger_On_Times = { Enable = false, Times = [ ] } diff --git a/docs/l10n/ru/guide/configuration.md b/docs/l10n/ru/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/ru/guide/configuration.md +++ b/docs/l10n/ru/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/ru/guide/creating-bots.md b/docs/l10n/ru/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/ru/guide/creating-bots.md +++ b/docs/l10n/ru/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/ru/guide/installation.md b/docs/l10n/ru/guide/installation.md index 4cef4bec..e87de6a8 100644 --- a/docs/l10n/ru/guide/installation.md +++ b/docs/l10n/ru/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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.** +::: ### Установка #### Termux -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/ru/guide/usage.md b/docs/l10n/ru/guide/usage.md index bb1ee361..5846249c 100644 --- a/docs/l10n/ru/guide/usage.md +++ b/docs/l10n/ru/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Применение:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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)** +::: - **Применение:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Применение:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Применение:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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** +::: - **Применение:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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.** +::: - **Применение:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Применение:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Применение:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Применение:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Применение:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/sr-Cyrl/guide/chat-bots.md b/docs/l10n/sr-Cyrl/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/sr-Cyrl/guide/chat-bots.md +++ b/docs/l10n/sr-Cyrl/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/sr-Cyrl/guide/configuration.md b/docs/l10n/sr-Cyrl/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/sr-Cyrl/guide/configuration.md +++ b/docs/l10n/sr-Cyrl/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/sr-Cyrl/guide/creating-bots.md b/docs/l10n/sr-Cyrl/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/sr-Cyrl/guide/creating-bots.md +++ b/docs/l10n/sr-Cyrl/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/sr-Cyrl/guide/installation.md b/docs/l10n/sr-Cyrl/guide/installation.md index 027828ea..023ec501 100644 --- a/docs/l10n/sr-Cyrl/guide/installation.md +++ b/docs/l10n/sr-Cyrl/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/sr-Cyrl/guide/usage.md b/docs/l10n/sr-Cyrl/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/sr-Cyrl/guide/usage.md +++ b/docs/l10n/sr-Cyrl/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/sv/guide/chat-bots.md b/docs/l10n/sv/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/sv/guide/chat-bots.md +++ b/docs/l10n/sv/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/sv/guide/configuration.md b/docs/l10n/sv/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/sv/guide/configuration.md +++ b/docs/l10n/sv/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/sv/guide/creating-bots.md b/docs/l10n/sv/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/sv/guide/creating-bots.md +++ b/docs/l10n/sv/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/sv/guide/installation.md b/docs/l10n/sv/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/sv/guide/installation.md +++ b/docs/l10n/sv/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/sv/guide/usage.md b/docs/l10n/sv/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/sv/guide/usage.md +++ b/docs/l10n/sv/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/tr/guide/chat-bots.md b/docs/l10n/tr/guide/chat-bots.md index de15f6e4..3713cbf1 100644 --- a/docs/l10n/tr/guide/chat-bots.md +++ b/docs/l10n/tr/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/tr/guide/configuration.md b/docs/l10n/tr/guide/configuration.md index f3644b9a..643389b2 100644 --- a/docs/l10n/tr/guide/configuration.md +++ b/docs/l10n/tr/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/tr/guide/creating-bots.md b/docs/l10n/tr/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/tr/guide/creating-bots.md +++ b/docs/l10n/tr/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/tr/guide/installation.md b/docs/l10n/tr/guide/installation.md index 41ff1125..a5b177a2 100644 --- a/docs/l10n/tr/guide/installation.md +++ b/docs/l10n/tr/guide/installation.md @@ -18,7 +18,7 @@ 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) -> **⚠️ IMPORTANT: 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.** +⚠️ IMPORTANT: 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 @@ -87,7 +87,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +115,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +124,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +139,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +162,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +213,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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.** +::: ### Kurulum #### Termux -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +250,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +262,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +284,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +320,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +359,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +393,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +454,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +483,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +519,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +529,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +554,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +592,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +602,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +614,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +636,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +656,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +672,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +696,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +712,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +862,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +874,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +956,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +976,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +986,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/tr/guide/usage.md b/docs/l10n/tr/guide/usage.md index 896ae38c..7ff40ff3 100644 --- a/docs/l10n/tr/guide/usage.md +++ b/docs/l10n/tr/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Kullanım:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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)** +::: - **Kullanım:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Kullanım:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Kullanım:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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** +::: - **Kullanım:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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.** +::: - **Kullanım:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Kullanım:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Kullanım:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Kullanım:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Kullanım:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/uk/guide/chat-bots.md b/docs/l10n/uk/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/uk/guide/chat-bots.md +++ b/docs/l10n/uk/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/uk/guide/configuration.md b/docs/l10n/uk/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/uk/guide/configuration.md +++ b/docs/l10n/uk/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/uk/guide/creating-bots.md b/docs/l10n/uk/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/uk/guide/creating-bots.md +++ b/docs/l10n/uk/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/uk/guide/installation.md b/docs/l10n/uk/guide/installation.md index 4994224c..229db5d6 100644 --- a/docs/l10n/uk/guide/installation.md +++ b/docs/l10n/uk/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/uk/guide/usage.md b/docs/l10n/uk/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/uk/guide/usage.md +++ b/docs/l10n/uk/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/vi/guide/chat-bots.md b/docs/l10n/vi/guide/chat-bots.md index c5f2d5d4..da57a02f 100644 --- a/docs/l10n/vi/guide/chat-bots.md +++ b/docs/l10n/vi/guide/chat-bots.md @@ -8,9 +8,13 @@ **Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. -> **⚠️ IMPORTANT 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.** +::: 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.** +::: -> **ℹ️ NOTE: Settings refer to settings in the [configuration file](configuration.md)** +::: tip +**Settings refer to settings in the [configuration file](configuration.md)** +::: ## List of built-in Chat Bots @@ -65,7 +69,8 @@ This setting specifies if you want to hear a beep when you get an alert. - > **ℹ️ NOTE: This might not work depending on your system or a console (terminal emulator).** + ::: tip **This might not work depending on your system or a console (terminal emulator).** +::: - **Type:** `boolean` @@ -232,7 +237,8 @@ This will enable your bot to randomly move about, thus a better anti afk effect. - > **ℹ️ NOTE: You need to enable [Terrain Handling](configuration.md#terrainandmovements) in the settings and it's recommended to put the bot into an enclosure not to wander off. (Recommended size 5x5x5)** + ::: 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`. @@ -258,7 +264,8 @@ 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. - > **ℹ️ NOTE: This happens on each trigger of the task, so it does not permanently switch to alternative method.** + ::: tip **This happens on each trigger of the task, so it does not permanently switch to alternative method.** +::: - **Default:** `20` @@ -268,7 +275,8 @@ Automatically attacks mobs around you, you can configure it to attack both hostile and passive mobs and only certain mobs or all mobs. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -423,7 +431,8 @@ Automatically craft items in your inventory or in a crafting table. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for basic crafting in the inventory to work, in addition if you want to use a crafting table, you need to enable [terrainandmovements](configuration.md#terrainandmovements) in order for bot to be able to reach the crafting table.** + ::: 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:** @@ -515,7 +524,8 @@ **Avaliable values:** `player` and `table` - > **ℹ️ NOTE: If you're using `table` you need to set the `CraftingTable` setting.** + ::: tip **If you're using `table` you need to set the `CraftingTable` setting.** +::: - `Result` @@ -537,9 +547,11 @@ Slots = [ "", "", ... ] ``` - > **ℹ️ NOTE: 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 **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", ]`** +::: - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: 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:** @@ -583,7 +595,8 @@ Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] ``` - > **ℹ️ NOTE: Make sure to provide materials for your bot by placing them in inventory first.** + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: ## Auto Dig @@ -591,9 +604,11 @@ Automatically digs block on specified locations. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: Since MCC does not yet support accurate calculation of the collision volume of blocks, all blocks are considered as complete cubes when obtaining the position of the lookahead.** + ::: 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:** @@ -763,7 +778,8 @@ Automatically drop items you don't need from the inventory. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -815,7 +831,8 @@ This setting is where you can specify the list of items which you want to drop, or keep. - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Format:** `[ "", "", ...]` @@ -831,7 +848,8 @@ Automatically eat food when your Hunger value is low. - > **ℹ️ NOTE: You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: - **Settings:** @@ -866,13 +884,17 @@ Automatically catch fish using a fishing rod. - > **ℹ️ NOTE: You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - > **ℹ️ NOTE: To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: - > **ℹ️ NOTE: Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: - > **ℹ️ NOTE: A fishing rod with **Mending enchantment** is strongly recommended.** + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: **Steps for using this bot (with the default setting)** @@ -1164,7 +1186,8 @@ Use `-1` for infinite retries. - > **ℹ️ NOTE: This might get you banned by the server owners.** + ::: tip **This might get you banned by the server owners.** +::: - **Default:** `-1` @@ -1198,9 +1221,11 @@ Run commands or send messages automatically when a specified pattern is detected in the chat. - > **⚠️ WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: - > **⚠️ WARNING: This bot may get spammy depending on your rules, although the global [messagecooldown](configuration.md#messagecooldown) setting can help you avoiding accidental spam.** + ::: 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:** @@ -1229,7 +1254,8 @@ _PS: In the future we will document the rules here with examples too._ - > **ℹ️ NOTE: This file is not created by default, we recommend making a clone of the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) and changing it according to your needs.** + ::: 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` @@ -1246,7 +1272,8 @@ List of all color codes: [here](https://minecraft.tools/en/color-code.php) - > **ℹ️ NOTE: This feature uses the `§` symbol for color matching** + ::: tip **This feature uses the `§` symbol for color matching** +::: - **Type:** `boolean` @@ -1329,9 +1356,11 @@ This bot enables you to make a bot follow a specific player. - > **ℹ️ NOTE: The bot can be slow at times, you need to walk with a normal speed and to sometimes stop for it to be able to keep up with you, it's similar to making animals follow you when you're holding food in your hand. This is due to a slow pathfinding algorithm, we're working on getting a better one. You can tweak the update limit and find what works best for you. (NOTE: Do not but a very low one, because you might achieve the opposite, this might clog the thread for terrain handling) and thus slow the bot even more.** + ::: tip **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.** +::: - > **ℹ️ NOTE: You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** + ::: tip **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: - **Settings:** @@ -1383,7 +1412,8 @@ 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. - > **ℹ️ NOTE: If the bot does not respond to bot owners, see the [Detecting chat messages](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config#detecting-chat-messages) section.** + ::: 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:** @@ -1417,7 +1447,8 @@ 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. - > **ℹ️ NOTE: This settings file is for English and is not created by the default** + ::: 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) @@ -1429,7 +1460,8 @@ This setting is same as the above but for French. - > **ℹ️ NOTE: This settings file is for French and is not created by the default** + ::: 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) @@ -1465,9 +1497,11 @@ Show all ignored players. - > **⚠️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 **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: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: **Mailer Network:** @@ -1572,7 +1606,8 @@ The maps are **rendered** into `Rendered_Maps` folder. - > **⚠️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.** + ::: 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:** @@ -1609,9 +1644,11 @@ The default map size is `128x128`. - > **ℹ️ NOTE: The bigger the size, the less is the quality.** + ::: tip **The bigger the size, the less is the quality.** +::: - > **ℹ️ NOTE: For upscaling your maps you could use (getting a bit better quality): https://deepai.org/machine-learning-model/torch-srgan** + ::: 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`. @@ -1637,7 +1674,8 @@ 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.** + ::: 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`. @@ -1718,7 +1756,8 @@ You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. - > **⚠️WARNING: Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: - **Settings:** @@ -1768,11 +1807,14 @@ Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). - > **⚠️ IMPORTANT: This bot does not work for 1.19, we need maintainers for it.** + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: - > **ℹ️ NOTE: Please note that due to technical limitations, the client player (you) will not be shown in the replay file** + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: - > **⚠️ WARNING: You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: - **Settings:** @@ -1840,7 +1882,8 @@ = ``` - > **ℹ️ NOTE: It is recommended that you align subsections to the right by one tab or 4 spaces for better readability.** + ::: 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/l10n/vi/guide/configuration.md b/docs/l10n/vi/guide/configuration.md index 927413fa..ef8495d7 100644 --- a/docs/l10n/vi/guide/configuration.md +++ b/docs/l10n/vi/guide/configuration.md @@ -4,7 +4,9 @@ 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. -> **⚠️ IMPORTANT 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.** +::: 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 @@ -98,7 +100,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } This setting is where you define the type of your account: `mojang` or `microsoft` - > **ℹ️ NOTE: Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: - **Type:** `string` @@ -222,7 +225,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] ``` - > **⚠️ WARNING: Admins can impersonate players on versions older than 1.19** + ::: warning **Admins can impersonate players on versions older than 1.19** +::: #### `MinecraftVersion` @@ -246,7 +250,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } MinecraftVersion = "1.18.2" ``` - > **ℹ️ NOTE: MCC supports only 1.4.6 - 1.19.2** + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: #### `EnableForge` @@ -264,7 +269,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `auto` - > **ℹ️ NOTE: Force-enabling only works for MC 1.13 +** + ::: tip **Force-enabling only works for MC 1.13 +** +::: #### `BrandInfo` @@ -276,7 +282,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `mcc` - > **ℹ️ NOTE: For playing on Hypixel you need to use `vanilla`** + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: #### `ChatbotLogFile` @@ -356,13 +363,16 @@ 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: This feature is currently not supported in `1.4.6 - 1.6`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.6`.** +::: - **Type:** `boolean` - **Default:** `false` -> **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `InventoryHandling` @@ -370,7 +380,8 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` @@ -382,13 +393,15 @@ 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: This feature is currently not supported in `1.4.6 - 1.9`.** + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: - **Type:** `boolean` - **Default:** `false` - > **ℹ️ NOTE: Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: #### `SessionCache` @@ -436,7 +449,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `true` - > **ℹ️ NOTE: Only works on Windows XP-8 or Windows 10 with old console** + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: #### `ExitOnFailure` @@ -478,7 +492,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **ℹ️ NOTE: Make sure the spawn point is safe** + ::: tip **Make sure the spawn point is safe** +::: #### `MinecraftRealms` @@ -530,7 +545,9 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `2` -> **⚠️ WARNING: A movement speed higher than 2 may be considered cheating by some plugins.** +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: ### Account List section @@ -749,7 +766,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `DebugFilterRegex` @@ -763,7 +781,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `.*` - > **ℹ️ NOTE: Not filtering anything by default** + ::: tip **Not filtering anything by default** +::: #### `FilterMode` @@ -797,7 +816,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `console-log.txt` - > **ℹ️ NOTE: %username% and %serverip% will be substituted with your username and the IP address of the server you are connected to. So you can use something like: `console-log-%username%-%serverip%.txt`** + ::: 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` @@ -831,7 +851,8 @@ 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: - > **ℹ️ NOTE: `%username%`, `%serverip%`, `%datetime%` are reserved variables** + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: - **Section header:** `Logging` @@ -872,7 +893,8 @@ Coordinate = { x = 145, y = 64, y = 2045 } - **Default:** `false` - > **⚠️ WARNING: Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: #### `Server` @@ -913,7 +935,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` #### `Password` @@ -923,7 +945,7 @@ Coordinate = { x = 145, y = 64, y = 2045 } Only needed for password protected proxies. -- **Default:** `` +- **Default:** `` `` ## MCSettings section diff --git a/docs/l10n/vi/guide/creating-bots.md b/docs/l10n/vi/guide/creating-bots.md index d803c849..050580aa 100644 --- a/docs/l10n/vi/guide/creating-bots.md +++ b/docs/l10n/vi/guide/creating-bots.md @@ -8,7 +8,9 @@ ## Notes -> **ℹ️ NOTE: 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.** +::: 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. @@ -32,7 +34,9 @@ More in-depth: This introduction assumes that you have the basic knowledge of C#. -> **ℹ️ NOTE: Here we will use terms Chat Bot and Script interchangeably** +::: 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. @@ -109,7 +113,9 @@ MCC.LoadBot(new YourChatBotClassNameHere()); **Script Metadata** section allows for including C# packages and libraries with: `//using ` and `/dll `. -> **ℹ️ NOTE: Avoid adding whitespace between `//` and keywords** +::: tip +**Avoid adding whitespace between `//` and keywords** +::: By the default the following packages are loaded: @@ -155,7 +161,8 @@ 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.. -> **ℹ️ NOTE: For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`**. +::: tip +**For allocating resources like a database connection, we recommend allocating them in `AfterGameJoined` and freeing them in `OnDisconnect`** :::. ## Examples diff --git a/docs/l10n/vi/guide/installation.md b/docs/l10n/vi/guide/installation.md index 916c4254..9e519130 100644 --- a/docs/l10n/vi/guide/installation.md +++ b/docs/l10n/vi/guide/installation.md @@ -18,7 +18,9 @@ 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) -> **⚠️ IMPORTANT: 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.** +::: 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 @@ -87,7 +89,8 @@ Requirements: - Linux: - > **ℹ️ NOTE: If you're using Linux we will assume that you should be able to install git on your own. If you don't know how, search it up for your distribution, it should be easy. (Debian based distros: `apt install git`, Arch based: `pacman -S git`)** + ::: 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) @@ -114,7 +117,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -122,7 +126,8 @@ 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 ``` - > **ℹ️ NOTE: 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`)** + ::: 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: @@ -136,9 +141,13 @@ Requirements: - Git - Docker -> **ℹ️ NOTE: This section is for more advanced users, if you do not know how to install git or docker, you can take a look at other sections for Git, and search on how to install Docker on your system.** +::: 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: 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.** +::: 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: @@ -155,7 +164,9 @@ docker build -t minecraft-console-client:latest . **Start the container using Docker:** -> **⚠️ VERY IMPORTANT ⚠️: 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`.** +::: 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 @@ -204,23 +215,35 @@ 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. -> **ℹ️ NOTE: 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 +**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.** +::: -> **ℹ️ NOTE: You're required to have some bare basic knowledge of Linux, if you do not know anything about it, watch [this video](https://www.youtube.com/watch?v=SkB-eRCzWIU) to get familiar with basic commands.** +::: tip +**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.** +::: -> **ℹ️ NOTE: Here we're installing everything on the root account for simplicity sake, if you want to make a user account, make sure you update the command which reference the `/root` directory with your home directory.** +::: 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 -> **⚠️ IMPORTANT: 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/).** +::: 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. -> **ℹ️ NOTE: 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.** +::: 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.** +::: -> **⚠️ VERY IMPORTANT ⚠️: 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!** +::: 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 @@ -229,7 +252,9 @@ 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) -> **ℹ️ NOTE: 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.** +::: 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. @@ -239,7 +264,9 @@ Once you have Termux installed open it up and run the following command one afte 2. `pkg upgrade` 3. `pkg install proot wget` -> **ℹ️ NOTE: If you're asked to press Y/N during the update/upgrade command process, just enter Y and press Enter** +::: 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: @@ -259,7 +286,9 @@ Then you will be asked a question, enter `Y` and press `Enter`. Once the install ./startubuntu.sh ``` -> **ℹ️ NOTE: Now every time you open Termux after it has been closed, in order to access Ubuntu you have to use this command** +::: 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 @@ -293,26 +322,31 @@ 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 ``` -> **ℹ️ NOTE: 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 +**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)** :::. -> **ℹ️ NOTE: 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.** +::: 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` - - > **⚠️ IMPORTANT: If you're using a different download link, update the file name in this command to match your version.** +1. `DOTNET_FILE=dotnet-sdk-6.0.400-linux-arm64.tar.gz` ::: 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` - > **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** + ::: 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. -> **⚠️ IMPORTANT: 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)** +::: 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: @@ -327,7 +361,9 @@ export DOTNET_ROOT=/root/.dotnet/ export PATH=$PATH:$DOTNET_ROOT:$DOTNET_ROOT/tools ``` -> **⚠️ IMPORTANT: Here we're installing .NET in `/root`, if you're installing it somewhere else, make sure to set your own path!** +::: 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. @@ -359,7 +395,9 @@ path-to-application: Finally, we can install MCC. -> **⚠️ IMPORTANT: 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.** +::: 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: @@ -418,7 +456,9 @@ Also, here are some linux tutorials for people who are new to it: ## Run on a VPS -> **ℹ️ NOTE: 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!** +::: 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. @@ -445,7 +485,8 @@ 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). - > **ℹ️ NOTE: Make sure to allow the installation to add it to the context menu** + ::: 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) @@ -480,7 +521,9 @@ The MCC is not expensive to run, so it can run on basically any hardware, you do **Where to buy a VPS?** -> **⚠️ VERY IMPORTANT: In this tutorial we will be using `Ubuntu 22.04`, make sure to select it as the OS when buying a VPS.** +::: 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): @@ -488,7 +531,8 @@ Some of the reliable and cheap hosting providers (sorted for price/performance): **Minimum price**: `2.50 EUR / month` - > **ℹ️ NOTE: 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.** + ::: 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/) @@ -512,23 +556,35 @@ You also may want to search for better deals. #### AWS EC2 VPS -> **⚠️ VERY IMPORTANT: 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.** +::: 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: 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 +**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: 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.** +::: 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.** +::: -> **ℹ️ NOTE: If you're not banned, sometimes fetching the keys can take some time, try giving it a minute or two, if it still hangs, hit some keys to refresh the screen, or try restarting and running again. If it still happens, use tmux instead of screen.** +::: 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 -> **ℹ️ NOTE: Skip this section if you're not using AWS. Go to [Initial VPS setup](#initial-vps-setup)** +::: 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` -> **ℹ️ NOTE: Make sure to select the region closest to you for the minimal latency** +::: tip +**Make sure to select the region closest to you for the minimal latency** +::: Click on the **Launch instance** button. @@ -538,7 +594,9 @@ 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`. -> **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.** +::: danger +**Make sure that it has `Free tier eligible` next to it.** +::: ![VPS Select OS](/images/guide/VPS_SelectOS.png) @@ -546,7 +604,9 @@ 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. -> **⚠️ EXTREMELY IMPORTANT: 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.** +::: 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) @@ -556,7 +616,9 @@ For the **Network settings** check the following checkboxes on: - `Allow HTTPs traffic from the internet` - `Allow HTTP traffic from the internet` -> **ℹ️ NOTE: The SSH traffic from Anywhere is not the best thing for security, you might want to enter IP addresses of your devices from which you want to access the VPS manually.** +::: 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) @@ -576,9 +638,13 @@ In order to login with SSH, you are going to use the following command: ssh -i ubuntu@ ``` -> **ℹ️ NOTE: `<` and `>` are not typed, that is just a notation for a placeholder!** +::: tip +**`<` and `>` are not typed, that is just a notation for a placeholder!** +::: -> **ℹ️ NOTE: `ubuntu` is a default root account username for Ubuntu on AWS!** +::: tip +**`ubuntu` is a default root account username for Ubuntu on AWS!** +::: Example: @@ -592,7 +658,9 @@ Now you can continue to [Creating a new user](#creating-a-new-user) ### Initial VPS setup -> **ℹ️ NOTE: This section if for those who do not use AWS, if you use AWS skip it** +::: 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. @@ -606,7 +674,9 @@ If you're on Windows open `Git Bash`, on mac OS and Linux open a `Terminal` and ssh @ ``` -> **ℹ️ NOTE: If you're given a custom port other than `22` by your host, you should add `-p ` before the username (eg. `ssh -p @`) or `:` after the ip (eg. `ssh @:`)** +::: 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: @@ -628,7 +698,9 @@ 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. -> **ℹ️ NOTE: You may be wondering why we're creating a separate user account and making it be accessible over SSH only. This is for security reasons, if you do not want to do this, you're free to skip it, but be careful.** +::: 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: @@ -642,9 +714,13 @@ Now we need to give it a password, execute the following command, type the passw sudo passwd mcc ``` -> **ℹ️ NOTE: When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: tip +**When you're typing a password it will not be displayed on the screen, but you're typing it for real.** +::: -> **ℹ️ NOTE: Make sure you have a strong password!** +::: tip +**Make sure you have a strong password!** +::: Now we need to give our user account the admin permissions: @@ -788,7 +864,9 @@ Example: ssh -i MCC_Key mcc@3.71.108.69 ``` -> **ℹ️ NOTE: If you've changed the `Port`, make sure you add a `-p ` option after the `-i ` option (eg. `ssh -i MCC_Key -p 8973 mcc@3.71.108.69`)!** +::: 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. @@ -798,9 +876,13 @@ Now you can install .NET Core 6 and MCC. ### Installing .NET Core 6 -> **ℹ️ NOTE: If your VPS has an ARM CPU, follow [this](#installing-net-on-arm) part of the documentation and then return to section after this one.** +::: 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: 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)** +::: 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. @@ -876,7 +958,9 @@ 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. -> **ℹ️ NOTE: There is also a Docker method, if you're using Docker, you do not need the `screen` program.** +::: 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). @@ -894,7 +978,9 @@ Now you can install the MCC: How to use the `screen` command? -> **⚠️ 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.** +::: 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: @@ -902,9 +988,13 @@ To start a screen, type: screen -S mcc ``` -> **ℹ️ NOTE: `mcc` here is the name of the screen, you can use whatever you like, but if you've used a different name, make sure you use that one instead of the `mcc` in the following commands.** +::: tip +**`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.** +::: -> **ℹ️ NOTE: You need to make a screen only once, however if you reboot your VPS, you need to start it on each reboot.** +::: 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/l10n/vi/guide/usage.md b/docs/l10n/vi/guide/usage.md index cf371ff0..bf5ed32a 100644 --- a/docs/l10n/vi/guide/usage.md +++ b/docs/l10n/vi/guide/usage.md @@ -16,7 +16,9 @@ Using the command line parameters: Simply run `MinecraftClient.exe` -> **ℹ️ NOTE: 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** +::: 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 @@ -89,7 +91,9 @@ MinecraftClient.exe --help ### Quick usage of MCC with examples -> **ℹ️ NOTE: On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: tip +**On Linux and macOS, you need to type: `./MinecraftClient` instead of `MinecraftClient.exe`** +::: ```bash MinecraftClient.exe --help @@ -168,7 +172,9 @@ 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`. -> **ℹ️ NOTE: Some commands may not be documented yet or are defined in description of Chat Bots, use `/help` to list them all, or you can contribute to this page.** +::: 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` @@ -250,7 +256,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Change your selected slot in the hotbar. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -264,9 +271,11 @@ 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: To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** + ::: warning **To use this feature you need to enable the [Terrain and Movements](configuration.md#terrainandmovements)** +::: - > **ℹ️ NOTE: You need a terminal with emoji support, like Powershell 7, Windows Terminal or Alacritty, if you do not want emoji support and want to use cmd or powershell 5, disable emojis with: [`enableemoji`](configuration.md#enableemoji)** + ::: 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:** @@ -308,7 +317,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - **Usage:** @@ -316,7 +326,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /dropitem ``` - > **ℹ️ NOTE: All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** + ::: tip **All item types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs).** +::: - **Example:** @@ -330,7 +341,8 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Entity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -346,7 +358,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /entity ``` - > **ℹ️ NOTE: All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** + ::: tip **All entity types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/EntityType.cs).** +::: - **Examples:** @@ -366,7 +379,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Also the instance of MCC is available with `MCC.`. - > **ℹ️ NOTE: All local variables are treated as strings in the app, when comparing their values, you can use ` == ""`, or better use [`.Equals`](https://www.programiz.com/csharp-programming/library/string/equals) method** + ::: 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:** @@ -444,7 +458,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /reco [account] ``` - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `reload` @@ -452,7 +467,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Reloads settings from MinecraftClient.ini and Chat Bots. - > **ℹ️ NOTE: 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.** + ::: 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:** @@ -472,9 +488,11 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /connect [account] ``` - > **ℹ️ NOTE: `` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** + ::: tip **`` is either a server IP or a server alias defined in servers file, for more info check out [serverlist](configuration.html#serverlist)** +::: - > **ℹ️ NOTE: `[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** + ::: tip **`[account]` is an account alias defined in accounts file, for more info check out [accountlist](configuration.html#accountlist)** +::: ### `script` @@ -610,9 +628,11 @@ 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. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`** +::: - **Usage:** @@ -634,11 +654,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - shulker - loom - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) and [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **ℹ️ NOTE: Not all inventories have a GUI representation in an ASCII art format.** + ::: tip **Not all inventories have a GUI representation in an ASCII art format.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: warning **The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** +::: - **Usage:** @@ -658,9 +681,14 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Make the bot follow a player. - > **ℹ️ NOTE: This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** + ::: tip **This command is avaliable only with [Follow Player](chat-bots.md#follow-player) Chat Bot enabled.** +::: - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** > **ℹ️ NOTE: You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: + + ::: tip **You need to have [Enity Handling](configuration.md#entityhandling) enabled in order for this to work.** +::: - **Usage:** @@ -698,9 +726,11 @@ 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. - > **ℹ️ NOTE: You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** + ::: tip **You need to have [Terrain and Movements](configuration.md#terrainandmovements) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** + ::: warning **The [Terrain and Movements](configuration.md#terrainandmovements) is currently not supported in `1.4.6 - 1.6`.** +::: - **Usage:** @@ -756,15 +786,18 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Used for inventory manipulation. - > **ℹ️ NOTE: You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** + ::: tip **You need to have [Inventory Handling](configuration.md#inventoryhandling) enabled in order for this to work.** +::: - > **⚠️ WARNING: The [Inventory Handling](configuration.md#inventoryhandling) is currently not supported in `1.4.6 - 1.9`.** + ::: 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. - > **ℹ️ NOTE: This command DOES NOT physically open a container (eg. chest), for that you need to use [`useblock`](#useblock) command first.** + ::: 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: @@ -778,7 +811,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [action parameters] | /inventory | /inventory [amount] ``` - > **ℹ️ NOTE: player and container can be simplified with p and c accordingly** + ::: tip **player and container can be simplified with p and c accordingly** +::: Actions: @@ -798,7 +832,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory > [left|right|middle] ``` - > **ℹ️ NOTE: The default click is left click** + ::: tip **The default click is left click** +::: Close an inventory: @@ -812,7 +847,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory drop ``` - > **ℹ️ NOTE: To drop all items from a slot, you can use:** `all` + ::: 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: @@ -820,7 +856,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -890,7 +927,8 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q /inventory creativegive 36 diamondblock 64 ``` - > **ℹ️ NOTE: To find item types, check out [this list](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Inventory/ItemType.cs)** + ::: 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: @@ -916,4 +954,5 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q Show commands help. - > **ℹ️ NOTE: Use "/send /help" for server help** + ::: tip **Use "/send /help" for server help** +::: diff --git a/docs/l10n/zh-Hans/README.md b/docs/l10n/zh-Hans/README.md new file mode 100644 index 00000000..7a2317bf --- /dev/null +++ b/docs/l10n/zh-Hans/README.md @@ -0,0 +1,28 @@ +--- +home: true +heroImage: /images/MCC_logo_with_edge.png +tagline: 'Minecraft Console Client (MCC) is a lightweight open-source Minecraft Java client implemented in C#' +actions: + - + text: 安装 + link: ./guide/installation.md + type: primary + - + text: Learn More → + link: ./guide/ + type: secondary +actionText: +actionLink: +features: + - + title: Chat + details: Chat with other people on the server + - + title: Automation + details: Create bots to do automated tasks + - + title: Supported Versions + details: 1.4 - 1.19.2 +footer: Made by MCC Team with ❤️ +--- + diff --git a/docs/l10n/zh-Hans/guide/README.md b/docs/l10n/zh-Hans/guide/README.md new file mode 100644 index 00000000..ad8dfa61 --- /dev/null +++ b/docs/l10n/zh-Hans/guide/README.md @@ -0,0 +1,163 @@ +# Introduction + +- [About](#about) +- [Quick Intro (YouTube Videos)](#quick-intro) +- [Features](#features) +- [Why Minecraft Console Client?](#why-minecraft-console-client) +- [Getting Help](#getting-help) +- [Submitting a bug report or an idea/feature-request](#bugs-ideas-feature-requests) +- [Important notes on some features](#notes-on-some-features) +- [Credits](#credits) +- [Disclaimer](#disclaimer) +- [License](#license) + +## About + +**Minecraft Console Client (MCC)** is a lightweight cross-platform open-source **Minecraft** TUI client for **Java edition** that allows you to connect to any Minecraft Java server, send commands and receive text messages in a fast and easy way without having to open the main Minecraft game. + +It also provides various automations that you can enable for administration and other purposes, as well as extensible C# API for creating Bots. + +It was originally made by [ORelio](https://github.com/ORelio) in 2012 on the [Minecraft Forum](http://www.minecraftforum.net/topic/1314800-/), now it's maintained by him and many other contributors from the community. + +## Features + +- Chat + + - Send and receive chat messages + - [Log chat history](chat-bots.md#chat-log) + - [Get alerted on certain keywords](chat-bots.md#alerts) + - [Auto Respond](chat-bots.md#auto-respond) + +- [Anti AFK](chat-bots.md#anti-afk) +- [Auto Relog](chat-bots.md#auto-relog) +- [Script Scheduler](chat-bots.md#script-scheduler) +- [Remote Control](chat-bots.md#remote-control) +- [Auto Respond](chat-bots.md#auto-respond) +- [Auto Attack](chat-bots.md#auto-attack) +- [Auto Fishing](chat-bots.md#auto-fishing) +- [Auto Eat](chat-bots.md#auto-eat) +- [Auto Craft](chat-bots.md#auto-craft) +- [Mailer Bot](chat-bots.md#mailer) +- [Auto Drop](chat-bots.md#auto-drop) +- [Replay Mod](chat-bots.md#replay-mod) +- [API for creating Bots in C#](creating-bots.md#creating-chat-bots) +- [Docker Support](installation.md#using-docker) +- [Inventory Handling](usage.md#inventory) +- [Terrain Traversing](usage.md#move) +- Entity Handling + +_NOTE: Some of mentioned features are disabled by default and you will have to turn them on in the configuration file and some may require additional configuration on your part for your specific usage._ + +## Why Minecraft Console Client? + +- Easy to use +- Helpful community +- Open-Source +- Fast performance +- Cross-Platform +- Docker Support +- 10 years of continuous development +- Active contributors +- Widely used + +## Quick Intro + +Don't have time to read through the documentation, we got you, our community has made some simple introduction videos about the **Minecraft Console Client**. + +### The list of the tutorials: + +Installation: + +- [Installation on Windows by Daenges](https://www.youtube.com/watch?v=BkCqOCa2uQw) +- [Installation on Windows + Auto AFK and More by Dexter113](https://www.youtube.com/watch?v=FxJ0KFIHDrY) + +Using Commands, Scripts and other features: + +- [Minecraft Console Client | Tutorial | Commands, Scripts, AppVars, Matches, Tasks and C# Scripts by Daenges](https://youtu.be/JbDpwwETEnU) +- [Console Client Tutorial - Scripting by Zixxter](https://www.youtube.com/watch?v=XE7rYBFJxn0) + +## Getting Help + +MCC has a community that is willing to help, we have a Discussions section in out Git Hub repository. + +Click [here](https://github.com/MCCTeam/Minecraft-Console-Client/discussions) to access it. + +### Before getting help + +- **Please use the search option here or in the discussion section and read the documentation so we avoid duplicate questions. Thank you! Thank you!** +- **Please be kind and patient, respect others as they're the ones using their time to help you** + +## 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)). + +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. + +If you haven't found anything similar, go ahead and click on the `New issue` button, then choose what you want to do. + +If you're reporting a bug, please be descriptive as much as possible, try to explain how to re-create the bug, attack screenshots and logs, make sure that you have [`debugmessages`](configuration.me#debugmessages) set to `true` before sending a bug report or taking a screenshot. + +### Before submitting + +- **Please use the search option here or in the `Issues` section and read the documentation so we avoid duplicate questions/ideas/reports. Thank you! Thank you!** +- **Please be kind, patient and respect others. Thank you! Thank you!** + +## Notes on some features + +### Inventory, Terrain and Entity Handling + +Inventory handling is currently not supported in versions: `1.4.6 - 1.9` + +Terrain handling is currently not supported in versions: `1.4.6 - 1.6` + +Entity handling is currently not supported in versions: `1.4.6 - 1.9` (but `1.8` and `1.9` are being worked on, almost at the working state, only `EntityMetadata` packet remains to be fixed) + +There features might not always be implemented in the latest version of the game, since they're often subjected to major changes by Mojang, and we need some time to figure out what has changed and to implement the required changes. + +If there was a major game update, and the MCC hasn't been updated to support these features, if you're a programmer, feel free to contribute to the project. + +## Credits + +_Project initiated by [ORelio](https://github.com/ORelio) in 2012 on the [Minecraft Forum](http://www.minecraftforum.net/topic/1314800-/)._ + +Many features would not have been possible without the help of our talented community: + +**Maintainers** + +ORelio, ReinforceZwei, milutinke, BruceChenQAQ, bradbyte + +**Ideas** + +ambysdotnet, Awpocalypse, azoundria, bearbear12345, bSun0000, Cat7373, dagonzaros, Dids, Elvang, fuckofftwice, GeorgH93, initsuj, JamieSinn, joshbean39, LehmusFIN, maski, medxo, mobdon, MousePak, TNT-UP, TorchRJ, yayes2, Yoann166, ZizzyDizzyMC and [many more](https://github.com/MCCTeam/Minecraft-Console-Client/issues?q=is%3Aissue+%5BIdea%5D+is%3Aopen). + +**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+). + +**贡献者** + +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)!_ 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 | + +## Disclaimer + +Even if everything should work, we are not responsible for any damage this app could cause to your computer or your server. 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. 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. 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. Use accordingly with server rules. + +## 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) 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. 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/l10n/zh-Hans/guide/chat-bots.md b/docs/l10n/zh-Hans/guide/chat-bots.md new file mode 100644 index 00000000..4fa60570 --- /dev/null +++ b/docs/l10n/zh-Hans/guide/chat-bots.md @@ -0,0 +1,1964 @@ +# Chat Bots + +- [About](#about) +- [List of built-in Chat Bots](#list-of-built-in-chat-bots) +- [Creating your own](creating-bots.md) + +## About + +**Minecraft Console Client** has a number of default built in Chat Bots (Scripts/Plugins) which allow for various types of automation. + +::: 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 +**Settings refer to settings in the [configuration file](configuration.md)** +::: + +## List of built-in Chat Bots + +- [提醒](#alerts) +- [Anti AFK](#anti-afk) +- [Auto Attack](#auto-attack) +- [Auto Craft](#auto-craft) +- [Auto Dig](#auto-dig) +- [Auto Drop](#auto-drop) +- [Auto Eat](#auto-eat) +- [Auto Fishing](#auto-fishing) +- [Auto Relog](#auto-relog) +- [Auto Respond](#auto-respond) +- [Chat Log](#chat-log) +- [Follow Player](#follow-player) +- [Hangman](#hangman) +- [邮差](#mailer) +- [地图](#map) +- [PlayerList Logger](#playerlist-logger) +- [Remote Control](#remote-control) +- [Replay Mod](#replay-mod) +- [Script Scheduler](#script-scheduler) + +## 提醒 + +- **Description:** + + Get alerted when specified words are detected in the chat + + Useful for moderating your server or detecting when someone is talking to you. + +- **Settings:** + + **Section:** **`ChatBot.Alerts`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Alerts Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Beep_Enabled` + + - **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` + + + #### `Trigger_By_Words` + + - **Description:** + + 在收到指定的关键词后触发提醒。 + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Trigger_By_Rain` + + - **Description:** + + 在开始下雨和停止下雨时触发提醒。 + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Trigger_By_Thunderstorm` + + - **Description:** + + 在雷暴天气的开始与结束触发提醒。 + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Log_To_File` + + - **Description:** + + Should the Alerts Chat Bot log alerts into a file. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Log_File` + + - **Description:** + + A path to the file where alerts will be logged if `Log_To_File` is set to `true`. + + - **Type:** `string` + + - **Default:** `"alerts-log.txt"` + + + #### `Matches` + + - **Description:** + + 触发提醒的聊天关键词列表。 + + - **Type:** `array of strings` + + - **Example**: + + ```toml + Matches = [ "Yourname", " whispers ", "-> me", "admin", ".com", ] + ``` + + + #### `Excludes` + + - **Description:** + + 出现这些关键词后该条消息一定不触发提醒。 + + - **Type:** `array of strings` + + - **Example**: + + ```toml + Excludes = [ "myserver.com", "Yourname>:", "Player Yourname", "Yourname joined", "Yourname left", "[Lockette] (Admin)", " Yourname:", "Yourname is", ] + ``` + +## Anti AFK + +- **Description:** + + Send a command and sneak on a regular or random basis or make the bot walk around randomly to avoid automatic AFK disconnection. + +- **Settings:** + + **Section:** **`ChatBot.AntiAFK`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Anti AFK Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **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. 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 = }` + + - **Type:** `inline table with min and max fields which have type of double` + + - **Default:** `{ min = 60.0, max = 60.0 }` + + + #### `Command` + + - **Description:** + + Command to be sent. + + - **Type:** `string` + + - **Default:** `/ping` + + + #### `Use_Sneak` + + - **Description:** + + Sometimes you can trick plugins with sneaking or command might not be enough, enable it if you need it. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Use_Terrain_Handling` + + - **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:** + + The range which bot will use to walk around (-X to +X and -Z to +Z, Y is not used). + + The bigger the slower the bot might be at calculating the path, recommended 2-5. + + - **Default:** `5` + + + #### `Walk_Retries` + + - **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 + +- **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`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Auto Attack Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Mode` + + - **Description:** + + Available values: + + - `single` + + Target one mob per attack. + + - `multi` + + Target all mobs in range per attack. + + - **Type:** `string` + + - **Default:** `single` + + + #### `Priority` + + - **Description:** + + Available values: + + - `health` (prioritize targeting mobs with lower health) + - `distance` (prioritize targeting mobs closer to you) + + - **Type:** `string` + + - **Default:** `distance` + + + #### `Cooldown_Time` + + - **Description:** + + How long to wait between each attack in seconds. + + To enable it, set `Custom` (boolean) to `true` and change `value` (double) to your preferred value (eg. `1.5`). + + By the default, this is disabled and the MCC calculates it based on the server TPS. + + - **Format:** `Cooldown_Time = { Custom = , value = }` + + - **Type:** `inline table` + + - **Example:** `Cooldown_Time = { Custom = true, value = 1.5 }` + + - **Default:** `{ Custom = false, value = 1.0 }` + + + #### `Interaction` + + - **Description:** + + Available values: + + - `Attack` + + Just attack a mob. (Default) (Default) + + - `Interact` + + Just interact with a mob. + + - `InteractAt` + + Interact with and attack a mob. + + - **Type:** `string` + + - **Default:** `Attack` + + + #### `Attack_Hostile` + + - **Description:** + + This setting specifies if the Auto Attack Chat Bot should attack hostile mobs. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `true` + + + #### `Attack_Passive` + + - **Description:** + + This setting specifies if the Auto Attack Chat Bot should attack passive mobs. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `List_Mode` + + - **Description:** + + This setting specifies which mode of the list should Auto Attack Chat Bot use for `Entites_List` setting. + + - **Available values:** `whitelist` (only attack specified mobs) and `blacklist` (do not attack specified mobs). + + - **Type:** `string` + + - **Default:** `whitelist` + + + #### `Entites_List` + + - **Description:** + + A list of mobs which are either whitelisted or blacklisted, the mode is set in `List_Mode` setting. + + You can find the full list of mobs [here](https://bit.ly/3Rg68lp). + + - **Format:** `["", "", ...]` + + - **Type:** `array of strings` + + - **Example:** `[ "Spider", "Skeleton", "Pig", ]` + + - **Default:** `[ "Zombie", "Cow", ]` + +## Auto Craft + +- **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` + + List all loaded recipes. + + - `/autocraft start ` + + Start the crafting process with the given recipe name you had defined. + + - `/autocraft stop` + + Stop the crafting process. + + - `/autocraft help` + + In-game help command. + +- **Settings:** + + **Section:** **`ChatBot.AutoCraft`** + + + #### `Enabled` + + - **Description:** + + This setting specifies if the Auto Craft Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `CraftingTable` + + - **Description:** + + This setting specifies the location of the crafting table. + + - **Type/Format:** + + This setting is an of an `inline table` type that has the following sub-options/settings; + + - `x` - X coordinate, the type is `double` (eg. `123.0`) + + - `y` - Y coordinate, the type is `double` (eg. `64.0`) + + - `z` - Z coordinate, the type is `double` (eg. `456.0`) + + - **Example:** + + ```toml + CraftingTable = { X = 123.0, Y = 65.0, Z = 456.0 } + ``` + + + #### `OnFailure` + + - **Description:** + + This setting specifies what the Auto Craft Chat Bot should do on failure. + + Failure can happen when there are no materials available or when a crafting table can't be reached. + + - **Available values:** `abort` and `wait`. + + - **Type:** `string` + + - **Default:** `abort` + + + ### Defining a recipe + + The recipes are defines as a separate new sub-section `[[ChatBot.AutoCraft.Recipes]]` of the `[ChatBot.AutoCraft]` section. + + The `[[ChatBot.AutoCraft.Recipes]]` section needs to contain the following settings: + + - `Name` + + The name of your recipe, can be whatever you like. + + **Type**: `string` + + - `类型` + + **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. + + **Type:** `string` + + **Example:** `"StoneBricks"` + + - `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"` Empty slots should be marked with `"Null"` + + **Type:** `array of strings` + + **Format:** + + ```toml + 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:** + + **`2x2` (Player)** + + ```cs + ╔═══╦═══╗ + ║ 1 ║ 2 ║ + ╠═══╬═══╣ + ║ 3 ║ 4 ║ + ╚═══╩═══╝ + ``` + + **`3x3` (Crafting Table)** + + ```cs + ╔═══╦═══╦═══╗ + ║ 1 ║ 2 ║ 3 ║ + ╠═══╬═══╬═══╣ + ║ 4 ║ 5 ║ 6 ║ + ╠═══╬═══╬═══╣ + ║ 7 ║ 8 ║ 9 ║ + ╚═══╩═══╩═══╝ + ``` + + **Full Examples:** + + ```toml + # Stone Bricks using the player inventory + [[ChatBot.AutoCraft.Recipes]] + Name = "Recipe-Name-1" + Type = "player" + Result = "StoneBricks" + Slots = [ "Stone", "Stone", "Stone", "Stone", ] + + # Stone Bricks using a crafting table + [[ChatBot.AutoCraft.Recipes]] + Name = "Recipe-Name-2" + Type = "table" + Result = "StoneBricks" + Slots = [ "Stone", "Stone", "Null", "Stone", "Stone", "Null", "Null", "Null", "Null", ] + ``` + + ::: tip **Make sure to provide materials for your bot by placing them in inventory first.** +::: + +## Auto Dig + +- **Description:** + + Automatically digs block on specified locations. + + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) and [terrainandmovements](configuration.md#terrainandmovements) enabled in order for this bot to work.** +::: + + ::: 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:** + + - `/digbot start` - Starts the digging + + - `/digbot stop` - Stops the digging + +- **Settings:** + + **Section:** **`ChatBot.AutoDig`** + + + #### `Enabled` + + - **Description:** + + This setting specifies if the Auto Dig Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Mode` + + - **Description:** + + This setting specifies in which mode the Auto Dig Chat Bot will operate. + + - **Available values:** + + - `lookat` + + Digs the block that the bot is looking at. + + - `fixedpos` + + Digs the block in a fixed location/position/coordinate. + + - `both` + + Dig only when the block you are looking at is in the "Locations" list. + + - **Type:** `string` + + - **Default:** `lookat` + + + #### `Locations` + + - **Description:** + + This setting specifies an array/list of locations which the bot will dig out. + + - **Type/Format:** + + The type of this setting is an array of inline table which has the following sub-options/settings: + + - `x` - X coordinate, the type is `double` (eg. `123.45`) + + - `y` - Y coordinate, the type is `double` (eg. `64.0`) + + - `z` - Z coordinate, the type is `double` (eg. `234.5`) + + - **Full example:** + + ```toml + Locations = [ + { x = 123.5, y = 64.0, z = 234.5 }, + { x = 124.5, y = 63.0, z = 235.5 }, + ] + ``` + + + #### `Location_Order` + + - **Description:** + + This setting specifies in which order the Auto Dig Chat Bot will dig blocks. + + - **Available values:** + + - `distance` + + Digs the block closest to the bot. + + - `index` + + Digs blocks in the list order. + + - **Type:** `string` + + - **Default:** `distance` + + + #### `Auto_Start_Delay` + + - **Description:** + + How many seconds to wait after entering the game to start digging automatically. + + Set to `-1` to disable the automatic start. + + - **Type:** `float` + + - **Default:** `3.0` + + + #### `Dig_Timeout` + + - **Description:** + + If mining a block takes longer than this value, a new attempt will be made to find a block to mine. + + - **Type:** `float` + + - **Default:** `60.0` + + + #### `Log_Block_Dig` + + - **Description:** + + This setting specifies whether to output logs in to the console when digging blocks. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `true` + + + #### `List_Type` + + - **Description:** + + This setting specifies the mode at which the `Blocks` setting is operating. + + - **Available values:** `whitelist` (only dig specified blocks) and `blacklist` (do not dig specified blocks). + + - **Type:** `string` + + - **Default:** `whitelist` + + + #### `Blocks` + + - **Description:** + + This setting specifies the list of blocks which either should not should not be dug out. + + **The list of block types can be found [here](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/Mapping/Material.cs).** + + - **Format:** `[ "", "", ...]` + + - **Type:** `array of strings` + + - **Example:** `Blocks = [ "DiamondOre", "RedstoneOre", "EmeraldOre", "RedstoneBlock" ]` + + - **Default:** `[ "Cobblestone", "Stone", ]` + +## Auto Drop + +- **Description:** + + Automatically drop items you don't need from the inventory. + + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: + +- **Settings:** + + **Section:** **`ChatBot.AutoDrop`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Auto Drop Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Mode` + + - **Description:** + + This setting specifies the mode of the auto dropping. + + Available values: + + - `include` + + This mode will drop any items specified in the list in the `Items` setting. + + - `exclude` + + This mode will drop any other items than specified in the list in the `Items` setting. + + So it would keep the items specified in the list. + + - `everything` + + Drop any item regardless of the items listed in the `Items` setting. + + - **Type:** `string` + + - **Default:** `include` + + + #### `Items` + + - **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:** `[ "", "", ...]` + + - **Type:** `array of strings` + + - **Example:** `[ "Totem", "GlassBottle", ]` + + - **Default:** `[ "Cobblestone", "Dirt", ]` + +## Auto Eat + +- **Description:** + + Automatically eat food when your Hunger value is low. + + ::: tip **You need to have [inventoryhandling](configuration.md#inventoryhandling) enabled in order for this bot to work** +::: + +- **Settings:** + + **Section:** **`ChatBot.AutoEat`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Auto Eat Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Threshold` + + - **Description:** + + Threshold bellow which the bot will auto eat. + + - **Type:** `integer` + + - **Default:** `6` + +## Auto Fishing + +- **Description:** + + Automatically catch fish using a fishing rod. + + ::: tip **You need to have [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: + + ::: tip **To use the automatic rod switching and durability check feature, you need to enable [inventoryhandling](configuration.md#inventoryhandling).** +::: + + ::: tip **Note: To adjust the position or angle after catching a fish, you need to enable [terrainandmovements](configuration.md#terrainandmovements).** +::: + + ::: tip **A fishing rod with **Mending enchantment** is strongly recommended.** +::: + + **Steps for using this bot (with the default setting)** + + 1. Hold a fishing rod and aim towards the sea before login with MCC + 2. Make sure `AutoFish` is `enabled` in config file + 3. Login with MCC + 4. You will be able to see the log "Fishing will start in 3.0 second(s).". + +- **Settings:** + + **Section:** **`ChatBot.AutoFishing`** + + + #### `Enabled` + + - **Description:** + + This setting specifies if the Auto Fishing Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Antidespawn` + + - **Description:** + + This option may be used in some special cases, so if it has not been modified before, leave the default value. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Mainhand` + + - **Description:** + + Whether to use the main hand or off hand to hold the rod. + + - **Available values:** + + - `true` (Main Hand) + - `false` (Off Hand) + + - **Type:** `boolean` + + - **Default:** `true` + + + #### `Auto_Start` + + - **Description:** + + Whether to start fishing automatically after joining the game or switching worlds. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `true` + + + #### `Cast_Delay` + + - **Description:** + + Wait how many seconds after successfully catching a fish before recasting the rod. + + - **Type:** `float` + + - **Default:** `0.4` + + + #### `Fishing_Delay` + + - **Description:** + + Effective only when `auto_start = true`. + + After joining the game or switching worlds, wait how many seconds before starting to fish automatically. + + - **Type:** `float` + + - **Default:** `3.0` + + + #### `Fishing_Timeout` + + - **Description:** + + How long the fish bite is not detected is considered a timeout. It will re-cast after the timeout. It will re-cast after the timeout. + + - **Type:** `float` + + - **Default:** `300.0` + + + #### `Durability_Limit` + + - **Description:** + + Will not use rods with less durability than this (full durability is 64). + + Set to zero to disable this feature. + + **Type/Available values:** An integer number from `0` to `64`. + + - **Default:** `2` + + + #### `Auto_Rod_Switch` + + - **Description:** + + 在当前鱼竿不可用后自动切换到背包中的其他鱼竿。（需要启用库存处理） + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `true` + + + #### `Stationary_Threshold` + + - **Description:** + + For each movement of the fishhook entity (entity movement packet), if the distance on both X and Z axes is below this threshold it will be considered as stationary. + + This is to avoid being detected as a bite during the casting of the hook. + + **If set too high, it will cause the rod to be reeled in while casting.** + + **If set too low, it will result in not detecting a bite.** + + - **Type:** `float` + + - **Default:** `0.001` + + + #### `Hook_Threshold` + + - **Description:** + + For each movement of the fishhook entity (entity movement packet), if it is stationary (check `stationary_threshold`) and its movement on the Y-axis is greater than this threshold, it will be considered to have caught a fish. + + If it is set too high, it will cause normal bites to be ignored. + + If set too low, it can cause small fluctuations in the hook to be recognized as bites. + + - **Type:** `float` + + - **Default:** `0.2` + + + #### `Log_Fish_Bobber` + + - **Description:** + + When turned on it will be print a log every time a fishhook entity movement packet is received. + + If auto-fishing does not work as expected, turn this option on to adjust `stationary_threshold` and `hook_threshold`, or create an issue and attach these logs. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Enable_Move` + + - **Description:** + + Some plugins do not allow the player to fish in one place for a long time. This setting allows the player to change position/angle after each catch. This setting allows the player to change position/angle after each catch. + + Each position is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection, more on that bellow. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + ### Adding a position/movement + + Each position/movement is added as a new `[[ChatBot.AutoFishing.Movements]]` subsection of `[ChatBot.AutoFishing]`. + + **Avaliable settings/options:** + + - `XYZ` + + This setting specifies at location the bot should move to. + + The type of this setting is `inline table`, that has the following sub-settings/options: + + - `x` - X coordinate, the type is `double` (eg. `123.0`) + + - `y` - Y coordinate, the type is `double` (eg. `64.0`) + + - `z` - Z coordinate, the type is `double` (eg. `-654.0`) + + **Example**: + + ```toml + XYZ = { x = 123.0, y = 64.0, z = -654.0 } + ``` + + - `facing` + + This setting specifies at which angle the bot will look at when he arrives to this position/location. + + The type of this setting is `inline table`, that has the following sub-settings/options: + + - `yaw` - The type is `double` (eg. `12.34`) + + - `pitch` - The type is `double` (eg. `-23.45`) + + **Example**: + + ```toml + facing = { yaw = 12.34, pitch = -23.45 } + ``` + + + #### Full example + + ```toml + [[ChatBot.AutoFishing.Movements]] + facing = { yaw = 12.34, pitch = -23.45 } + + [[ChatBot.AutoFishing.Movements]] + XYZ = { x = 123.45, y = 64.0, z = -654.32 } + facing = { yaw = -25.14, pitch = 36.25 } + ``` + +## Auto Relog + +- **Description:** + + Make MCC automatically relog when disconnected by the server, for example because the server is restating. + +- **Settings:** + + **Section:** **`ChatBot.AutoRelog`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Auto Relog Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **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`) The time format is in seconds, and the type is double. (eg. `37.0`) + + - **Format:** `{ min = , max = }` + + - **Type:** `inline table` + + - **Example:** `{ min = 8.0, max = 60.0 }` + + - **Default:** `{ min = 3.0, max = 3.0 }` + + + #### `Retries` + + - **Description:** + + Number of retries. + + Use `-1` for infinite retries. + + ::: tip **This might get you banned by the server owners.** +::: + + - **Default:** `-1` + + + #### `Ignore_Kick_Message` + + - **Description:** + + This settings specifies if the `Kick_Messages` setting will be ignored, if set to `true` it will auto relog regardless of the kick messages. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Kick_Messages` + + - **Description:** + + A list of words which should trigger the Auto Reconnect Chat Bot. + + - **Format:** `[ "", "", ... ]` + + - **Type:** `array of strings` + + - **Default:** `[ "Connection has been lost", "Server is restarting", "Server is full", "Too Many people", ]` + +## Auto Respond + +- **Description:** + + Run commands or send messages automatically when a specified pattern is detected in the chat. + + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `AutoRespond` only if you trust server admins.** +::: + + ::: 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:** + + **Section:** **`ChatBot.AutoRespond`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Auto Respond Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Matches_File` + + - **Description:** + + This setting specifies the path to the file which contains the list of rules for detecting of keywords and responding on them. + + To find out how to configure the rules, take a look at the [`sample-matches.ini`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/sample-matches.ini) which has very detailed examples and a lot of comments. + + _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` + + + #### `Match_Colors` + + - **Description:** + + This setting specifies if the Auto Respond Chat Bot should keep the color formatting send by the server. + + You can use this when you need to match text by colors. + + 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` + +## Chat Log + +- **Description:** + + Make MCC log chat messages into a file. + +- **Settings:** + + **Section:** **`ChatBot.ChatLog`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Chat Log Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Default:** `false` + + + #### `Add_DateTime` + + - **Description:** + + This setting specifies if the Chat Log should prepend timestamps to the logged messages. + + - **Available values:** `true` and `false`. + + - **Default:** `true` + + + #### `Log_File` + + - **Description:** + + This setting specifies the name of the Chat Log file that will be created. + + - **Default:** `chatlog-%username%-%serverip%.txt` + + + #### `Filter` + + - **Description:** + + Type of messages to be logged into the file. + + Available values: + + - `all` + + All text from the console + + - `messages` + + All messages, including system, plugin channel, player and server. + + - `chat` + + Only chat messages. + + - `private` + + Only private messages. + + - `internal` + + Only internal messages and commands. + + - **Default:** `messages` + +## Follow player + +- **Description:** + + This bot enables you to make a bot follow a specific player. + + ::: 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 **You need to have [terrainandmovements](configuration.md#terrainandmovements) and [entityhandling](configuration.md#entityhandling) enabled in order for this bot to work.** +::: + +- **Settings:** + + **Section:** **`ChatBot.FollowPlayer`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Follow Player Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Update_Limit` + + - **Description:** + + The rate at which the bot does calculations (second). + + You can tweak this if you feel the bot is too slow. + + - **Type:** `float` + + - **Default:** `1.5` + + + #### `Stop_At_Distance` + + - **Description:** + + Do not follow the player if he is in the range of `X` blocks (prevents the bot from pushing a player in an infinite loop). + + - **Type:** `float` + + - **Default:** `3.0` + +## Hangman + +- **Description:** + + Hangman game is one of the first bots ever written for MCC, to demonstrate ChatBot capabilities. + + Create a file with words to guess (examples: [`words-en.txt`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/hangman-en.txt), [`words-fr.txt`](https://github.com/MCCTeam/Minecraft-Console-Client/blob/master/MinecraftClient/config/hangman-fr.txt)) and set it in config inside the `[Hangman]` section. + + 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 **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:** + + **Section:** **`ChatBot.HangmanGame`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Hangman Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Default:** `false` + + + #### `简体中文` + + - **Description:** + + This setting specifies if the Hangman Chat Bot should use English. + + - **Available values:** `true` and `false`. + + - **Default:** `true` + + + #### `FileWords_EN` + + - **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` + + - **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) + +## 邮差 + +- **Description:** + + Relay messages between players and servers, like a mail plugin. + + This bot can store messages when the recipients are offline, and send them when they join the server. + + The Mailer bot can store and relay mails much like Essential's `/mail` command. + + - `/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 will automatically deliver the mail when the recipient is online. The bot also offers a /mailer command from the MCC command prompt: + + - `/mailer getmails` + + Show all mails in the console. + + - `/mailer addignored [NAME]` + + Prevent a specific player from sending mails. + + - `/mailer removeignored [NAME]` + + Lift the mailer restriction for this player. + + - `/mailer getignored` + + Show all ignored players. + + ::: 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 **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: + + **Mailer Network:** + + - The Mailer bot can relay messages between servers. + + - To set up a network of two or more bots, launch several instances with the bot activated and the same database. + + - If you launch two instances from one .exe they should synchronize automatically to the same file. + +* **Settings:** + + **Section:** **`ChatBot.Mailer`** + + + #### `Enabled` + + - **Description:** + + This setting specifies if the Mailer Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `DatabaseFile` + + - **Description:** + + This setting specifies the path to the file where the Mailer Chat Bot will store the mails. + + This file will be auto created by the Mailer Chat Bot. + + - **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. 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:** + + This setting specifies if the Mailer Chat Bot should be interacted with in the public chat (in addition to private messages). + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `MaxMailsPerPlayer` + + - **Description:** + + This setting specifies how many mails the Mailer Chat Bot should store per player at maximum. + + - **Type:** `integer` + + - **Default:** `10` + + + #### `MaxDatabaseSize` + + - **Description:** + + This setting specifies the maximum database file size of Mailer Chat Bot in Kilobytes. + + - **Type:** `integer` + + - **Default:** `10000` (10 MB) + + + #### `MailRetentionDays` + + - **Description:** + + This setting specifies how long should the Mailer Chat Bot save/store messages for (in days). + + - **Type:** `integer` + + - **Default:** `30` + +## 地图 + +- **Description:** + + This Chat Bot allows you to render items maps into `.jpg` images. + + This is useful for solving captchas on servers which require it, or saving the map art into an image. + + The maps are **rendered** into `Rendered_Maps` folder. + + ::: 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:** + + When enabled will add the `/maps` command. + + **Usage**: + + ``` + /maps > | maps > + ``` + +- **Settings:** + + **Section:** **`ChatBot.Map`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Map Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Should_Resize` + + - **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` + + - **Default:** `false` + + + #### `Resize_To` + + - **Description:** + + Which size the map should be resized to if `Should_Resize` is `true`. + + - **Type:** `integer` + + - **Default:** `256` + + + #### `Auto_Render_On_Update` + + - **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` + + - **Default:** `false` + + + #### `Delete_All_On_Unload` + + - **Description:** + + This setting specifies if the Map Chat Bot should automatically delete rendered maps when un-loaded or reloaded. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `true` + + + #### `Notify_On_First_Update` + + - **Description:** + + This setting specifies if the Map Chat Bot should notify you when it got a map from the server for the first time. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + +## PlayerList Logger +- **Description:** + + 定期记录当前的玩家列表到文件中。 + +- **Settings:** + + **Section:** **`ChatBot.PlayerListLogger`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the PlayerList Logger Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Default:** `false` + + + #### `File` + + - **Description:** + + This setting specifies the name of the player list Log file that will be created. + + - **Default:** `playerlog.txt` + + + #### `Delay` + + - **Description:** + + Save the list of players every how many seconds. + + - **Type:** `float` + + - **Default:** `60.0` + +## Remote Control + +- **Description:** + + Send MCC console commands to your bot through server PMs (`/tell`). + + You need to have [ChatFormat](configuration.md#chat-format) working correctly and add yourself in [botowners](configuration.md#botowners) to use the bot. + + ::: warning **Server admins can spoof PMs (`/tellraw`, `/nick`) so enable `RemoteControl` only if you trust server admins.** +::: + +- **Settings:** + + **Section:** **`ChatBot.RemoteControl`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Remote Control Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `AutoTpaccept` + + - **Description:** + + This setting specifies if the Remote Control Chat Bot should automatically accept teleport requests. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `true` + + + #### `AutoTpaccept_Everyone` + + - **Description:** + + This setting specifies if the Remote Control Chat Bot should automatically accept teleport requests from everyone. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + +## Replay Capture + +- **Description:** + + Enable recording of the game (`/replay start`) and replay it later using the Replay Mod (https://www.replaymod.com/). + + ::: warning **This bot does not work for 1.19, we need maintainers for it.** +::: + + ::: tip **Please note that due to technical limitations, the client player (you) will not be shown in the replay file** +::: + + ::: warning **You SHOULD use `/replay stop` or exit the program gracefully with `/quit` OR THE REPLAY FILE MAY GET CORRUPT!** +::: + +- **Settings:** + + **Section:** **`ChatBot.ReplayCapture`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Replay Mod Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + #### `Backup_Interval` + + - **Description:** + + This setting specifies the time interval in seconds when the replay file should be auto-saved. + + Use `-1` to disable. + + - **Type:** `float` + + - **Default:** `300.0` + +## Script Scheduler + +- **Description:** + + Schedule commands and scripts to launch on various events such as server join, date/time or time interval. + +- **Settings:** + + **Section:** **`ChatBot.ScriptScheduler`** + + #### `Enabled` + + - **Description:** + + This setting specifies if the Script Scheduler Chat Bot is enabled. + + - **Available values:** `true` and `false`. + + - **Type:** `boolean` + + - **Default:** `false` + + + ### Defining a task + + - **Description:** + + Each task is defined as a new subsection `[[ChatBot.ScriptScheduler.TaskList]]` of the section: `[ChatBot.ScriptScheduler]`. + + **Subsection format:** + + ```toml + [[ChatBot.ScriptScheduler.TaskList]] + = + = + ``` + + ::: 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` + + Will trigger the task when you login the first time. + + **Available values**: `true` and `false` + + **Type**: `boolean` + + - `Trigger_On_Login` + + Will trigger the task each time you login. + + **Available values**: `true` and `false` + + **Type**: `boolean` + + - `Trigger_On_Times` + + This will enable the task to trigger at exact time(s) you want. + + The type of this setting is `inline table`, that has the following sub-settings/options: + + - `Enable` - Enables/Disables the setting (Boolean, so either `true` or `false`) + + - `Times` - An array/list of times on which the task should run/trigger (each element is of the [Local Time](https://toml.io/en/v1.0.0#local-time) type, eg. `14:00:00`, so: `hours:minutes:seconds`) `14:00:00`, so: `hours:minutes:seconds`) + + **Example**: + + ```toml + Trigger_On_Times = { Enable = true, Times = [ 14:00:00, 22:35:8] } + ``` + + - `Trigger_On_Interval` + + This will enable the task to trigger at certain interval which you've defined. + + The type of this setting is `inline table`, that has the following sub-settings/options: + + - `Enable` - Enables/Disables the setting (Boolean, so either `true` or `false`) + + - `MinTime` - Time in seconds (the type is `double`, eg. `3.14`) `3.14`) + + - `MaxTime` - Time in seconds (the type is `double`, eg. `3.14`) `3.14`) + + **If `MinTime` and `MaxTime` are the same, the interval will be consistent, however if they are not, the ChatBot will generate a random interval in between those two numbers provided, each time the task is run.** + + **Example**: + + ```toml + Trigger_On_Interval = { Enable = true, MinTime = 30.0, MaxTime = 160.0 } + ``` + + + ### Full example + + ```toml + [ChatBot.ScriptScheduler] + Enabled = true + + [[ChatBot.ScriptScheduler.TaskList]] + Task_Name = "Task Name 1" + Trigger_On_First_Login = false + Trigger_On_Login = false + Trigger_On_Times = { Enable = true, Times = [ 14:00:00, ] } + Trigger_On_Interval = { Enable = true, MinTime = 3.6, MaxTime = 4.8 } + Action = "send /hello" + + [[ChatBot.ScriptScheduler.TaskList]] + Task_Name = "Task Name 2" + Trigger_On_First_Login = false + Trigger_On_Login = true + Trigger_On_Times = { Enable = false, Times = [ ] } + Trigger_On_Interval = { Enable = false, MinTime = 1.0, MaxTime = 10.0 } + Action = "send /login pass" + ``` diff --git a/docs/l10n/zh-Hans/guide/configuration.md b/docs/l10n/zh-Hans/guide/configuration.md new file mode 100644 index 00000000..80ae27d8 --- /dev/null +++ b/docs/l10n/zh-Hans/guide/configuration.md @@ -0,0 +1,1207 @@ +# 配置 + +**Minecraft Console Client** can be both configured by the [command line parameters](usage.md#command-line-parameters) and the configuration file. + +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 +**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 + +- Some settings will be omitted from the documentation due to them being not used often, we do not want documentation to be cluttered, we advise you to manually read through the configuration file, where every setting has a description next to it. +- Some plugin/bot related settings will be covered in the plugins section, not here + +## Configuration File + +### Format + +The configuration file uses the [TOML format](https://toml.io/en/), all of the options are key-value pairs separated into sections. + +Sections are defined in-between the square brackets (Example: `[This is a section]`), each occurrence of this marks a beginning of a new section. + +The settings/options are defined as key-value pairs, where the name of the setting and the value are separated by the equals sign `=` (Example: `some-setting=some value`). + +Lines starting with `#` are comments, they do not have an effect on the configuration of the program, their purpose is purely a descriptive one. + +**To get familiar with all the data types and styles of settings please read the [official TOML documenation](https://toml.io/en/v1.0.0).** + +Full Example: + +```toml +[SectionNameHere] +Setting_Name = "this is some name" +Setting_Something = 15 + +[OtherSection] +# This is a comment explaining what this setting/option does +Other_Setting = true # This also is a comment + +[ThirdSection] +Section_Enabled = true +colors = [ "red", "yellow", "green" ] + +[ThirdSection.Subsection] +Coordinate = { x = 145, y = 64, y = 2045 } +``` + +## Main Section + +### Main General section + +- **Section header:** `Main.General` + +#### `Account` + +- **Description:** + + This setting is where you need to provide your in-game name (for offline accounts) or email for Microsoft accounts (Mojang accounts do not work anymore) and your password (if using an offline account, use `-` for the password). + +- **Format:** + + `Account = { Login = "", Password = "" }` + +- **Type:** `inline table` + +- **Example:** + + `Account = { Login = "some.random.player@gmail.com", Password = "myEpicPassword123" }` + +#### `Server` + +- **Description:** + + This is the setting where you provide the address of the game server, "Host" can be filled in with domain name or IP address. (The "Port" field can be deleted, it will be resolved automatically) (The "Port" field can be deleted, it will be resolved automatically) + + Host can also fill in the nickname of the server in the "Server List" below. + +- **Format:** `Server = { Host = "", Port = }` + +- **Type:** `inline table` + +- **Example:** + + ``` + Server = { Host = "mysupercoolserver.com" } + ``` + + ``` + Server = { Host = "192.168.1.27", Port = 12345 } + ``` + + ``` + Server = { Host = "ServerAlias1" } + ``` + +#### `AccountType` + +- **Description:** + + This setting is where you define the type of your account: `mojang` or `microsoft` + + ::: tip **Mojang accounts are going to stop working soon for everyone, they already are not working for some people.** +::: + +- **Type:** `string` + +- **Default:** `microsoft` + +- **Example:** + + ``` + AccountType = "microsoft" + ``` + +#### `Method` + +- **Description:** + + This setting is where you define the way you will sign in with your Microsoft account, available options are `mcc` and `browser`. + +- **Type:** `string` + +- **Default:** `mcc` + +- **Example:** + + ``` + Method = "mcc" + ``` + +### Main Advanced section + +- **Section header:** `Main.Advanced` + +#### `Language` + +- **Description:** + + 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. 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. You may choose another language in the configuration file. + + To find your language code, check [this link](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/2239s). + +- **Type:** `string` + +- **Default:** `en_gb` + +- **Example:** + + ``` + Language = "en_gb" + ``` + +#### `ConsoleTitle` + +- **Description:** + + This setting is where you can change the title of the program window if you want to. You can use the variables in it. You can use the variables in it. + +- **Type:** `string` + +- **Default:** `"%username%@%serverip% - Minecraft Console Client"` + +- **Example:** + + ``` + ConsoleTitle = "%username%@%serverip% - Minecraft Console Client" + ``` + +#### `InternalCmdChar` + +- **Description:** + + This setting is where you can change the prefix character of internal MCC commands. + + Available options: + + - `none` + - `slash` + - `backslash` + +- **Type:** `string` + +- **Default:** `slash` + +- **Example:** + + ``` + InternalCmdChar = "slash" + ``` + +#### `MessageCooldown` + +- **Description:** + + This setting is where you can change the minimum delay in seconds between messages to avoid being kicked for spam. + +- **Type:** `float` + +- **Default:** `1.0` + +#### `BotOwners` + +- **Description:** + + This setting is where you can set the owners of the bots/client which can be used by some plugins. The names are separated as strings within an array, separated by commas. The names are separated as strings within an array, separated by commas. + +- **Format:** + + ``` + BotOwners = [ "", "", ... ] + ``` + +- **Type:** `array of strings` + +- **Default:** `[ "Player1", "Player2", ]` + +- **Example:** + + ``` + BotOwners = [ "milutinke", "bradbyte", "BruceChen", ] + ``` + + ::: warning **Admins can impersonate players on versions older than 1.19** +::: + +#### `MinecraftVersion` + +- **Description:** + + This setting is where you can set the version you are playing on. + +- **Format:** `MinecraftVersion = ""` + +- **Type:** `string` + +- **Version format:** `1.X.X` + +- **Type:** `string` + +- **Default:** `auto` + +- **Example:** + + ``` + MinecraftVersion = "1.18.2" + ``` + + ::: tip **MCC supports only 1.4.6 - 1.19.2** +::: + +#### `EnableForge` + +- **Description:** + + This setting is where you can define if you're playing on a forge server. + +- **Type:** `string` + +- **Available options:** + + - `auto` + - `no` + - `force` + +- **Default:** `auto` + + ::: tip **Force-enabling only works for MC 1.13 +** +::: + +#### `BrandInfo` + +- **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`. It can be whatever you like, example: `vanilla`, `mcc`, `empty`. + +- **Type:** `string` + +- **Default:** `mcc` + + ::: tip **For playing on Hypixel you need to use `vanilla`** +::: + +#### `ChatbotLogFile` + +- **Description:** + + This setting is where you can set the path to the file which will contain the logs, leave empty for no log file. + +- **Type:** `string` + +- **Default:** Empty + +- **Example:** + + ``` + ChatbotLogFile = "my-log.txt" + ``` + +#### `PrivateMsgsCmdName` + +- **Description:** + + The name of the command which is used for remote control of the bot. + +- **Type:** `string` + +- **Default:** `tell` + +#### `ShowSystemMessages` + +- **Description:** + + This setting is where you can define if you want to see the system messages (example command block outputs) if you're an OP. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `ShowXPBarMessages` + +- **Description:** + + This setting is where you can define if you want to see the Boss XP Bar messages. + +- **Type:** `boolean` + +- **Default:** `true` + + > **Note: Can create a spam if there is a bunch of withers** + +#### `ShowChatLinks` + +- **Description:** + + This setting is where you can define if you want to decode links embedded in chat messages and show them in console. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `ShowInventoryLayout` + +- **Description:** + + This setting is where you can define if you want to have the MCC show you the inventory in a form of an ASCII art when using the `/inventory` internal command. + + How it looks like: + + ![ASCII Art here](/images/guide/PlayerInventory.png "ASCII Art here") + +- **Type:** `boolean` + +- **Default:** `true` + +#### `TerrainAndMovements` + +- **Description:** + + 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 **This feature is currently not supported in `1.4.6 - 1.6`.** +::: + +- **Type:** `boolean` + +- **Default:** `false` + +::: tip +**Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: + +#### `InventoryHandling` + +- **Description:** + + This setting is where you can set if you want to enable inventory handling using the `/inventory` command. + + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: + +- **Type:** `boolean` + +- **Default:** `false` + +#### `EntityHandling` + +- **Description:** + + This setting is where you can set if you want to enable interactions with entities such as players, mobs, minecarts, etc.. + + ::: warning **This feature is currently not supported in `1.4.6 - 1.9`.** +::: + +- **Type:** `boolean` + +- **Default:** `false` + + ::: tip **Sometimes the latest versions might not support this straight away, since Mojang often makes changes to this.** +::: + +#### `SessionCache` + +- **Description:** + + This setting is where you can define is you want your session info to be stored on the disk or in memory, or not to be stored (this will make you login every time which will add some time to the process). + + You can disable this by using `none`. + + The `disk` option will save your login authorization token on the disk, but this can be a bit of a security risk if someone else has access to your folder where you have MCC installed. + + The `memory` will last until you close down the program. + +- **Type:** `string` + +- **Default:** `disk` + +#### `ProfileKeyCache` + +- **Description:** + + Same as `SessionCache` but for your profile keys which are used for chat signing and validation. + +- **Type:** `string` + +- **Default:** `disk` + +#### `ResolveSrvRecords` + +- **Description:** + + Use `no`, `fast` (5s timeout), or `yes`. Required for joining some servers. Required for joining some servers. + +- **Type:** `string` + +- **Default:** `fast` + +#### `PlayerHeadAsIcon` + +- **Description:** + + This setting allows you to set the icon of the program to be the head of your in-game skin. + +- **Type:** `boolean` + +- **Default:** `true` + + ::: tip **Only works on Windows XP-8 or Windows 10 with old console** +::: + +#### `ExitOnFailure` + +- **Description:** + + This setting allows you to define if your want to disable pauses on error, for using MCC in non-interactive scripts + +- **Type:** `boolean` + +- **Default:** `false` + +#### `CacheScript` + +- **Description:** + + This setting allows you to define if your want to have MCC cache compiled scripts for faster load on low-end devices. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `Timestamps` + +- **Description:** + + This setting allows you to define if your want to have MCC prepend timestamps to chat messages. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `AutoRespawn` + +- **Description:** + + This setting allows you to define if your want to auto respawn if you die. + +- **Type:** `boolean` + +- **Default:** `false` + + ::: tip **Make sure the spawn point is safe** +::: + +#### `MinecraftRealms` + +- **Description:** + + This setting allows you to define if your want to enable support for joining Minecraft Realms. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `MoveHeadWhileWalking` + +- **Description:** + + This setting allows you to define if your want to enable head movement while walking to avoid anti-cheat triggers + +- **Type:** `boolean` + +- **Default:** `true` + +#### `TcpTimeout` + +- **Description:** + + This setting allows you to define a custom timeout period in seconds. Use only if you know what you're doing. Use only if you know what you're doing. + +- **Type:** `integer` + +- **Default:** `30` + +#### `EnableEmoji` + +- **Description:** + + This setting allows you to disable emojis in the [`chunk`](usage.md#chunk) command. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `MovementSpeed` + +- **Description:** + + This setting allows you to change the movement speed of the bot. + +- **Type:** `integer` + +- **Default:** `2` + +::: warning +**A movement speed higher than 2 may be considered cheating by some plugins.** +::: + +### Account List section + +- **Section header:** `Main.Advanced.AccountList` + +- **Description:** + + This section allows you to add multiple accounts so you can switch easily between them on the fly. + +- **Usage examples:** + + `/connect Player1` + +- **Type:** `array of inline tables` + +- **Format:** + + ```toml + = { Login = "", Password = "" } + ``` + +- **Examples:** + + ```toml + Player1 = { Login = "playerone@email.com", Password = "thepassword" } + ``` + +### Server List section + +- **Section header:** `Main.Advanced.ServerList` + +- **Description:** + + This section allows you to add multiple server aliases which enables fast and easy switching between servers. Aliases cannot contain dots or spaces, and the name "localhost" cannot be used as an alias. Aliases cannot contain dots or spaces, and the name "localhost" cannot be used as an alias. + +- **Usage examples:** + + `/connect Server2` + +- **Type:** `array of inline tables` + +- **Format:** + + ```toml + = { Host = "", Port = } + ``` + +- **Examples:** + + ```toml + ServerAlias1 = { Host = "mc.awesomeserver.com" } + ServerAlias2 = { Host = "192.168.1.27", Port = 12345 } + ``` + +### Signature section + +- **Section header:** `Signature` + +- **Description:** + + Affects only Minecraft 1.19+. Affects only Minecraft 1.19+. This section contains settings related to a new chat reporting (signing and verifying) feature introduced by Mojang. + +#### `LoginWithSecureProfile` + +- **Description:** + + Microsoft accounts only. Microsoft accounts only. If disabled, will not be able to sign chat and join servers configured with `enforce-secure-profile=true` + +- **Type:** `boolean` + +- **Default:** `true` + +#### `SignChat` + +- **Description:** + + Whether to sign the chat sent from the MCC. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `SignMessageInCommand` + +- **Description:** + + Whether to sign the messages contained in the commands sent by the MCC. For example, the message in `/msg` and `/me` For example, the message in `/msg` and `/me` + +- **Type:** `boolean` + +- **Default:** `true` + +#### `MarkLegallySignedMsg` + +- **Description:** + + Use green color block to mark chat with legitimate signatures. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `MarkModifiedMsg` + +- **Description:** + + 是否使用黄色色块标识被服务器更改过的聊天。 + +- **Type:** `boolean` + +- **Default:** `true` + +#### `MarkIllegallySignedMsg` + +- **Description:** + + Use red color block to mark chat without legitimate signature. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `MarkSystemMessage` + +- **Description:** + + Use gray color block to mark system message (always without signature). + +- **Type:** `boolean` + +- **Default:** `false` + +#### `ShowModifiedChat` + +- **Description:** + + Set to true to display messages modified by the server, false to display the original signed messages. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `ShowIllegalSignedChat` + +- **Description:** + + Whether to display chat and messages in commands without legal signature. + +- **Type:** `boolean` + +- **Default:** `true` + +### Logging section + +- **Section header:** `Logging` + +#### `DebugMessages` + +- **Description:** + + This setting allows you to define if your want to see debug messages while the client is running, this is useful when there is a bug and you want to report a problem, or if you're developing a script/bot and you want to debug it. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `ChatMessages` + +- **Description:** + + This setting allows you to define if your want to see chat messages. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `InfoMessages` + +- **Description:** + + This setting allows you to define if your want to see info messages. Most of the messages from MCC. Most of the messages from MCC. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `WarningMessages` + +- **Description:** + + This setting allows you to define if your want to see warning messages. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `ErrorMessages` + +- **Description:** + + This setting allows you to define if your want to see error messages. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `ChatFilterRegex` + +- **Description:** + + This setting allows you to define if your want to filter chat messages being logged using a Regex expression. + + More on Regex [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference). + +- **Type:** `string` + +- **Default:** `.*` + + ::: tip **Not filtering anything by default** +::: + +#### `DebugFilterRegex` + +- **Description:** + + This setting allows you to define if your want to filter debug messages being logged using a Regex expression. + + More on Regex [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference). + +- **Type:** `string` + +- **Default:** `.*` + + ::: tip **Not filtering anything by default** +::: + +#### `FilterMode` + +- **Description:** + + Can be `disable`, `blacklist` or `whitelist` + + "disable" will disable the filter, `blacklist` hides the messages, while the `whitelist` shows the messages that match the Regex expression that you've defined. + +- **Type:** `string` + +- **Default:** `disable` + +#### `LogToFile` + +- **Description:** + + This setting allows you to define if your want to log messages to a file. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `LogFile` + +- **Description:** + + This setting allows you to define a path to a file where you want to log messages if you have enabled logging to a file with `LogToFile = true`. + +- **Type:** `string` + +- **Default:** `console-log.txt` + + ::: 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` + +- **Description:** + + This setting allows you to define if your want prepend timestamps to messages that are written to the log file. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `SaveColorCodes` + +- **Description:** + + This setting allows you to define if your want keep the server color codes in the logged messages. + + Example of a color coded message: `§bsome message` + +- **Type:** `boolean` + +- **Default:** `false` + +## App Vars section + +- **Section header:** `AppVar` + +- **Description:** + + This section allows you to define your own custom settings/variables which you can use in scripts, bots or other setting fields. + + To define a variable/setting, simply make a new line with the following format under the `[AppVar.VarStirng]` section: + + ::: tip **`%username%`, `%serverip%`, `%datetime%` are reserved variables** +::: + +- **Section header:** `Logging` + +- **Examples:** + + ``` + your_var = "your_value" + "your var 2" = "your value 2" + ``` + +## Proxy section + +- **Section header:** `Proxy` + +- **Description:** + + Connect to a server via a proxy instead of connecting directly. + +#### `Enabled_Login` + +- **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`. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `Enabled_Ingame` + +- **Description:** + + 是否通过代理连接Minecraft游戏服务器。 + + If connecting to a port 25565 (Minecraft) is blocked on your network, set the value to `true` to login and connect using the proxy. + +- **Type:** `boolean` + +- **Default:** `false` + + ::: warning **Make sure your server rules allow Proxies or VPNs before setting the setting to `true`, or you may face consequences!** +::: + +#### `Server` + +- **Description:** + + The proxy server IP and port. The proxy server IP and port. Proxy server must allow HTTPS for login, and non-443 ports for playing. + +- **Format:** + + ``` + Server = { Host = "", Port = } + ``` + +- **Default:** `{ Host = "0.0.0.0", Port = 8080 }` + +#### `Proxy_Type` + +- **Description:** + + The type of your proxy. + + Available options: + + - `HTTPT` + - `SOCKS4` + - `SOCKS4a` + - `SOCKS5` + +- **Type:** `string` + +- **Default:** `HTTPT` + +#### `Username` + +- **Description:** + + The proxy account username. + + Only needed for password protected proxies. + +- **Default:** `` + +#### `Password` + +- **Description:** + + The proxy account password. + + Only needed for password protected proxies. + +- **Default:** `` + +## MCSettings section + +- **Section header:** `MCSettings` + +- **Description:** + + Client settings related to language, render distance, difficulty, chat and skins. + +#### `Enabled` + +- **Description:** + + This setting allows you to specify if you want to use settings from this section. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `Locale` + +- **Description:** + + Use any language implemented in Minecraft + +- **Type:** `string` + +- **Default:** `en_US` + +#### `RenderDistance` + +- **Description:** + + Render distance in chunks: `0 - 255` + +- **Type:** `integer` + +- **Default:** `8` + +#### `Difficulty` + +- **Description:** + + Available options: + + - `peaceful` + - `easy` + - `normal` + - `difficult` + +- **Type:** `string` + +- **Default:** `normal` + +#### `ChatMode` + +- **Description:** + + This setting allows you to effectively mute yourself. + + Available options: + + - `enabled` (You can chat) + - `commands` (You can only do commands) + - `disabled` + +- **Type:** `string` + +- **Default:** `enabled` + +#### `ChatColors` + +- **Description:** + + This setting allows you to disable chat colors. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `MainHand` + +- **Description:** + + This setting allows you to specify your main hand. + +- **Available values:** `right` and `left` + +- **Type:** `string` + +- **Default:** `left` + +## MCSettings Skin section + +- **Section header:** `MCSettings.Skin` + +- **Description:** + + Skin options. + +#### `Cape` + +- **Description:** + + This setting allows you to specify if you want to have your skin cape shown. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `Hat` + +- **Description:** + + This setting allows you to specify if you want to have your skin hat shown. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `Jacket` + +- **Description:** + + This setting allows you to specify if you want to have your skin jacket shown. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `Sleeve_Left` + +- **Description:** + + This setting allows you to specify if you want to have your left sleeve shown. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `Sleeve_Right` + +- **Description:** + + This setting allows you to specify if you want to have your right sleeve shown. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `Pants_Left` + +- **Description:** + + This setting allows you to specify if you want to have your left part of the pants shown. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `Pants_Right` + +- **Description:** + + This setting allows you to specify if you want to have your right part of the pants shown. + +- **Type:** `boolean` + +- **Default:** `false` + +## Chat Format section + +- **Section header:** `ChatFormat` + +- **Description:** + + The MCC does it best to detect chat messages, but some server have unusual chat formats. + + When this happens, you'll need to configure the chat format yourself using settings from this section. + + The MCC uses Regular Expressions (Regex) to detect the chat formatting, in case that you're not familiar with Regex you can use the following resources to learn it and test it out: + + - Crash courses: + - [Regex video tutorial by Web Dev Simplified](https://www.youtube.com/watch?v=rhzKDrUiJVk) + - [Regex on paper by Crack Concepts](https://www.youtube.com/watch?v=9RksQ5YT7FM) + - In-depth tutorials: + + - [Quite a long and detailed tutorial by Svetlin Nakov](https://www.youtube.com/watch?v=DS9IO0W7-0Q) + - [Microsoft Documentation on Regex](https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference) + + - Testing Regex expressions online: + - [https://regex101.com/](https://regex101.com/) + - [https://regexr.com/](https://regexr.com/) + +#### `Builtins` + +- **Description:** + + This setting allows you to define if your want use the default chat formats. + + Set to `false` to avoid conflicts with custom formats. + +- **Type:** `boolean` + +- **Default:** `true` + +#### `UserDefined` + +- **Description:** + + This setting allows you to define if your want to use the custom chat formats defined bellow using Regex. + + Set to `true` to use the custom formats defined in `Public`, `Private` and `TeleportRequest`. + +- **Type:** `boolean` + +- **Default:** `false` + +#### `Public` + +- **Description:** + + This setting allows you to specify a custom chat message format using Regex (Regular expressions). + + More on Regex [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference). + + Only works when `Builtins` is set to `false`. + +- **Type:** `string` + +- **Default:** `Public = "^<([a-zA-Z0-9_]+)> (.+)$"` + +#### `Private` + +- **Description:** + + This setting allows you to specify a custom chat message format for private messages using Regex (Regular expressions). + + More on Regex [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference). + + Only works when `Builtins` is set to `false`. + +- **Type:** `string` + +- **Default:** `Private = "^([a-zA-Z0-9_]+) whispers to you: (.+)$"` + +#### `TeleportRequest` + +- **Description:** + + This setting allows you to specify a custom chat message format for a Teleport request using Regex (Regular expressions). + + More on Regex [here](https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference). + + Only works when `Builtins` is set to `false`. + +- **Type:** `string` + +- **Default:** `TeleportRequest = '^([a-zA-Z0-9_]+) has requested (?:to|that you) teleport to (?:you|them)\.$'` diff --git a/docs/l10n/zh-Hans/guide/contibuting.md b/docs/l10n/zh-Hans/guide/contibuting.md new file mode 100644 index 00000000..3b31f11c --- /dev/null +++ b/docs/l10n/zh-Hans/guide/contibuting.md @@ -0,0 +1,76 @@ +# Contributing + +At this moment this page needs to be created. + +For now you can use our article from the [Git Hub repository Wiki](https://github.com/MCCTeam/Minecraft-Console-Client/wiki/Update-console-client-to-new-version) written by [ReinforceZwei](https://github.com/ReinforceZwei). + +## Translations + +MCC 现在支持这些语言（按字母顺序排列）： + * `de.ini` : Deutsch - German + * **`en.ini`: English - English** + * `fr.ini` : Français (France) - French + * `ru.ini` : Русский (Russkiy) - Russian + * `vi.ini` : Tiếng Việt (Việt Nam) - Vietnamese + * `zh-Hans.ini` : 简体中文 - Chinese Simplified + * `zh-Hant.ini` : 繁體中文 - Chinese Traditional + +### Add new translation + +1. First you need to get the name of the translated file. + * Visit [this link](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c) and find the first occurrence of the language you need to translate in the table below. + * Use the language code of the row in the table as the name of the translation file. + * For example: + * `English` -> row `English 0x0009` -> `en` -> `en.ini` + * `Chinese (Traditional)` -> row `Chinese (Traditional) 0x7C04` -> `zh-Hant` -> `zh-Hant.ini` + +2. Which system languages are recommended to use this translation? + * Still check the table in [this link](https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c), one language may have multiple rows. + * You will need to indicate which language codes this translation applies to. + * For example: + * Translation `de.ini` applies to `de`, `de-AT`, `de-BE`, `de-DE`, ... + * Translation `zh-Hans.ini` applies to `zh-Hans`, `zh`, `zh-CN`, `zh-SG`. + +3. Which game languages are recommended to use this translation? + * Check out the table in [this link](https://github.com/MCCTeam/Minecraft-Console-Client/discussions/2239), where the `Locale Code` column indicates the language code in minecraft. + * You will need to indicate which locale codes this translation applies to. + * For example: + * Translation `fr.ini` applies to `fr_ca`, `fr_fr`. + * Translation `zh-Hans.ini` applies to `zh_cn`. + +4. Add the new translation to the code. (Optional) (Optional) + * **If you are not familiar with programming, you can skip this step and just write the above information in your PR or issue.** + * Add the newly created translation file `xx.ini` to the project `/Resources/lang/xx.ini`. + * Open `/DefaultConfigResource.resx`. + * Click `Add Resources`. + * Choose `/Resources/lang/xx.ini`. + * Rename the added resource file in `/DefaultConfigResource.resx` to `Translation_xx`. + * Open `/Translations.cs`. + * Find `public static Tuple GetTranslationPriority();` + * Update the mapping of system language codes to translation files. + * Find `public static string[] GetTranslationPriority(string gameLanguage);` + * Update the mapping of game locale code to translation files. + +5. Follow the section "Update existing translation". + +### Update existing translation + +1. Visit [the lang folder](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/Resources/lang), download `en.ini` and the language you want to translate(`xx.ini`). + +2. Compare `en.ini` and `xx.ini` and update outdated or non-existent entries in `xx.ini`. + +3. Once you finished the translation work, submit a pull request or send us the file through an [Issue](https://github.com/MCCTeam/Minecraft-Console-Client/issues) in case you are not familiar with Git. + +### Translate README.md + +1. Get the English version of the README.md from [here](https://raw.githubusercontent.com/MCCTeam/Minecraft-Console-Client/master/README.md). + +2. See `Add new translation -> 1.` for the target language code. Assume it is `xx`. Assume it is `xx`. + +3. Complete the translation according to the English README.md and name the translated version as `README-xx.md`. + +4. In the English README, above the "About" section, add the name of the language and a hyperlink to `README-xx.md`. + +## 贡献者 + +[Check out our contributors on Github](https://github.com/MCCTeam/Minecraft-Console-Client/graphs/contributors). diff --git a/docs/l10n/zh-Hans/guide/creating-bots.md b/docs/l10n/zh-Hans/guide/creating-bots.md new file mode 100644 index 00000000..5f0d529c --- /dev/null +++ b/docs/l10n/zh-Hans/guide/creating-bots.md @@ -0,0 +1,205 @@ +# Creating Chat Bots + +- [Notes](#notes) +- [Requirements](#requirements) +- [Quick Introduction](#quick-introduction) +- [Examples](#examples) +- [C# API](#c#-api) + +## Notes + +::: 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. ℹ️ NOTE: 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. 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. + +## Requirements + +- A basic knowledge of C# programming language +- A text editor + +If you're not familiar with the C# programming language, we suggest taking a look at the following resources: + +Crash courses: + +- [C# Crash Course playlist by Teddy Smit](https://www.youtube.com/watch?v=67oWw9TanOk&list=PL82C6-O4XrHfoN_Y4MwGvJz5BntiL0z0D) + +More in-depth: + +- [Learn C# Youtube Playlist by Microsoft](https://www.youtube.com/playlist?list=PLdo4fOcmZ0oVxKLQCHpiUWun7vlJJvUiN) +- [Getting started with C# (An index of tutorials and the documentation) by Microsoft](https://docs.microsoft.com/en-us/dotnet/csharp/) + +## Quick Introduction + +This introduction assumes that you have the basic knowledge of C#. + +::: 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. + +Paste the following example code: + +```csharp +//MCCScript 1.0 + +MCC.LoadBot(new ExampleChatBot()); + +//MCCScript Extensions + +// The code and comments above are defining a "Script Metadata" section + +// Every single chat bot (script) must be a class which extends the ChatBot class. +// Your class must be instantiates in the "Script Metadata" section and passed to MCC.LoadBot function. +class ExampleChatBot : ChatBot +{ + // This method will be called when the script has been initialized for the first time, it's called only once + // Here you can initialize variables, eg. Dictionaries. etc... + public override void Initialize() + { + LogToConsole("An example Chat Bot has been initialized!"); + } + + // This is a function that will be run when we get a chat message from a server + // In this example it just detects the type of the message and prints it out + public override void GetText(string text) + { + string message = ""; + string username = ""; + text = GetVerbatim(text); + + if (IsPrivateMessage(text, ref message, ref username)) + { + LogToConsole(username + " has sent you a private message: " + message); + } + else if (IsChatMessage(text, ref message, ref username)) + { + LogToConsole(username + " has said: " + message); + } + } +} +// Your class must be instantiates in the "Script Metadata" section and passed to MCC.LoadBot function. +class ExampleChatBot : ChatBot +{ + // This method will be called when the script has been initialized for the first time, it's called only once + // Here you can initialize variables, eg. Dictionaries. etc... + public override void Initialize() + { + LogToConsole("An example Chat Bot has been initialized!"); + } + + // This is a function that will be run when we get a chat message from a server + // In this example it just detects the type of the message and prints it out + public override void GetText(string text) + { + string message = ""; + string username = ""; + text = GetVerbatim(text); + + if (IsPrivateMessage(text, ref message, ref username)) + { + LogToConsole(username + " has sent you a private message: " + message); + } + else if (IsChatMessage(text, ref message, ref username)) + { + LogToConsole(username + " has said: " + message); + } + } +} +``` + +Start MCC, connect to a server and run the following internal command: `/script ExampleChatBot.cs`. + +If you did everything right you should see: `[Example Chat Bot] An example Chat Bot has been initialised!` message appear in your console log. + +### Structure of Chat Bots + +Chat Bot (Script) structure is the following: + +``` +