chore: add vscode/settings.json & update readme

MCSManager · Dec 1, 2024 · 4f61f3e · 4f61f3e
1 parent e521258
commit 4f61f3e
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 28 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,8 +7,6 @@ yarn-error.log*
 lerna-debug.log*
 panel/public/
 *.code-workspace
-vscode/
-.vscode/
 data/
 dist/
 out/

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,18 @@
+// Please do not commit changes to this file.
+// You need to install the "i18n ally" VSCode plugin.
+{
+  "i18n-ally.extract.keyMaxLength": 10000,
+  "cSpell.words": ["BUKKIT", "BUNGEECORD", "MINECRAFT"],
+  "i18n-ally.localesPaths": [
+    "languages",
+    "frontend/src/lang",
+    "daemon/src/i18n",
+    "panel/src/app/i18n"
+  ],
+  "i18n-ally.keystyle": "flat",
+  "i18n-ally.enabledFrameworks": ["vue"],
+  "i18n-ally.sourceLanguage": "en",
+
+  // Change this to your language, available options: "languages/*.json"
+  "i18n-ally.displayLanguage": "en_US"
+}
diff --git a/README.md b/README.md
@@ -18,12 +18,11 @@
 
 [简体中文](README_ZH.md) | [繁體中文](README_TW.md) | [Português BR](README_PTBR.md) |
 [日本語](README_JP.md) | [Spanish](README_ES.md)
+
 </div>
 
 <br />
 
-
-
 ## What is MCSManager?
 
 **MCSManager Panel** (MCSM) is a **modern, secure, and distributed control panel** designed for managing Minecraft and Steam game servers.
@@ -32,7 +31,6 @@ MCSManager has already gained a certain level of popularity within the community
 
 MCSManager **supports English, French, German, Italian, Japanese, Portuguese, Simplified Chinese, and Traditional Chinese**, with plans to add support for more languages in the future!
 
-
 **Terminal**
 
 ![failed_to_load_screenshot.png](/.github/panel-image.png)
@@ -45,18 +43,15 @@ MCSManager **supports English, French, German, Italian, Japanese, Portuguese, Si
 
 ![failed_to_load_screenshot.png](/.github/panel-custom-layout.gif)
 
-
-
 ## Features
 
 1. One-click deployment of `Minecraft` Java/Bedrock Server
 2. Compatible with most `Steam` game servers. (e.g. `Palworld`, `Squad`, `Project Zomboid`, `Terraria`, etc.)
 3. Customizable UI, create your own layout
-4. Support `Docker` virtualization, multiuser, and commercial services
-
-
+4. Supports all images on `Docker Hub`, supports multiple users, and supports commercial services!
 5. Manage multiple servers with a single web interface
-6. More...
+6. The technology stack is simple, and you only need to be good at Typescript to complete the entire MCSManager development
+7. More...
 
 <br />
 
@@ -144,16 +139,18 @@ This installation approach does not automatically set up MCSManager as a system
 
 <br />
 
-## Browser Compatibility
+## Development
 
-- Supported on modern browsers including `Chrome`, `Firefox`, and `Safari`.
-- Support for `IE` has been discontinued.
+This section is specifically designed for developers. General users may disregard this portion without concern.
 
-<br />
+### Plugins
 
-## Development
+We use "VS Code" to develop MCSManager. You may need to install these plugins:
 
-This section is specifically designed for developers. General users may disregard this portion without concern.
+- i18n display support (I18n Ally)
+- Code formatter (Prettier)
+- Vue - Offcial
+- ESLint
 
 ### MacOS
 
