Skip to content

Latest commit

 

History

History
298 lines (195 loc) · 9.26 KB

README_TW.md

File metadata and controls

298 lines (195 loc) · 9.26 KB

這是什麼?

MCSManager Panel(簡稱:MCSM Panel)是一個快速部署、支援分散式架構、多使用者、簡單現代的 Minecraft 和 Steam 遊戲伺服器網頁管理面板。

MCSManager 在 Minecraft 和 Steam 遊戲社群中廣受歡迎。它幫助您集中管理多台實體伺服器,讓您可以在任何主機上建立遊戲伺服器,並提供安全可靠的多使用者權限系統,可以輕鬆幫助您管理多個伺服器。它一直為 Minecraft、Terraria 和 Steam 遊戲伺服器的管理員、營運人員和個人開發者提供健康的軟體支援。

它也適用於任何商業活動,例如 IDC 服務提供商的私人伺服器銷售等。幾家中小企業已經將此面板用作管理和銷售軟體,並支援多個國家的語言。

1 terminal 3 4

功能特色

  1. 使用應用程式市場輕鬆一鍵部署 Minecraft 或 Steam 遊戲伺服器。
  2. 相容於大多數 Steam 遊戲伺服器,如 Palworld、Squad、Project Zomboid 和 Terraria 等。
  3. 網頁介面支援拖放卡片佈局,建立您偏好的介面佈局。
  4. 支援 Docker Hub 上的所有映像,支援多使用者,支援商業實例銷售服務。
  5. 支援分散式架構,一個網頁介面可以同時管理多台機器。
  6. 簡單的技術堆疊,只需精通 TypeScript 即可完成整個 MCSManager 開發!
  7. 更多...

執行環境

控制面板可以在 Windows 和 Linux 平台上執行,無需安裝資料庫,只需安裝 Node.js 環境和幾個解壓縮命令。

必須使用 Node.js 16.20.2 或更高版本,建議使用最新的 LTS 版本。


安裝

Windows

下載:https://download.mcsmanager.com/mcsmanager_windows_release.zip

啟動面板:

start.bat

Linux

一行命令快速安裝

sudo su -c "wget -qO- https://script.mcsmanager.com/setup_cn.sh | bash"

安裝後使用

systemctl start mcsm-{web,daemon} # 啟動面板
systemctl stop mcsm-{web,daemon}  # 停止面板
  • 腳本僅適用於 Ubuntu/Centos/Debian/Archlinux
  • 面板程式碼和執行環境會自動安裝在 /opt/mcsmanager/ 目錄中。

Linux 手動安裝

  • 如果一鍵安裝不工作,您可以嘗試此步驟進行手動安裝。
# 切換到安裝目錄。如果不存在,請先使用 'mkdir /opt/' 建立。
cd /opt/
# 下載執行環境(Node.js)。如果您已經安裝了 Node.js 16+,請忽略此步驟。
wget https://nodejs.org/dist/v20.11.0/node-v20.11.0-linux-x64.tar.xz
# 解壓縮檔案
tar -xvf node-v20.11.0-linux-x64.tar.xz
# 將程式加入系統環境變數。
ln -s /opt/node-v20.11.0-linux-x64/bin/node /usr/bin/node
ln -s /opt/node-v20.11.0-linux-x64/bin/npm /usr/bin/npm

# 準備安裝目錄。
mkdir /opt/mcsmanager/
cd /opt/mcsmanager/

# 下載 MCSManager。
wget https://github.com/MCSManager/MCSManager/releases/latest/download/mcsmanager_linux_release.tar.gz
tar -zxf mcsmanager_linux_release.tar.gz

# 安裝相依性。
chmod 775 install.sh
./install.sh

# 請開啟兩個終端機或 screen。

# 首先啟動 node 程式。
./start-daemon.sh

# 啟動網頁服務(在第二個終端機或 screen 中)。
./start-web.sh

# 訪問 http://<公開 IP>:23333/ 查看面板。
# 通常,網頁應用程式會自動掃描並連接到本地守護程式。

此安裝方法不會自動將面板註冊到系統服務,因此您必須使用 screen 軟體來管理它。如果您希望系統服務接管 MCSManager,請參考文件。

Mac OS

