Sunshine 项目使用教程

Sunshine 项目使用教程

Sunshine Sunshine is a Gamestream host for Moonlight. 项目地址: https://gitcode.com/gh_mirrors/sunshine5/Sunshine

1. 项目目录结构及介绍

Sunshine 项目的目录结构如下：

• cmake: 存放 CMake 构建系统的相关文件。
• docker: 存放 Docker 相关的配置和脚本文件。
• docs: 项目文档。
• gh-pages-template: GitHub Pages 的模板文件。
• packaging: 软件打包相关文件。
• scripts: 执行项目构建、测试等操作的脚本文件。
• src: 源代码目录，包含项目的核心实现。
• src_assets: 存放项目所需的资源文件。
• tests: 测试代码目录。
• third-party: 存放第三方库和依赖。
• tools: 开发工具和辅助工具。
• .clang-format: Clang 格式化配置文件。
• .codeql-prebuild-cpp-xxx.sh: CodeQL 预构建脚本（针对不同操作系统）。
• .dockerignore: Docker 忽略文件。
• .flake8: Python linter 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件。
• .gitmodules: Git 子模块配置文件。
• .prettierrc.json: Prettier 配置文件。
• .readthedocs.yaml: Read the Docs 配置文件。
• .rstcheck.cfg: reStructuredText linter 配置文件。
• CMakeLists.txt: CMake 主配置文件。
• DOCKER_README.md: Docker 使用说明。
• LICENSE: 项目许可证文件。
• NOTICE: 项目通知文件。
• README.md: 项目说明文件。
• codecov.yml: CodeCov 配置文件。
• crowdin.yml: Crowdin 配置文件。
• package.json: Node.js 项目配置文件。
• sunshine.icns、sunshine.ico、sunshine.png、sunshine.svg: 项目图标文件。
• toolchain-mingw64.cmake: MinGW-w64 构建工具链配置文件。
• vite.config.js: Vite 配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 src 目录下，具体文件可能因项目具体实现而异。以下是一个通用的启动文件介绍：

• main.cpp: 项目的主入口文件，包含主要的程序逻辑。

在命令行中，可以使用以下命令编译和运行项目：

cmake .
make
./sunshine

3. 项目的配置文件介绍

项目的配置文件位于项目根目录或相关配置目录下，以下是一些常见的配置文件：

• config.json: 项目通用配置文件，包含项目运行的各项参数设置。
• CMakeLists.txt: CMake 构建系统配置文件，用于指定编译选项和依赖。

配置文件的具体内容可能如下：

{
  "server_port": 8080,
  "database": {
    "host": "localhost",
    "port": 3306,
    "user": "root",
    "password": "password",
    "db_name": "sunshine_db"
  }
}

以上内容为 Sunshine 项目的使用教程，包括项目目录结构、启动文件和配置文件的介绍。请根据实际项目需求进行调整和补充。

Sunshine Sunshine is a Gamestream host for Moonlight. 项目地址: https://gitcode.com/gh_mirrors/sunshine5/Sunshine