CheatDeck 项目使用教程

1. 项目目录结构及介绍

CheatDeck 项目是一个为 Steam Deck 设计的插件，用于方便地使用作弊码或训练器以及管理启动选项。以下是项目的目录结构及其介绍：

• docs/：存放项目文档的目录。
• .github/：包含 GitHub 工作流程文件的目录。
• src/：存放项目源代码的目录。
• .vscode/：包含 Visual Studio Code 项目的配置文件。
• eslint.config.js：ESLint 配置文件，用于代码质量检查。
• gitignore：Git 忽略文件，指定 Git 应该忽略的文件和目录。
• LICENSE：项目使用的开源协议文件，本项目采用 GPL-3.0 协议。
• README.md：项目说明文件。
• decky.pyi：可能与 Decky 插件格式相关的类型定义文件。
• main.py：项目的主要 Python 文件，包含插件的主体逻辑。
• package.json：项目包配置文件，用于定义项目的元数据和依赖。
• plugin.json：插件配置文件，定义了插件的基本信息。
• pnpm-lock.yaml：pnpm 包管理器锁文件。
• rollup.config.js：Rollup 打包配置文件。
• settings.pyi：插件设置相关的类型定义文件。
• tsconfig.json：TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 main.py。该文件负责初始化插件，并处理用户与插件的交互。在 main.py 文件中，通常包含以下内容：

• 插件的初始化代码。
• 事件监听器，用于响应 Steam Deck 的用户操作。
• 功能实现的逻辑，如启用作弊码、选择作弊文件等。

3. 项目的配置文件介绍

项目的配置文件主要包括 settings.pyi 和 plugin.json。

• settings.pyi：该文件包含插件设置的类型定义，用于指定插件在运行时可以配置的选项和数据类型。

• plugin.json：该文件定义了插件的基本信息，如插件的名称、版本、作者、描述等。同时，它还可能包含了插件的图标和启动界面的配置。这是插件在 Decky Loader 中展示的关键文件。

通过正确配置这些文件，可以确保插件在 Steam Deck 上正常运行，并提供友好的用户界面。