# 首先安裝 Node.js,如果您已經安裝,可以跳過此步驟。
# Node.js 建議安裝最新的 LTS 版本。
brew install node
node -v
npm -v

# 使用 curl 下載檔案
curl -L https://github.com/MCSManager/MCSManager/releases/latest/download/mcsmanager_linux_release.tar.gz -o mcsmanager_linux_release.tar.gz

# 解壓縮檔案(與原始命令相同)
tar -zxf mcsmanager_linux_release.tar.gz

cd mcsmanager

# 安裝相依性。
chmod 775 install.sh
./install.sh

# 請開啟兩個終端機或 screen。

# 首先啟動 node 程式。
./start-daemon.sh

# 啟動網頁服務(在第二個終端機或 screen 中)。
./start-web.sh

# 訪問 http://localhost:23333/ 查看面板。
# 通常,網頁應用程式會自動掃描並連接到本地守護程式。

程式碼貢獻

  • 貢獻程式碼前必須閱讀:MCSManager#599

  • 程式碼需要維持現有格式,不允許過度的程式碼格式化。

  • 所有程式碼必須符合國際化標準。


開發

此部分適用於開發者。如果您想在 MCSManager 上進行二次開發或提交程式碼貢獻,請仔細閱讀這些內容:

必要條件

我們使用 Visual Studio Code 來開發 MCSManager。您必須安裝這些外掛:

  • i18n 文字顯示支援(I18n Ally)
  • 程式碼格式化(Prettier)
  • Vue - Official
  • ESLint

相依性檔案

您需要前往 PTY 和 Zip-Tools 專案下載適合您系統的二進位檔案,將其儲存在 daemon/lib 目錄中(如果不存在請手動建立)以確保 模擬終端 和 檔案解壓縮 的正常運作。

執行

git clone https://github.com/MCSManager/MCSManager.git

# MacOS
./install-dependents.sh
./npm-dev-macos.sh

# Windows
./install-dependents.bat
./npm-dev-windows.bat

程式碼國際化

由於專案適應多種語言,程式碼中的所有 字串 和 註解 只接受英文,因此請不要在程式碼中直接硬編碼非英文文字。

例如,您可能會寫一個需要適應多種語言的新字串。

import { $t } from "../i18n";

if (!checkName) {
  const errorMsg = "Check Name Failed!" // 不要這樣做!
  const errorMsg = $t("TXT_CODE_MY_ERROR"); // 正確!
}.
<script lang="ts" setup>
  import { t } from "@/lang/i18n";
  // ...
</script>

<template>
  <!-- ... -->
  <a-menu-item key="toNodesPage" @click="toNodesPage()">
    <FormOutlined />
    {{ t("TXT_CODE_NODE_INFO") }}
  </a-menu-item>
</template>

請將此行加入語言檔案,例如:languages/en_US.json

其中,en_US.json 是必須加入的,它是所有國家語言的來源文字,其他國家語言可以由我們使用 AI 自動翻譯。

{
  //...
  "TXT_CODE_MY_ERROR": "Check Name Failed!",
  "TXT_CODE_NODE_INFO": "Jump to Node Page"
}

如果您安裝了 I18n Ally 外掛,您的 $t("TXT_CODE_MY_ERROR") 應該會顯示英文文字。

如果翻譯文字需要攜帶參數,這可能會有點複雜,因為前端和後端使用不同的 i18n 函式庫,所以格式可能會不同。您需要查看檔案以找到類似的程式碼來理解。

所有翻譯文字鍵不能重複,因此請嘗試使用更長的名稱!

建置生產環境版本

./build.bat # Windows
./build.sh  # MacOS

建置完成後,您會在 production-code 目錄中找到生產環境程式碼。


瀏覽器相容性

  • 支援 Chrome Firefox Safari Opera 等現代主流瀏覽器。
  • 已放棄對 IE 瀏覽器的支援。

錯誤回報

歡迎回報發現的任何問題,我們會迅速修復。

如果您發現不便公開的嚴重安全漏洞,請發送電子郵件至:support@mcsmanager.com。安全問題修復後,發現者的姓名將附加在程式碼中。


授權條款

原始碼遵循 Apache-2.0 授權條款。

Copyright ©2025 MCSManager.