PAX_SAPIENTICA 项目安装与使用教程

1. 项目的目录结构及介绍

PAX_SAPIENTICA 项目的目录结构如下：

PAX_SAPIENTICA/
├── Data/
├── Documents/
├── ExternalLibrary/
├── Images/
├── Library/
├── Projects/
├── Scripts/
├── github/workflows/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .gitmodules
├── CONTRIBUTING.md
├── LICENSE_for_Library_directory.txt
├── README.md
├── README_JP.md

目录介绍

• Data/: 存放项目的数据文件。
• Documents/: 存放项目的文档文件。
• ExternalLibrary/: 存放外部库文件。
• Images/: 存放项目的图像文件。
• Library/: 存放项目的核心库文件。
• Projects/: 存放项目的子项目文件。
• Scripts/: 存放项目的脚本文件。
• github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• .editorconfig: 编辑器配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE_for_Library_directory.txt: 库目录的许可证文件。
• README.md: 项目的主 README 文件。
• README_JP.md: 项目的日文 README 文件。

2. 项目的启动文件介绍

PAX_SAPIENTICA 项目支持 GUI 和 CUI 两种启动方式。

GUI 启动

GUI 启动需要依赖以下库之一：

• SFML: 使用 CMake 构建。
• OpenSiv3D: 测试版本为 v0.6.13 和 Visual Studio Community 2022 v17.8.3。
• DxLib: 支持 Windows 和 Android 版本。

选择上述任意一个库，按照其官方文档进行安装和配置，然后运行相应的启动文件即可启动 GUI 界面。

CUI 启动

CUI 启动需要通过 CMake 构建项目。具体步骤如下：

1. 克隆项目仓库：

   git clone https://github.com/AsPJT/PAX_SAPIENTICA.git
   

2. 进入项目目录：

   cd PAX_SAPIENTICA
   

3. 使用 CMake 构建项目：

   cmake .
   make
   

4. 运行生成的可执行文件。

3. 项目的配置文件介绍

PAX_SAPIENTICA 项目的配置文件主要包括以下几个：

• .editorconfig: 用于统一代码风格的配置文件。
• .gitattributes: 用于指定 Git 属性，如文件的换行符处理等。
• .gitignore: 用于指定 Git 忽略的文件和目录。
• .gitmodules: 用于管理 Git 子模块。
• CONTRIBUTING.md: 贡献指南文件，包含如何参与项目开发的说明。
• LICENSE_for_Library_directory.txt: 库目录的许可证文件，说明库目录下的代码使用 CC0 许可证。
• README.md: 项目的主 README 文件，包含项目的基本介绍和使用说明。
• README_JP.md: 项目的日文 README 文件，包含项目的基本介绍和使用说明。

这些配置文件帮助开发者统一项目风格、管理代码版本和提供项目的基本信息。