Secret Chronicles (TSC) 游戏安装与编译指南

项目概述

Secret Chronicles (简称TSC) 是一款2D平台冒险游戏，采用现代C++技术栈开发。本文将详细介绍如何在不同平台上编译和安装TSC游戏，包括Linux系统和Windows系统下的完整流程。

一、系统依赖准备

1. 基础依赖组件

TSC构建需要以下核心依赖库，这些是跨平台必需的组件：

• Ruby环境：用于构建mruby脚本引擎（除非使用预编译的mruby）
• 构建工具链：pkg-config、bison、gperf
• 图形库：OpenGL、GLEW扩展库
• 多媒体处理：LibPNG图像库、DevIL图像加载库
• 文本处理：GNU Gettext、PCRE正则表达式库
• XML处理：Expat、libxml++ (<3.0.0版本)
• 字体渲染：Freetype库
• Boost组件：需要1.50.0以上版本的system、filesystem和thread库
• SFML：多媒体库2.3.0以上版本
• X11开发头文件：libx11和libxt

各Linux发行版安装示例

Fedora系统：

sudo dnf install ruby rubygem-rake gperf pkgconf bison libGLEW \
freeglut-devel gettext libpng-devel pcre-devel libxml++-devel \
freetype-devel DevIL-devel boost SFML-devel gcc-c++ \
cegui-devel cmake @development-tools git libXt-devel

Debian/Ubuntu系统：

sudo apt install ruby-full rake gperf pkg-config bison libglew-dev \
freeglut3-dev gettext libpng-dev libpcre3-dev libxml++2.6-dev \
libfreetype6-dev libdevil-dev libboost1.58-all-dev libsfml-dev \
libxt-dev libexpat1-dev cmake build-essential git git-core

2. Windows特有依赖

在Windows平台构建时还需要：

• FreeImage图像库
• NSIS安装包生成工具（用于创建安装程序）

二、构建配置选项

TSC提供多种CMake配置选项，适合不同使用场景：

选项名称	默认值	说明
ENABLE_SCRIPT_DOCS	OFF	是否构建脚本API文档
ENABLE_NLS	ON	是否启用多语言支持
USE_SYSTEM_MRUBY	OFF	使用系统mruby而非内置版本
USE_SYSTEM_CEGUI	OFF	使用系统CEGUI而非内置版本
USE_LIBXMLPP3	OFF	实验性支持libxml++3.0

重要路径配置：

• CMAKE_INSTALL_PREFIX：安装根目录（默认/usr/local）
• CMAKE_INSTALL_BINDIR：可执行文件目录
• CMAKE_INSTALL_DATADIR：游戏数据目录

特别注意：Windows平台不要修改BINDIR和DATADIR，否则游戏无法找到资源文件。

三、从发布包安装

1. 解压发布包并创建构建目录：

tar -xvJf TSC-*.tar.xz
cd TSC-*/tsc
mkdir build
cd build

2. 配置并构建：

cmake -DCMAKE_INSTALL_PREFIX=/opt/tsc ..
make -j$(nproc)
sudo make install

3. 运行游戏：

/opt/tsc/bin/tsc

如需调试版本，在cmake时添加-DCMAKE_BUILD_TYPE=Debug参数。

四、从Git源码安装

1. 克隆仓库并初始化子模块：

git clone --recursive git://github.com/Secretchronicles/TSC.git
cd TSC/tsc
mkdir build
cd build

2. 构建安装：

cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/opt/tsc ..
make -j$(nproc)
sudo make install

五、Windows平台构建指南

1. 准备MSYS2环境

1. 安装MSYS2基础系统
2. 更新系统组件：

pacman -Syuu

（可能需要重复执行直到完全更新）

2. 安装依赖项

64位和32位构建所需依赖：

pacman -S --needed git base-devel bison ruby mingw-w64-x86_64-{toolchain,extra-cmake-modules,ruby,cegui,sfml,libxml++2.6,gperf,doxygen,graphviz,nsis,qt5} mingw-w64-i686-{toolchain,extra-cmake-modules,ruby,cegui,sfml,libxml++2.6,gperf,doxygen,graphviz,nsis,minizip-git}

3. 构建TSC

克隆仓库：

git clone --recursive git://github.com/Secretchronicles/TSC.git

选择对应架构的MSYS2终端（64位或32位）执行构建：

调试版本：

rm -rf TSC/tsc/build && mkdir TSC/tsc/build && cd TSC/tsc/build && cmake -DCMAKE_BUILD_TYPE=Debug -G "MSYS Makefiles" .. && make -j$(nproc) && make package

发布版本：

rm -rf TSC/tsc/build && mkdir TSC/tsc/build && cd TSC/tsc/build && cmake -DCMAKE_BUILD_TYPE=Release -G "MSYS Makefiles" .. && make -j$(nproc) && make package

构建完成后，安装程序将生成在build目录下。

六、升级注意事项

升级前建议备份用户数据：

cp -r ~/.local/share/tsc ~/backup-tsc

Git仓库升级流程：

git pull
git submodule update
cmake ..
make
make install

切换分支时建议清理构建目录：

cd ..
git checkout feature-branch
rm -rf build
mkdir build
cd build
cmake [OPTIONS] ..
make
make install

通过以上步骤，您可以在不同平台上成功构建和运行Secret Chronicles游戏。如果在构建过程中遇到问题，建议检查依赖版本是否符合要求，并确保构建环境配置正确。