Chinese-Chess

English | 繁體中文

---

Chinese Chess (Xiangqi)

This is a desktop Chinese Chess (Xiangqi) application built with Electron and the Pikafish Xiangqi engine.

⬇️ Quick Download (v1.5.0)

• 🪟 Windows portable
• 🪟 Windows installer(.exe)
• 🪟 Windows installer(.msi)
• 🐧 Linux AppImage
• 🐧 Linux snap store
• 🐧 Linux deb(Ubuntu/Debian)
• 🐧 Linux rpm(Fedora/RHEL/Cent OS)

Hello everyone, I’m Augus, the developer of this project, from Taiwan.

This is a project I completed during my summer break between elementary and junior high school, with the assistance of the Gemini CLI. (Way more fun than summer homework, by the way!) As the new school year begins, my studies will become more demanding, and I won’t have sufficient time to maintain or update this project.

A huge thank you to everyone who has shown interest in this project!

✨ Features

• 🤖 Powerful AI Engine: Integrated with the specialized Pikafish for Xiangqi engine for a challenging gameplay experience.
• 💻 Cross-Platform Support: Runs on both Windows and Linux.
• ⚡ Smart Performance Optimization: The application automatically detects your CPU architecture to enable the corresponding optimized engine version.
• 🌐 Multi-language Support: Includes interfaces in Traditional Chinese, English, and Vietnamese.
• 🔊 Game Sound Effects(Only Chinese): Includes sound effects for actions like “check” and “capture” to enhance immersion.

🛠️ Tech Stack

• ⚡ Application Framework: Electron
• 🟢 Backend Environment: Node.js
• 🔌 Communication: Express + WebSocket
• ♟️ Chess AI: Pikafish Xiangqi Engine

🚀 Installation and Usage

Want to run this project on your computer? You can download a packaged version directly from Quick Download or the Releases section.
Support for macOS is not available at this time. If you really want macOS support, you can send me a MacBook Pro so I can build it. Alternatively, to run from the source code, please follow these steps:

1. Clone the repository

   git clone https://github.com/Augus1217/Chinese-Chess.git
   

2. Navigate to the project directory

   cd Chinese-Chess
   

3. Install dependencies

   npm install
   

4. Launch the application!

   npm start
   

📦 Building the Application

If you want to package the project into a standalone executable, run the following command:

npm run build

The packaged files will appear in the dist/ directory at the project root.

❤️ Acknowledgements

• The core AI functionality of this project comes from the powerful open-source Pikafish engine team.
• Thanks to the Gemini CLI for its assistance during the development process. It was like having a coding buddy who never gets tired and doesn’t steal my snacks.

---

中華象棋 (Chinese Chess)

這是一個使用 Electron 和 Pikafish 象棋引擎打造的桌面版中國象棋（Xiangqi）應用程式。

⬇️ 快速下載 (v1.5.0)

• 🪟 Windows 可攜版
• 🪟 Windows 安裝程式(.exe)
• 🪟 Windows 安裝程式(.msi)
• 🐧 Linux AppImage
• 🐧 Linux snap store
• 🐧 Linux deb(Ubuntu/Debian)
• 🐧 Linux rpm(Fedora/RHEL/Cent OS)

大家好，我是本專案的開發者 Augus，來自台灣。
這是我在國小升國中的暑假期間，透過與 Gemini CLI 協作完成的專案。（順帶一提，這比寫暑假作業有趣多了！）隨著開學，我即將成為一名國中生，課業將會變得更加繁重，因此我將沒有足夠的時間繼續維護和更新這個專案。

非常感謝所有關注這個專案的人！

✨ 功能特色

• 🤖 強大的 AI 引擎: 內建為象棋特製化的 Pikafish 引擎，提供極具挑戰性的對弈體驗。
• 💻 跨平台支援: 可在 Windows 和 Linux 系統上執行。
• ⚡ 智慧效能優化: 應用程式會自動偵測你的 CPU 架構，並啟用對應的最佳化引擎版本。
• 🌐 多國語言: 內建繁體中文、英文、越南文等多種語言介面。
• 🔊 遊戲音效: 包含將軍、吃子等音效，增加遊戲沉浸感。

🛠️ 技術棧

• ⚡ 應用程式框架: Electron
• 🟢 後端環境: Node.js
• 🔌 通訊: Express + WebSocket
• ♟️ 象棋 AI: Pikafish Xiangqi Engine

🚀 安裝與執行

想在您的電腦上執行本專案嗎？可直接至上面的快速下載或專案的 Releases 頁面下載已打包好的版本。
很遺憾，本應用程式目前不支援 macOS。 如果你想讓它支援MacOS，你可以送我一台Macbook Pro，讓我進行建置。 若想從原始碼執行，請依照以下步驟操作：

1. 複製專案庫

   git clone https://github.com/Augus1217/Chinese-Chess.git
   

2. 進入專案目錄

   cd Chinese-Chess
   

3. 安裝相依套件

   npm install
   

4. 啟動應用程式！

   npm start
   

📦 打包應用程式

如果你想將專案打包成獨立的檔案，可以執行以下指令：

npm run build

打包完成後，對應平台的安裝檔會出現在根目錄下的 dist/ 資料夾中。

❤️ 致謝

• 本專案的核心 AI 功能來自強大的 Pikafish 開源象棋引擎團隊。
• 感謝 Gemini CLI 在開發過程中提供的協助，就像有個不會累、也不會偷吃我零食的程式碼夥伴。

---