分发插件

为了使您的插件能够服务于更广泛的用户,您应该考虑分发生成二进制版本的插件。

创建二进制文件

如果您的插件在多个平台上运行并正常工作,您应该提供所有支持平台的二进制版本。

Qt Creator 当前支持

  • Windows
  • Linux
  • macOS

有关更详细的列表,请参阅 Qt Creator 源代码顶级README.md 文件。

Qt Creator 插件 向导已创建一个模板,用于 GitHub Actions,可用于在您在 GitHub 上托管插件源代码时创建二进制文件。有关详细信息,请参阅在相同位置创建的 README.md

您还可以使用提供的 GitHub Actions 脚本作为其他构建服务的灵感。

打包

包装您的插件最简单的方式是提供一个用户可以解包到正确位置的 zip 文件。通过在 帮助 > 关于插件 对话框(或在 macOS 上的 Qt Creator > 关于插件)中提供 安装插件 按钮,Qt Creator 使用户很容易进行操作。用户选择包含插件的 zip 文件,Qt Creator 将其解包到适当的位置。

以下部分描述了您可以为插件内容布局选择选项。

单个库

使用单个库是首选和最简单的选项。您提供一个包含所有必需资源(利用 Qt 资源系统 编译)的单一插件库文件。这存在一些限制,因为您不能依赖额外的二进制文件,也不能扩展依赖于外部文件的 Qt Creator 的某些部分,如通用高亮器。您仍然可以通过将 资源目录的路径 添加到您的 QRC 文件中,通过 ProjectExplorer::JsonWizardFactory::addWizardPath() 来添加向导模板。可以在类似的方式中注册文档和翻译。

摘要

  • zip 文件中的一个单独项目为单个库。
  • 使用 Qt 资源系统 编译进库中。
  • 可以为本机和所有兼容的 Qt Creator 安装安装。
  • 可以安装到 Qt Creator 中,供所有用户使用。

遵循 Qt Creator 文件系统布局的多个文件

这是一个关于插件能做什么的更灵活的解决方案,但设置起来更复杂。这允许插件包含额外的二进制文件和任意的资源。

由于各个平台之间的文件系统布局差异很大,Qt Creator的构建系统提供了诸如IDE_DATA_PATHIDE_LIBEXEC_PATH之类的变量。如果您使用CMake构建插件,应使用提供的add_qtc_libraryadd_qtc_executable以及类似的函数。

在运行时,您可以使用Core::ICore::resourcePath() 和 Core::ICore::libexecPath() 访问这些与平台相关的位置。

以这种方式分发的插件不能在单个用户本地安装。它们必须直接安装到Qt Creator的安装中。

摘要

  • 遵循标准文件系统布局的多个文件。
  • 在构建系统中使用Qt Creator特定的变量和函数。
  • 在运行时使用Core::ICore找到位置。
  • 只能安装到所有用户的Qt Creator安装中。

©2024年Qt公司有限制。此处包含的文档贡献是其各自所有者的版权。此处提供的文档根据自由软件开发基金会发布并由自由软件基金会发布的GNU自由文档许可协议第1.3版的条款进行许可。Qt及其相关标志是芬兰和/或其他国家/地区的Qt公司的商标。所有其他商标均为其各自所有者的财产。