helpy4/Minecraft-Console-Client
1
0
Fork 0
mirror of https://github.com/MCCTeam/Minecraft-Console-Client synced 2025-10-14 21:22:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add images

Browse source
This commit is contained in:
BruceChen 2022-11-02 21:49:54 +08:00
parent e5529eead9
commit be9a8b9a66
25 changed files with 84 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/.vuepress/config.ts
View file

@ -2,12 +2,14 @@ import process from 'node:process'
import { viteBundler } from '@vuepress/bundler-vite' import { viteBundler } from '@vuepress/bundler-vite'
import { webpackBundler } from '@vuepress/bundler-webpack' import { webpackBundler } from '@vuepress/bundler-webpack'
import { defineUserConfig } from '@vuepress/cli' import { defineUserConfig } from '@vuepress/cli'
// import { docsearchPlugin } from '@vuepress/plugin-docsearch'
import { shikiPlugin } from '@vuepress/plugin-shiki' import { shikiPlugin } from '@vuepress/plugin-shiki'
import { defaultTheme } from '@vuepress/theme-default' import { defaultTheme } from '@vuepress/theme-default'
import { getDirname, path } from '@vuepress/utils' import { getDirname, path } from '@vuepress/utils'
import { backToTopPlugin } from "@vuepress/plugin-back-to-top"
import { externalLinkIconPlugin } from "@vuepress/plugin-external-link-icon"
import { nprogressPlugin } from "@vuepress/plugin-nprogress"
import { head } from './configs/head.js' import { headConfig } from './configs/head.js'
import { mainConfig, defaultThemeConfig } from './configs/locales_config.js' import { mainConfig, defaultThemeConfig } from './configs/locales_config.js'
const __dirname = getDirname(import.meta.url) const __dirname = getDirname(import.meta.url)
@ -18,7 +20,7 @@ export default defineUserConfig({
base: '/', base: '/',
// extra tags in `<head>` // extra tags in `<head>`
head: head, head: headConfig,
// site-level locales config // site-level locales config
locales: mainConfig, locales: mainConfig,
@ -29,7 +31,7 @@ export default defineUserConfig({
// configure default theme // configure default theme
theme: defaultTheme({ theme: defaultTheme({
logo: "/images/MCC_logo.png", logo: "/images/MCC_logo.png",
repo: "https://github.com/MCCTeam/Minecraft-Console-Client", repo: "MCCTeam/Minecraft-Console-Client",
docsDir: 'docs', docsDir: 'docs',
// theme-level locales config // theme-level locales config
@ -53,6 +55,9 @@ export default defineUserConfig({
// use plugins // use plugins
plugins: [ plugins: [
backToTopPlugin(),
externalLinkIconPlugin(),
nprogressPlugin(),
// only enable shiki plugin in production mode // only enable shiki plugin in production mode
isProd ? shikiPlugin({ theme: 'dark-plus' }) : [], isProd ? shikiPlugin({ theme: 'dark-plus' }) : [],
], ],

34
docs/.vuepress/configs/head.ts
View file

@ -1,8 +1,32 @@
import type { HeadConfig } from '@vuepress/core' import type { HeadConfig } from '@vuepress/core'
export const head: HeadConfig[] = [ export const headConfig: HeadConfig[] = [
["meta", { name: "theme-color", content: "#3eaf7c" }], [
["meta", { name: "apple-mobile-web-app-capable", content: "yes" }], 'link',
["meta", { name: "apple-mobile-web-app-status-bar-style", content: "black" }], {
["link", { rel: "icon", href: "../../favicon.ico" }], rel: 'icon',
type: 'image/png',
sizes: '16x16',
href: `/images/icons/favicon-16x16.png`,
},
],
[
'link',
{
rel: 'icon',
type: 'image/png',
sizes: '32x32',
href: `/images/icons/favicon-32x32.png`,
},
],
['link', { rel: 'manifest', href: '/manifest.webmanifest' }],
['meta', { name: 'application-name', content: 'MCC Doc' }],
['meta', { name: 'apple-mobile-web-app-title', content: 'MCC Doc' }],
['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
[
'link',
{ rel: 'apple-touch-icon', href: `/images/icons/apple-touch-icon.png` },
],
['meta', { name: 'msapplication-TileColor', content: '#3eaf7c' }],
['meta', { name: 'theme-color', content: '#3eaf7c' }],
] ]

6
docs/.vuepress/configs/l10n_configs/config_templete.ts
View file

@ -1,14 +1,14 @@
import type { SiteLocaleData } from '@vuepress/shared' import type { SiteLocaleData } from '@vuepress/shared'
import type { DefaultThemeLocaleData } from '@vuepress/theme-default' import type { DefaultThemeLocaleData } from '@vuepress/theme-default'
import { head } from '../head.js' import { headConfig } from '../head.js'
const Translation = require('../../translations/$LanguageCode$.json') const Translation = require('../../translations/$LanguageCode$.json')
export const mainConfig_$LanguageCodeEscaped$: SiteLocaleData = { export const mainConfig_$LanguageCodeEscaped$ = {
lang: '$LanguageCode$', lang: '$LanguageCode$',
title: Translation.title, title: Translation.title,
description: Translation.description, description: Translation.description,
head: head head: headConfig
} }
export const defaultThemeConfig_$LanguageCodeEscaped$: DefaultThemeLocaleData = { export const defaultThemeConfig_$LanguageCodeEscaped$: DefaultThemeLocaleData = {

6
docs/.vuepress/configs/l10n_configs/en.ts
View file

@ -1,15 +1,15 @@
/* This file is automatically generated by "gen_configs.py" */ /* This file is automatically generated by "gen_configs.py" */
import type { SiteLocaleData } from '@vuepress/shared' import type { SiteLocaleData } from '@vuepress/shared'
import type { DefaultThemeLocaleData } from '@vuepress/theme-default' import type { DefaultThemeLocaleData } from '@vuepress/theme-default'
import { head } from '../head.js' import { headConfig } from '../head.js'
const Translation = require('../../translations/en.json') const Translation = require('../../translations/en.json')
export const mainConfig_en: SiteLocaleData = { export const mainConfig_en = {
lang: 'en', lang: 'en',
title: Translation.title, title: Translation.title,
description: Translation.description, description: Translation.description,
head: head head: headConfig
} }
export const defaultThemeConfig_en: DefaultThemeLocaleData = { export const defaultThemeConfig_en: DefaultThemeLocaleData = {

6
docs/.vuepress/configs/l10n_configs/zh-Hans.ts
View file

@ -1,15 +1,15 @@
/* This file is automatically generated by "gen_configs.py" */ /* This file is automatically generated by "gen_configs.py" */
import type { SiteLocaleData } from '@vuepress/shared' import type { SiteLocaleData } from '@vuepress/shared'
import type { DefaultThemeLocaleData } from '@vuepress/theme-default' import type { DefaultThemeLocaleData } from '@vuepress/theme-default'
import { head } from '../head.js' import { headConfig } from '../head.js'
const Translation = require('../../translations/zh-Hans.json') const Translation = require('../../translations/zh-Hans.json')
export const mainConfig_zh_Hans: SiteLocaleData = { export const mainConfig_zh_Hans = {
lang: 'zh-Hans', lang: 'zh-Hans',
title: Translation.title, title: Translation.title,
description: Translation.description, description: Translation.description,
head: head head: headConfig
} }
export const defaultThemeConfig_zh_Hans: DefaultThemeLocaleData = { export const defaultThemeConfig_zh_Hans: DefaultThemeLocaleData = {

BIN
docs/.vuepress/public/icons/android-chrome-192x192.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 22 KiB

BIN
docs/.vuepress/public/icons/android-chrome-512x512.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 126 KiB

BIN
docs/.vuepress/public/icons/apple-touch-icon.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/.vuepress/public/icons/favicon-16x16.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 651 B

BIN
docs/.vuepress/public/icons/favicon-32x32.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 1.5 KiB

BIN
docs/.vuepress/public/icons/favicon.ico Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 15 KiB

BIN
docs/.vuepress/public/images/guide/ChunkStatus.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.3 KiB

BIN
docs/.vuepress/public/images/guide/PlayerInventory.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 5.1 KiB

BIN
docs/.vuepress/public/images/guide/VPS_ConfigureStorage.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 40 KiB

BIN
docs/.vuepress/public/images/guide/VPS_InstanceType.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
docs/.vuepress/public/images/guide/VPS_Name.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/.vuepress/public/images/guide/VPS_NetworkSettings.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 92 KiB

BIN
docs/.vuepress/public/images/guide/VPS_SelectOS.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 100 KiB

20
docs/.vuepress/public/manifest.webmanifest Normal file
View file

@ -0,0 +1,20 @@
{
"name": "MCC Documentation",
"short_name": "MCC Doc",
"description": "Documentation website for Minecraft Console Client (MCC)",
"icons": [
{
"src": "/android-chrome-192x192.png",
"sizes": "192x192",
"type": "image/png"
},
{
"src": "/android-chrome-512x512.png",
"sizes": "512x512",
"type": "image/png"
}
],
"theme_color": "#3eaf7c",
"background_color": "#ffffff",
"display": "standalone"
}

2
docs/guide/configuration.md
View file

@ -346,7 +346,7 @@ Coordinate = { x = 145, y = 64, y = 2045 }
How it looks like: How it looks like:
![ASCII Art here](http://i.pics.rs/33yn9.png "ASCII Art here") ![ASCII Art here](/images/guide/PlayerInventory.png "ASCII Art here")
- **Type:** `boolean` - **Type:** `boolean`

10
docs/guide/installation.md
View file

@ -540,13 +540,13 @@ Click on the **Launch instance** button.
Fill out the `Name` field with a name of your preference. Fill out the `Name` field with a name of your preference.
![http://i.pics.rs/22ArI.png](http://i.pics.rs/WWzUM.png) ![VPS Name](/images/guide/VPS_Name.png)
For the **Application and OS images** select `Ubuntu Server 22.04 LTS (HVM), SSD Volume Type`. 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.** > **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.**
![http://i.pics.rs/22ArI.png](http://i.pics.rs/22ArI.png) ![VPS Select OS](/images/guide/VPS_SelectOS.png)
For the **Instance type** select `t2.micro`. For the **Instance type** select `t2.micro`.
@ -554,7 +554,7 @@ For the **Key pair (login)** click on **Create new key pair** and name it `VpsRo
> **⚠️ 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.** > **⚠️ 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.**
![http://i.pics.rs/jjD4d.png](http://i.pics.rs/jjD4d.png) ![VPS Instance Type](/images/guide/VPS_InstanceType.png)
For the **Network settings** check the following checkboxes on: For the **Network settings** check the following checkboxes on:
@ -564,11 +564,11 @@ For the **Network settings** check the following checkboxes on:
> **ℹ️ 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.** > **ℹ️ 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.**
![http://i.pics.rs/77atQ.png](http://i.pics.rs/77atQ.png) ![VPS Network Settings](/images/guide/VPS_NetworkSettings.png)
For the **Storage** enter `30`. For the **Storage** enter `30`.
![http://i.pics.rs/cc4yz.png](http://i.pics.rs/cc4yz.png) ![VPS Configure Storage](/images/guide/VPS_ConfigureStorage.png)
Finally, review the **Summary** confirm that everything is as in the tutorial and that you will not be charged and click on the **Launch instance**. Once you've clicked on the button, it will take a couple of minutes for the instance to be available up and running. Finally, review the **Summary** confirm that everything is as in the tutorial and that you will not be charged and click on the **Launch instance**. Once you've clicked on the button, it will take a couple of minutes for the instance to be available up and running.

4
docs/guide/usage.md
View file

@ -278,7 +278,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q
How it looks: How it looks:
![Chunk status](http://i.pics.rs/DDB9W.png) ![Chunk status](/images/guide/ChunkStatus.png)
### `dig` ### `dig`
@ -768,7 +768,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q
An example of player inventory with annotated IDs in ASCII art and a list of items: An example of player inventory with annotated IDs in ASCII art and a list of items:
![Picture Not Loaded!](http://i.pics.rs/33yn9.png "Player Inventory") ![Player Inventory](/images/guide/PlayerInventory.png "Player Inventory")
- **Usage:** - **Usage:**

2
docs/zh-Hans/guide/configuration.md
View file

@ -346,7 +346,7 @@ Coordinate = { x = 145, y = 64, y = 2045 }
How it looks like: How it looks like:
![ASCII Art here](http://i.pics.rs/33yn9.png "ASCII Art here") ![ASCII Art here](/images/guide/PlayerInventory.png "ASCII Art here")
- **Type:** `boolean` - **Type:** `boolean`

10
docs/zh-Hans/guide/installation.md
View file

@ -540,13 +540,13 @@ Click on the **Launch instance** button.
Fill out the `Name` field with a name of your preference. Fill out the `Name` field with a name of your preference.
![http://i.pics.rs/22ArI.png](http://i.pics.rs/WWzUM.png) ![VPS Name](/images/guide/VPS_Name.png)
For the **Application and OS images** select `Ubuntu Server 22.04 LTS (HVM), SSD Volume Type`. 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.** > **⚠️ VERY IMPORTANT: Make sure that it has `Free tier eligible` next to it.**
![http://i.pics.rs/22ArI.png](http://i.pics.rs/22ArI.png) ![VPS Select OS](/images/guide/VPS_SelectOS.png)
For the **Instance type** select `t2.micro`. For the **Instance type** select `t2.micro`.
@ -554,7 +554,7 @@ For the **Key pair (login)** click on **Create new key pair** and name it `VpsRo
> **⚠️ 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.** > **⚠️ 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.**
![http://i.pics.rs/jjD4d.png](http://i.pics.rs/jjD4d.png) ![VPS Instance Type](/images/guide/VPS_InstanceType.png)
For the **Network settings** check the following checkboxes on: For the **Network settings** check the following checkboxes on:
@ -564,11 +564,11 @@ For the **Network settings** check the following checkboxes on:
> **ℹ️ 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.** > **ℹ️ 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.**
![http://i.pics.rs/77atQ.png](http://i.pics.rs/77atQ.png) ![VPS Network Settings](/images/guide/VPS_NetworkSettings.png)
For the **Storage** enter `30`. For the **Storage** enter `30`.
![http://i.pics.rs/cc4yz.png](http://i.pics.rs/cc4yz.png) ![VPS Configure Storage](/images/guide/VPS_ConfigureStorage.png)
Finally, review the **Summary** confirm that everything is as in the tutorial and that you will not be charged and click on the **Launch instance**. Once you've clicked on the button, it will take a couple of minutes for the instance to be available up and running. Finally, review the **Summary** confirm that everything is as in the tutorial and that you will not be charged and click on the **Launch instance**. Once you've clicked on the button, it will take a couple of minutes for the instance to be available up and running.

6
docs/zh-Hans/guide/usage.md
View file

@ -46,7 +46,7 @@ _Learn more on how to use the screen command: [YouTube](https://www.youtube.com/
## Docker ## Docker
See [Run using Docker](./installation.md#using-docker) See [Run using Docker](./guide/installation.md#using-docker)
## Command-line usage ## Command-line usage
@ -278,7 +278,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q
How it looks: How it looks:
![Chunk status](http://i.pics.rs/DDB9W.png) ![Chunk status](/images/guide/ChunkStatus.png)
### `dig` ### `dig`
@ -768,7 +768,7 @@ In scripts and remote control, no slash is needed to perform the command, eg. `q
An example of player inventory with annotated IDs in ASCII art and a list of items: An example of player inventory with annotated IDs in ASCII art and a list of items:
![Picture Not Loaded!](http://i.pics.rs/33yn9.png "Player Inventory") ![Player Inventory](/images/guide/PlayerInventory.png "Player Inventory")
- **Usage:** - **Usage:**