wiliwili 项目使用教程

wiliwili 项目使用教程

wiliwili专为手柄控制设计的第三方跨平台B站客户端，目前可以运行在PC全平台、PSVita、PS4 和 Nintendo Switch上项目地址:https://gitcode.com/gh_mirrors/wi/wiliwili

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

wiliwili 项目的目录结构如下：

wiliwili/
├── docs/
│   └── images/
├── library/
├── resources/
├── scripts/
├── winrt/
├── .clang-format
├── .cmake-format.py
├── .flatpak-manifest.yml
├── .gitignore
├── .gitmodules
├── CMakeLists.txt
├── LICENSE
├── README.md
├── _config.yml
├── uwp.lua
├── xmake.lua

目录介绍

• docs/: 存放项目文档，特别是 images/ 子目录用于存放文档中的图片。
• library/: 存放项目依赖的库文件。
• resources/: 存放项目资源文件。
• scripts/: 存放项目脚本文件。
• winrt/: 存放与 Windows 运行时相关的文件。
• .clang-format: 代码格式化配置文件。
• .cmake-format.py: CMake 格式化脚本。
• .flatpak-manifest.yml: Flatpak 打包配置文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• CMakeLists.txt: CMake 构建配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• _config.yml: 项目配置文件。
• uwp.lua: 与 UWP 平台相关的配置文件。
• xmake.lua: xmake 构建工具的配置文件。

2. 项目的启动文件介绍

项目的启动文件通常是 CMakeLists.txt，它定义了项目的构建过程和依赖关系。以下是 CMakeLists.txt 的基本内容介绍：

cmake_minimum_required(VERSION 3.10)
project(wiliwili)

# 添加子目录
add_subdirectory(library)
add_subdirectory(resources)
add_subdirectory(scripts)
add_subdirectory(winrt)

# 设置编译选项
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# 添加可执行文件
add_executable(wiliwili main.cpp)

# 链接库
target_link_libraries(wiliwili PRIVATE library)

启动文件介绍

• cmake_minimum_required(VERSION 3.10): 指定 CMake 的最低版本要求。
• project(wiliwili): 定义项目名称。
• add_subdirectory(library): 添加子目录，用于包含库文件。
• add_executable(wiliwili main.cpp): 定义可执行文件及其入口文件 main.cpp。
• target_link_libraries(wiliwili PRIVATE library): 链接项目所需的库。

3. 项目的配置文件介绍

项目的配置文件主要包括 .clang-format、.cmake-format.py、.flatpak-manifest.yml、.gitignore、.gitmodules、CMakeLists.txt、_config.yml、uwp.lua 和 xmake.lua。

配置文件介绍

• .clang-format: 用于代码格式化的配置文件。
• .cmake-format.py: 用于格式化 CMake 文件的脚本。
• .flatpak-manifest.yml: 用于 Flatpak 打包的配置文件。
• .gitignore: 用于指定 Git 忽略的文件和目录。
• .gitmodules: 用于管理 Git 子模块。
• CMakeLists.txt: 用于定义项目的构建过程和依赖关系。
• _config.yml: 项目配置文件，可能包含项目的各种设置。
• uwp.lua: 与 UWP 平台相关的配置文件。
• xmake.lua: 用于 xmake 构建工具的配置文件。

以上是 wiliwili 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

wiliwili专为手柄控制设计的第三方跨平台B站客户端，目前可以运行在PC全平台、PSVita、PS4 和 Nintendo Switch上项目地址:https://gitcode.com/gh_mirrors/wi/wiliwili