pfUI 开源项目使用教程
1. 项目的目录结构及介绍
pfUI 项目的目录结构如下:
pfUI/
├── addons/
│ ├── pfUI/
│ │ ├── api/
│ │ ├── core/
│ │ ├── modules/
│ │ ├── skins/
│ │ ├── thirdparty/
│ │ ├── locale/
│ │ ├── media/
│ │ ├── pfUI.toc
│ │ └── README.md
│ └── ...
├── .gitignore
├── LICENSE
├── README.md
└── ...
目录结构介绍
- addons/: 存放所有插件的目录。
- pfUI/: pfUI 插件的主要目录。
- api/: 存放 pfUI 的 API 文件。
- core/: 存放 pfUI 的核心代码文件。
- modules/: 存放 pfUI 的各个模块代码文件。
- skins/: 存放 pfUI 的皮肤文件。
- thirdparty/: 存放第三方库文件。
- locale/: 存放 pfUI 的多语言文件。
- media/: 存放 pfUI 的媒体资源文件。
- pfUI.toc: pfUI 的 TOC 文件,定义了插件的元数据和加载顺序。
- README.md: pfUI 的介绍文件。
- pfUI/: pfUI 插件的主要目录。
- .gitignore: Git 忽略文件配置。
- LICENSE: 项目的开源许可证文件。
- README.md: 项目的介绍文件。
2. 项目的启动文件介绍
pfUI 的启动文件是 pfUI.toc
,它定义了插件的元数据和加载顺序。以下是 pfUI.toc
文件的部分内容:
## Interface: 11302
## Title: pfUI
## Author: Shagu
## Version: v3.5.0
## Notes: A complete user interface replacement for World of Warcraft: Vanilla & TBC
## SavedVariables: pfUI_profiles, pfUI_config, pfUI_cache, pfUI_playerDB, pfUI_globalDB
## OptionalDeps: LibSharedMedia-3.0, SharedMedia, SharedMediaAdditionalFonts, LibStub, CallbackHandler-1.0, LibDataBroker-1.1, LibDBIcon-1.0, LibQTip-1.0, LibRangeCheck-2.0, LibDualSpec-1.0, LibChatAnims
## X-Curse-Project-ID: 88039
## X-WoWI-ID: 23857
core/pfUI.lua
core/api.lua
core/init.lua
core/events.lua
core/hooks.lua
core/utils.lua
core/settings.lua
core/modules.lua
core/skins.lua
core/thirdparty.lua
core/locale.lua
core/media.lua
启动文件介绍
- Interface: 定义了插件支持的接口版本。
- Title: 插件的标题。
- Author: 插件的作者。
- Version: 插件的版本号。
- Notes: 插件的简要描述。
- SavedVariables: 定义了插件的保存变量。
- OptionalDeps: 定义了插件的可选依赖。
- X-Curse-Project-ID: CurseForge 项目 ID。
- X-WoWI-ID: WoWInterface 项目 ID。
3. 项目的配置文件介绍
pfUI 的配置文件主要通过 pfUI_config
变量进行保存。用户可以通过游戏内的配置界面进行设置,配置文件会自动保存到 WTF/Account/<AccountName>/SavedVariables/pfUI.lua
文件中。
配置文件介绍
- pfUI_config: 保存了 pfUI 的所有配置选项。
- pfUI_profiles: 保存了 pfUI 的配置文件。
- pfUI_cache: 保存了 pfUI 的缓存数据。
- pfUI_playerDB: 保存了玩家的数据库。
- pfUI_globalDB: 保存了全局数据库。
用户可以通过编辑 pfUI.lua
文件来手动修改配置,但建议使用游戏内的配置界面进行设置,以避免错误。
以上是 pfUI 开源项目的使用教程,希望对你有所帮助。