From 3570ef605e1f7a4cb9e340ee0183582e4c49a8f0 Mon Sep 17 00:00:00 2001 From: ReinforceZwei <39955851+ReinforceZwei@users.noreply.github.com> Date: Tue, 25 Apr 2023 17:02:45 +0800 Subject: [PATCH] [skip ci] Update document (#2468) * Update execif document * Update installation guide * Add simple script page * Add text script page to sidebar --- docs/.vuepress/configs/l10n_configs/af.ts | 1 + docs/.vuepress/configs/l10n_configs/ar.ts | 1 + docs/.vuepress/configs/l10n_configs/ca.ts | 1 + .../configs/l10n_configs/config_templete.ts | 1 + docs/.vuepress/configs/l10n_configs/cs.ts | 1 + docs/.vuepress/configs/l10n_configs/da.ts | 1 + docs/.vuepress/configs/l10n_configs/de.ts | 1 + docs/.vuepress/configs/l10n_configs/el.ts | 1 + docs/.vuepress/configs/l10n_configs/en.ts | 1 + docs/.vuepress/configs/l10n_configs/es.ts | 1 + docs/.vuepress/configs/l10n_configs/fi.ts | 1 + docs/.vuepress/configs/l10n_configs/fr.ts | 1 + docs/.vuepress/configs/l10n_configs/he.ts | 1 + docs/.vuepress/configs/l10n_configs/hu.ts | 1 + docs/.vuepress/configs/l10n_configs/it.ts | 1 + docs/.vuepress/configs/l10n_configs/ja.ts | 1 + docs/.vuepress/configs/l10n_configs/ko.ts | 1 + docs/.vuepress/configs/l10n_configs/lv.ts | 1 + docs/.vuepress/configs/l10n_configs/nl.ts | 1 + docs/.vuepress/configs/l10n_configs/no.ts | 1 + docs/.vuepress/configs/l10n_configs/pl.ts | 1 + docs/.vuepress/configs/l10n_configs/pt-BR.ts | 1 + docs/.vuepress/configs/l10n_configs/pt.ts | 1 + docs/.vuepress/configs/l10n_configs/ro.ts | 1 + docs/.vuepress/configs/l10n_configs/ru.ts | 1 + .../.vuepress/configs/l10n_configs/sr-Cyrl.ts | 1 + docs/.vuepress/configs/l10n_configs/sv.ts | 1 + docs/.vuepress/configs/l10n_configs/tr.ts | 1 + docs/.vuepress/configs/l10n_configs/uk.ts | 1 + docs/.vuepress/configs/l10n_configs/vi.ts | 1 + .../.vuepress/configs/l10n_configs/zh-Hans.ts | 1 + .../.vuepress/configs/l10n_configs/zh-Hant.ts | 1 + docs/guide/creating-text-script.md | 26 +++++++++++++++ docs/guide/installation.md | 32 ++++++------------- docs/guide/usage.md | 20 ++++++++---- 35 files changed, 82 insertions(+), 28 deletions(-) create mode 100644 docs/guide/creating-text-script.md diff --git a/docs/.vuepress/configs/l10n_configs/af.ts b/docs/.vuepress/configs/l10n_configs/af.ts index 345e3ab9..b956e7f8 100644 --- a/docs/.vuepress/configs/l10n_configs/af.ts +++ b/docs/.vuepress/configs/l10n_configs/af.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_af: DefaultThemeLocaleData = { "/l10n/af/guide/installation.md", "/l10n/af/guide/usage.md", "/l10n/af/guide/configuration.md", + "/l10n/af/guide/creating-text-script.md", "/l10n/af/guide/chat-bots.md", "/l10n/af/guide/creating-bots.md", "/l10n/af/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/ar.ts b/docs/.vuepress/configs/l10n_configs/ar.ts index 65fc849f..a91a460f 100644 --- a/docs/.vuepress/configs/l10n_configs/ar.ts +++ b/docs/.vuepress/configs/l10n_configs/ar.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_ar: DefaultThemeLocaleData = { "/l10n/ar/guide/installation.md", "/l10n/ar/guide/usage.md", "/l10n/ar/guide/configuration.md", + "/l10n/ar/guide/creating-text-script.md", "/l10n/ar/guide/chat-bots.md", "/l10n/ar/guide/creating-bots.md", "/l10n/ar/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/ca.ts b/docs/.vuepress/configs/l10n_configs/ca.ts index caced00c..1ca77152 100644 --- a/docs/.vuepress/configs/l10n_configs/ca.ts +++ b/docs/.vuepress/configs/l10n_configs/ca.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_ca: DefaultThemeLocaleData = { "/l10n/ca/guide/installation.md", "/l10n/ca/guide/usage.md", "/l10n/ca/guide/configuration.md", + "/l10n/ca/guide/creating-text-script.md", "/l10n/ca/guide/chat-bots.md", "/l10n/ca/guide/creating-bots.md", "/l10n/ca/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/config_templete.ts b/docs/.vuepress/configs/l10n_configs/config_templete.ts index 67425741..3b0568ba 100644 --- a/docs/.vuepress/configs/l10n_configs/config_templete.ts +++ b/docs/.vuepress/configs/l10n_configs/config_templete.ts @@ -58,6 +58,7 @@ export const defaultThemeConfig_$LanguageCodeEscaped$: DefaultThemeLocaleData = "$PathToPage$/guide/installation.md", "$PathToPage$/guide/usage.md", "$PathToPage$/guide/configuration.md", + "$PathToPage$/guide/creating-text-script.md", "$PathToPage$/guide/chat-bots.md", "$PathToPage$/guide/creating-bots.md", "$PathToPage$/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/cs.ts b/docs/.vuepress/configs/l10n_configs/cs.ts index 09348dc1..bb45f7de 100644 --- a/docs/.vuepress/configs/l10n_configs/cs.ts +++ b/docs/.vuepress/configs/l10n_configs/cs.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_cs: DefaultThemeLocaleData = { "/l10n/cs/guide/installation.md", "/l10n/cs/guide/usage.md", "/l10n/cs/guide/configuration.md", + "/l10n/cs/guide/creating-text-script.md", "/l10n/cs/guide/chat-bots.md", "/l10n/cs/guide/creating-bots.md", "/l10n/cs/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/da.ts b/docs/.vuepress/configs/l10n_configs/da.ts index 135b5546..4771c49e 100644 --- a/docs/.vuepress/configs/l10n_configs/da.ts +++ b/docs/.vuepress/configs/l10n_configs/da.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_da: DefaultThemeLocaleData = { "/l10n/da/guide/installation.md", "/l10n/da/guide/usage.md", "/l10n/da/guide/configuration.md", + "/l10n/da/guide/creating-text-script.md", "/l10n/da/guide/chat-bots.md", "/l10n/da/guide/creating-bots.md", "/l10n/da/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/de.ts b/docs/.vuepress/configs/l10n_configs/de.ts index 4f6e77b8..509be3aa 100644 --- a/docs/.vuepress/configs/l10n_configs/de.ts +++ b/docs/.vuepress/configs/l10n_configs/de.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_de: DefaultThemeLocaleData = { "/l10n/de/guide/installation.md", "/l10n/de/guide/usage.md", "/l10n/de/guide/configuration.md", + "/l10n/de/guide/creating-text-script.md", "/l10n/de/guide/chat-bots.md", "/l10n/de/guide/creating-bots.md", "/l10n/de/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/el.ts b/docs/.vuepress/configs/l10n_configs/el.ts index 5aab0be5..95f1a97b 100644 --- a/docs/.vuepress/configs/l10n_configs/el.ts +++ b/docs/.vuepress/configs/l10n_configs/el.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_el: DefaultThemeLocaleData = { "/l10n/el/guide/installation.md", "/l10n/el/guide/usage.md", "/l10n/el/guide/configuration.md", + "/l10n/el/guide/creating-text-script.md", "/l10n/el/guide/chat-bots.md", "/l10n/el/guide/creating-bots.md", "/l10n/el/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/en.ts b/docs/.vuepress/configs/l10n_configs/en.ts index e954f294..fa0c6533 100644 --- a/docs/.vuepress/configs/l10n_configs/en.ts +++ b/docs/.vuepress/configs/l10n_configs/en.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_en: DefaultThemeLocaleData = { "/guide/installation.md", "/guide/usage.md", "/guide/configuration.md", + "/guide/creating-text-script.md", "/guide/chat-bots.md", "/guide/creating-bots.md", "/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/es.ts b/docs/.vuepress/configs/l10n_configs/es.ts index 2b8ce2d3..81c88e3c 100644 --- a/docs/.vuepress/configs/l10n_configs/es.ts +++ b/docs/.vuepress/configs/l10n_configs/es.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_es: DefaultThemeLocaleData = { "/l10n/es/guide/installation.md", "/l10n/es/guide/usage.md", "/l10n/es/guide/configuration.md", + "/l10n/es/guide/creating-text-script.md", "/l10n/es/guide/chat-bots.md", "/l10n/es/guide/creating-bots.md", "/l10n/es/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/fi.ts b/docs/.vuepress/configs/l10n_configs/fi.ts index fe96b55a..6494cf75 100644 --- a/docs/.vuepress/configs/l10n_configs/fi.ts +++ b/docs/.vuepress/configs/l10n_configs/fi.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_fi: DefaultThemeLocaleData = { "/l10n/fi/guide/installation.md", "/l10n/fi/guide/usage.md", "/l10n/fi/guide/configuration.md", + "/l10n/fi/guide/creating-text-script.md", "/l10n/fi/guide/chat-bots.md", "/l10n/fi/guide/creating-bots.md", "/l10n/fi/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/fr.ts b/docs/.vuepress/configs/l10n_configs/fr.ts index fe116005..d73eab9e 100644 --- a/docs/.vuepress/configs/l10n_configs/fr.ts +++ b/docs/.vuepress/configs/l10n_configs/fr.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_fr: DefaultThemeLocaleData = { "/l10n/fr/guide/installation.md", "/l10n/fr/guide/usage.md", "/l10n/fr/guide/configuration.md", + "/l10n/fr/guide/creating-text-script.md", "/l10n/fr/guide/chat-bots.md", "/l10n/fr/guide/creating-bots.md", "/l10n/fr/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/he.ts b/docs/.vuepress/configs/l10n_configs/he.ts index 6eae715a..80253c88 100644 --- a/docs/.vuepress/configs/l10n_configs/he.ts +++ b/docs/.vuepress/configs/l10n_configs/he.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_he: DefaultThemeLocaleData = { "/l10n/he/guide/installation.md", "/l10n/he/guide/usage.md", "/l10n/he/guide/configuration.md", + "/l10n/he/guide/creating-text-script.md", "/l10n/he/guide/chat-bots.md", "/l10n/he/guide/creating-bots.md", "/l10n/he/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/hu.ts b/docs/.vuepress/configs/l10n_configs/hu.ts index d7344c59..43c6fde5 100644 --- a/docs/.vuepress/configs/l10n_configs/hu.ts +++ b/docs/.vuepress/configs/l10n_configs/hu.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_hu: DefaultThemeLocaleData = { "/l10n/hu/guide/installation.md", "/l10n/hu/guide/usage.md", "/l10n/hu/guide/configuration.md", + "/l10n/hu/guide/creating-text-script.md", "/l10n/hu/guide/chat-bots.md", "/l10n/hu/guide/creating-bots.md", "/l10n/hu/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/it.ts b/docs/.vuepress/configs/l10n_configs/it.ts index 33c0f52d..42a03629 100644 --- a/docs/.vuepress/configs/l10n_configs/it.ts +++ b/docs/.vuepress/configs/l10n_configs/it.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_it: DefaultThemeLocaleData = { "/l10n/it/guide/installation.md", "/l10n/it/guide/usage.md", "/l10n/it/guide/configuration.md", + "/l10n/it/guide/creating-text-script.md", "/l10n/it/guide/chat-bots.md", "/l10n/it/guide/creating-bots.md", "/l10n/it/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/ja.ts b/docs/.vuepress/configs/l10n_configs/ja.ts index 89771638..5b5f4970 100644 --- a/docs/.vuepress/configs/l10n_configs/ja.ts +++ b/docs/.vuepress/configs/l10n_configs/ja.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_ja: DefaultThemeLocaleData = { "/l10n/ja/guide/installation.md", "/l10n/ja/guide/usage.md", "/l10n/ja/guide/configuration.md", + "/l10n/ja/guide/creating-text-script.md", "/l10n/ja/guide/chat-bots.md", "/l10n/ja/guide/creating-bots.md", "/l10n/ja/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/ko.ts b/docs/.vuepress/configs/l10n_configs/ko.ts index e7281842..2b2b0618 100644 --- a/docs/.vuepress/configs/l10n_configs/ko.ts +++ b/docs/.vuepress/configs/l10n_configs/ko.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_ko: DefaultThemeLocaleData = { "/l10n/ko/guide/installation.md", "/l10n/ko/guide/usage.md", "/l10n/ko/guide/configuration.md", + "/l10n/ko/guide/creating-text-script.md", "/l10n/ko/guide/chat-bots.md", "/l10n/ko/guide/creating-bots.md", "/l10n/ko/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/lv.ts b/docs/.vuepress/configs/l10n_configs/lv.ts index 20fde552..dbb74316 100644 --- a/docs/.vuepress/configs/l10n_configs/lv.ts +++ b/docs/.vuepress/configs/l10n_configs/lv.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_lv: DefaultThemeLocaleData = { "/l10n/lv/guide/installation.md", "/l10n/lv/guide/usage.md", "/l10n/lv/guide/configuration.md", + "/l10n/lv/guide/creating-text-script.md", "/l10n/lv/guide/chat-bots.md", "/l10n/lv/guide/creating-bots.md", "/l10n/lv/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/nl.ts b/docs/.vuepress/configs/l10n_configs/nl.ts index 8cb9f41c..992371c5 100644 --- a/docs/.vuepress/configs/l10n_configs/nl.ts +++ b/docs/.vuepress/configs/l10n_configs/nl.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_nl: DefaultThemeLocaleData = { "/l10n/nl/guide/installation.md", "/l10n/nl/guide/usage.md", "/l10n/nl/guide/configuration.md", + "/l10n/nl/guide/creating-text-script.md", "/l10n/nl/guide/chat-bots.md", "/l10n/nl/guide/creating-bots.md", "/l10n/nl/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/no.ts b/docs/.vuepress/configs/l10n_configs/no.ts index cbbe0a0d..d223eac1 100644 --- a/docs/.vuepress/configs/l10n_configs/no.ts +++ b/docs/.vuepress/configs/l10n_configs/no.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_no: DefaultThemeLocaleData = { "/l10n/no/guide/installation.md", "/l10n/no/guide/usage.md", "/l10n/no/guide/configuration.md", + "/l10n/no/guide/creating-text-script.md", "/l10n/no/guide/chat-bots.md", "/l10n/no/guide/creating-bots.md", "/l10n/no/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/pl.ts b/docs/.vuepress/configs/l10n_configs/pl.ts index 89365259..70b06e98 100644 --- a/docs/.vuepress/configs/l10n_configs/pl.ts +++ b/docs/.vuepress/configs/l10n_configs/pl.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_pl: DefaultThemeLocaleData = { "/l10n/pl/guide/installation.md", "/l10n/pl/guide/usage.md", "/l10n/pl/guide/configuration.md", + "/l10n/pl/guide/creating-text-script.md", "/l10n/pl/guide/chat-bots.md", "/l10n/pl/guide/creating-bots.md", "/l10n/pl/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/pt-BR.ts b/docs/.vuepress/configs/l10n_configs/pt-BR.ts index 5e4b95ab..3601fff0 100644 --- a/docs/.vuepress/configs/l10n_configs/pt-BR.ts +++ b/docs/.vuepress/configs/l10n_configs/pt-BR.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_pt_BR: DefaultThemeLocaleData = { "/l10n/pt-BR/guide/installation.md", "/l10n/pt-BR/guide/usage.md", "/l10n/pt-BR/guide/configuration.md", + "/l10n/pt-BR/guide/creating-text-script.md", "/l10n/pt-BR/guide/chat-bots.md", "/l10n/pt-BR/guide/creating-bots.md", "/l10n/pt-BR/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/pt.ts b/docs/.vuepress/configs/l10n_configs/pt.ts index 2bfc04c8..d50297b8 100644 --- a/docs/.vuepress/configs/l10n_configs/pt.ts +++ b/docs/.vuepress/configs/l10n_configs/pt.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_pt: DefaultThemeLocaleData = { "/l10n/pt/guide/installation.md", "/l10n/pt/guide/usage.md", "/l10n/pt/guide/configuration.md", + "/l10n/pt/guide/creating-text-script.md", "/l10n/pt/guide/chat-bots.md", "/l10n/pt/guide/creating-bots.md", "/l10n/pt/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/ro.ts b/docs/.vuepress/configs/l10n_configs/ro.ts index ca458197..d8293b94 100644 --- a/docs/.vuepress/configs/l10n_configs/ro.ts +++ b/docs/.vuepress/configs/l10n_configs/ro.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_ro: DefaultThemeLocaleData = { "/l10n/ro/guide/installation.md", "/l10n/ro/guide/usage.md", "/l10n/ro/guide/configuration.md", + "/l10n/ro/guide/creating-text-script.md", "/l10n/ro/guide/chat-bots.md", "/l10n/ro/guide/creating-bots.md", "/l10n/ro/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/ru.ts b/docs/.vuepress/configs/l10n_configs/ru.ts index ad402404..fc8d1148 100644 --- a/docs/.vuepress/configs/l10n_configs/ru.ts +++ b/docs/.vuepress/configs/l10n_configs/ru.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_ru: DefaultThemeLocaleData = { "/l10n/ru/guide/installation.md", "/l10n/ru/guide/usage.md", "/l10n/ru/guide/configuration.md", + "/l10n/ru/guide/creating-text-script.md", "/l10n/ru/guide/chat-bots.md", "/l10n/ru/guide/creating-bots.md", "/l10n/ru/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/sr-Cyrl.ts b/docs/.vuepress/configs/l10n_configs/sr-Cyrl.ts index b4a5cd5c..cb86e0e0 100644 --- a/docs/.vuepress/configs/l10n_configs/sr-Cyrl.ts +++ b/docs/.vuepress/configs/l10n_configs/sr-Cyrl.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_sr_Cyrl: DefaultThemeLocaleData = { "/l10n/sr-Cyrl/guide/installation.md", "/l10n/sr-Cyrl/guide/usage.md", "/l10n/sr-Cyrl/guide/configuration.md", + "/l10n/sr-Cyrl/guide/creating-text-script.md", "/l10n/sr-Cyrl/guide/chat-bots.md", "/l10n/sr-Cyrl/guide/creating-bots.md", "/l10n/sr-Cyrl/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/sv.ts b/docs/.vuepress/configs/l10n_configs/sv.ts index 707eed39..b4c0a278 100644 --- a/docs/.vuepress/configs/l10n_configs/sv.ts +++ b/docs/.vuepress/configs/l10n_configs/sv.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_sv: DefaultThemeLocaleData = { "/l10n/sv/guide/installation.md", "/l10n/sv/guide/usage.md", "/l10n/sv/guide/configuration.md", + "/l10n/sv/guide/creating-text-script.md", "/l10n/sv/guide/chat-bots.md", "/l10n/sv/guide/creating-bots.md", "/l10n/sv/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/tr.ts b/docs/.vuepress/configs/l10n_configs/tr.ts index 94dcb737..fb9eb6ec 100644 --- a/docs/.vuepress/configs/l10n_configs/tr.ts +++ b/docs/.vuepress/configs/l10n_configs/tr.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_tr: DefaultThemeLocaleData = { "/l10n/tr/guide/installation.md", "/l10n/tr/guide/usage.md", "/l10n/tr/guide/configuration.md", + "/l10n/tr/guide/creating-text-script.md", "/l10n/tr/guide/chat-bots.md", "/l10n/tr/guide/creating-bots.md", "/l10n/tr/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/uk.ts b/docs/.vuepress/configs/l10n_configs/uk.ts index c44cf1b7..a15a896e 100644 --- a/docs/.vuepress/configs/l10n_configs/uk.ts +++ b/docs/.vuepress/configs/l10n_configs/uk.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_uk: DefaultThemeLocaleData = { "/l10n/uk/guide/installation.md", "/l10n/uk/guide/usage.md", "/l10n/uk/guide/configuration.md", + "/l10n/uk/guide/creating-text-script.md", "/l10n/uk/guide/chat-bots.md", "/l10n/uk/guide/creating-bots.md", "/l10n/uk/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/vi.ts b/docs/.vuepress/configs/l10n_configs/vi.ts index c3eaad7b..50c554c7 100644 --- a/docs/.vuepress/configs/l10n_configs/vi.ts +++ b/docs/.vuepress/configs/l10n_configs/vi.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_vi: DefaultThemeLocaleData = { "/l10n/vi/guide/installation.md", "/l10n/vi/guide/usage.md", "/l10n/vi/guide/configuration.md", + "/l10n/vi/guide/creating-text-script.md", "/l10n/vi/guide/chat-bots.md", "/l10n/vi/guide/creating-bots.md", "/l10n/vi/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/zh-Hans.ts b/docs/.vuepress/configs/l10n_configs/zh-Hans.ts index bf78e614..146cf830 100644 --- a/docs/.vuepress/configs/l10n_configs/zh-Hans.ts +++ b/docs/.vuepress/configs/l10n_configs/zh-Hans.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_zh_Hans: DefaultThemeLocaleData = { "/l10n/zh-Hans/guide/installation.md", "/l10n/zh-Hans/guide/usage.md", "/l10n/zh-Hans/guide/configuration.md", + "/l10n/zh-Hans/guide/creating-text-script.md", "/l10n/zh-Hans/guide/chat-bots.md", "/l10n/zh-Hans/guide/creating-bots.md", "/l10n/zh-Hans/guide/contibuting.md" diff --git a/docs/.vuepress/configs/l10n_configs/zh-Hant.ts b/docs/.vuepress/configs/l10n_configs/zh-Hant.ts index efb14792..d2577220 100644 --- a/docs/.vuepress/configs/l10n_configs/zh-Hant.ts +++ b/docs/.vuepress/configs/l10n_configs/zh-Hant.ts @@ -59,6 +59,7 @@ export const defaultThemeConfig_zh_Hant: DefaultThemeLocaleData = { "/l10n/zh-Hant/guide/installation.md", "/l10n/zh-Hant/guide/usage.md", "/l10n/zh-Hant/guide/configuration.md", + "/l10n/zh-Hant/guide/creating-text-script.md", "/l10n/zh-Hant/guide/chat-bots.md", "/l10n/zh-Hant/guide/creating-bots.md", "/l10n/zh-Hant/guide/contibuting.md" diff --git a/docs/guide/creating-text-script.md b/docs/guide/creating-text-script.md new file mode 100644 index 00000000..bdcc7c5c --- /dev/null +++ b/docs/guide/creating-text-script.md @@ -0,0 +1,26 @@ +--- +title: Creating Simple Script +--- + +# Creating Simple Script + +A simple script is a text file with one command per line. See [Internal Commands](https://mccteam.github.io/guide/usage.html#internal-commands) section or type `/help` in the console to see available commands. Any line beginning with `#` is ignored and treated as a comment. + +Application variables defined using the set command or [AppVars] INI section can be used. The following read-only variables can also be used: `%username%, %login%, %serverip%, %serverport%, %datetime%` + +## Example + +`sample-script.txt`: Send a hello message, wait 60 seconds and disconnect from server. +``` +# This is a sample script for Minecraft Console Client +# Any line beginning with "#" is ignored and treated as a comment. + +send Hello World! I'm a bot scripted using Minecraft Console Client. +wait 60 +send Now quitting. Bye :) +exit +``` + +Go to [example scripts](https://github.com/MCCTeam/Minecraft-Console-Client/tree/master/MinecraftClient/config) to see more example. + +If you want need advanced functions, please see [Creating Chat Bots](creating-bots.md) \ No newline at end of file diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 19d862a1..dc2b01cf 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -20,32 +20,20 @@ If you're not the kind of person that likes textual tutorials, our community has ## Download a compiled binary -In order to run **Minecraft Console Client** you need [.NET 6.0 or new-er](https://dotnet.microsoft.com/en-us/download) - -

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 - -- [Install .NET on Windows](https://docs.microsoft.com/en-us/dotnet/core/install/windows) -- [Install .NET on Linux](https://docs.microsoft.com/en-us/dotnet/core/install/linux) -- [Install .NET on macOS](https://docs.microsoft.com/en-us/dotnet/core/install/macos) - -#### Download - You can download a compiled binary file of the latest build from our Releases section on Git Hub: [Download](https://github.com/MCCTeam/Minecraft-Console-Client/releases) ## Building from the source code +We recommend you to download our precompiled binary file from [GitHub](https://github.com/MCCTeam/Minecraft-Console-Client/releases). + +However, if you want to build the program from source code, please follow the guide. + ### Windows Requirements: - [Git](https://www.git-scm.com/) -- [.NET 6.0 or new-er](https://dotnet.microsoft.com/en-us/download) or [Visual Studio](https://visualstudio.microsoft.com/) configured for C# app development +- [.NET 7.0 or new-er](https://dotnet.microsoft.com/en-us/download) or [Visual Studio](https://visualstudio.microsoft.com/) configured for C# app development #### Cloning using Git @@ -98,7 +86,7 @@ If the build has succeeded, the compiled binary `MinecraftClient.exe` will be in 3. Run the following command to build the project: ```bash -dotnet publish MinecraftClient -f net6.0 -r win-x64 --no-self-contained -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None +dotnet publish MinecraftClient -f net7.0 -r win-x64 --no-self-contained -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None ``` If the build has succeeded, the compiled binary `MinecraftClient.exe` will be in `MinecraftClient/bin/Release/net6.0/win-x64/publish` folder. @@ -140,7 +128,7 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive - On Linux: ```bash - dotnet publish MinecraftClient -f net6.0 -r linux-x64 --no-self-contained -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None + dotnet publish MinecraftClient -f net7.0 -r linux-x64 --no-self-contained -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None ```

Tip

@@ -152,7 +140,7 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive - On macOS: ```bash - dotnet publish MinecraftClient -f net6.0 -r osx-x64 --no-self-contained -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None + dotnet publish MinecraftClient -f net7.0 -r osx-x64 --no-self-contained -c Release -p:UseAppHost=true -p:IncludeNativeLibrariesForSelfExtract=true -p:DebugType=None ```

Tip

@@ -163,8 +151,8 @@ git clone https://github.com/MCCTeam/Minecraft-Console-Client.git --recursive If the build has succeeded, the compiled binary `MinecraftClient` will be in: -- Linux: `MinecraftClient/bin/Release/net6.0/linux-x64/publish/` -- macOS: `MinecraftClient/bin/Release/net6.0/osx-x64/publish/` +- Linux: `MinecraftClient/bin/Release/net7.0/linux-x64/publish/` +- macOS: `MinecraftClient/bin/Release/net7.0/osx-x64/publish/` ## Using Docker diff --git a/docs/guide/usage.md b/docs/guide/usage.md index de7683e3..1ece0c37 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -470,7 +470,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q - **Usage:** - Basic usage: `/execif ---> ` + Basic usage: `/execif ` - **Examples:** @@ -478,30 +478,38 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q ``` /set test=Something - /execif test == "Something" ---> send Success! + /execif 'test == "Something"' "send Success!" ``` +

Tip

+ + **You can use single quote (`'`) to wrap your expression if the expression contains double quote (`"`)** + + **Adding back-slash (`\`) before the double quote will also work (`/execif "test == \"Something\"" "send Success!"`)** + +
+ ``` /set test2=1 - /execif test2 == "1" ---> send Success 2! + /execif 'test2 == "1"' "send Success 2!" ``` Basic C# expression: ``` - /execif 1 + 2 + 3 == 6 ---> send Success! + /execif "1 + 2 + 3 == 6" "send Success!" ``` Using MCC class: ``` - /execif MCC.GetHealth() == 20.0 ---> send Success! + /execif "MCC.GetHealth() == 20.0" "send Success!" ``` Using in combination with [`execmulti`](#execmulti): ``` - /execif 1 == 1 ---> execmulti send 1 -> send 2 -> send 3 + /execif "1 == 1" "execmulti send 1 -> send 2 -> send 3" ``` ### `execmulti`