@@ -171,14 +168,18 @@ git clone https://github.com/MCSManager/MCSManager.git
 ./npm-dev-windows.bat
 ```
 
+### Dependency Files
+
+You'll need to go to the [PTY](https://github.com/MCSManager/PTY) and [Zip-Tools](https://github.com/MCSManager/Zip-Tools) projects to download the corresponding binary files and place them in the `daemon/lib` directory to ensure the proper functioning of the `Emulation Terminal` and `File Decompression`.
+
 ### Build Production Version
 
 ```bash
 ./build.bat # Windows
 ./build.sh  # MacOS
 ```
 
-Next, you'll need to go to the [PTY](https://github.com/MCSManager/PTY) and [Zip-Tools](https://github.com/MCSManager/Zip-Tools) projects to download the corresponding binary files and place them in the `daemon/lib` directory to ensure the proper functioning of the `Emulation Terminal` and `File Decompression`.
+Output Directory: "production-code"
 
 <br />
 
@@ -190,6 +191,13 @@ Please ensure that any submitted code adheres to our existing coding style. For
 
 <br />
 
+## Browser Compatibility
+
+- Supported on modern browsers including `Chrome`, `Firefox`, and `Safari`.
+- Support for `IE` has been discontinued.
+
+<br />
+
 ## BUG Reporting
 
 **Open Issue:** [Click here](https://github.com/MCSManager/MCSManager/issues/new/choose)

diff --git a/README_ZH.md b/README_ZH.md
@@ -40,9 +40,9 @@
 1. 支持一键开服！轻松部署 `Minecraft` Java 版/基岩版游戏服务器。
 2. 兼容大部分 `Steam` 游戏服务器，列如 `幻兽帕鲁`，`战术小队`，`僵尸毁灭工程` 和 `泰拉瑞亚` 等。
 3. 网页支持拖拽式的小卡片布局，打造自己喜欢的界面布局。
-4. 支持 `Docker` 虚拟化，支持多用户，支持商业出租行为。
-5. 支持所有 `Docker` 镜像，轻松打造预设！
-6. 支持分布式，一个网页即可同时管理数台机器。
+4. 支持 `Docker Hub` 上的所有镜像，支持多用户，支持商业服务。
+5. 支持分布式，一个网页即可同时管理数台机器。
+6. 技术栈简单，仅需擅长 Typescript 即可完成整个 MCSManager 开发！
 7. 更多...
 
 <br />
@@ -127,16 +127,18 @@ tar -zxf mcsmanager_linux_release.tar.gz
 
 <br />
 
-## 浏览器兼容性
+## 搭建开发环境
 
-- 支持 `Chrome` `Firefox` `Safari` `Opera` 等现代主流浏览器。
-- 已放弃支持 `IE` 浏览器。
+此段落面向开发人员，普通用户无需关注也无需执行。
 
-<br />
+### 必备插件
 
-## 搭建开发环境
+我们使用 “VS Code” 开发 MCSManager，你可能需要安装这些插件：
 
-此段落面向开发人员，普通用户无需关注也无需执行。
+- i18n 文案显示支持（I18n Ally）
+- 代码格式化（Prettier）
+- Vue - Offcial
+- ESLint
 
 ### MacOS
 
@@ -154,14 +156,18 @@ git clone https://github.com/MCSManager/MCSManager.git
 ./npm-dev-windows.bat
 ```
 
+### 依赖文件
+
+接下来你还需要前往 [PTY](https://github.com/MCSManager/PTY) 和 [Zip-Tools](https://github.com/MCSManager/Zip-Tools) 两个项目下载对应的二进制文件，将他们存放到 `daemon/lib` 目录下，以确保 `仿真终端` 和 `文件解压缩` 的正常工作。
+
 ### 构建生产环境版本
 
 ```bash
 ./build.bat # Windows
 ./build.sh  # MacOS
 ```
 
-接下来你还需要前往 [PTY](https://github.com/MCSManager/PTY) 和 [Zip-Tools](https://github.com/MCSManager/Zip-Tools) 两个项目下载对应的二进制文件，将他们存放到 `daemon/lib` 目录下，以确保 `仿真终端` 和 `文件解压缩` 的正常工作。
+最终产物目录: "production-code"
 
 <br />
 
@@ -173,6 +179,13 @@ git clone https://github.com/MCSManager/MCSManager.git
 
 <br />
 
+## 浏览器兼容性
+
+- 支持 `Chrome` `Firefox` `Safari` `Opera` 等现代主流浏览器。
+- 已放弃支持 `IE` 浏览器。
+
+<br />
+
 ## BUG 报告
 
 欢迎发现的任何问题进行反馈，必当及时修复。