插件提交指南

Solar2D

您的插件将实时托管在 Corona 的构建服务器上，供所有 Solar2D 开发者立即使用。当 Solar2D 开发者创建一个需要您的插件的项目时，构建服务器将在构建过程中自动集成插件。

Solar2D Native

Solar2D Native 开发者必须在 native 项目中包含插件。根据目标平台，这可以采用多种形式：静态库 (iOS)、共享库 (macOS/Windows/Android) 或.jar 文件 (Android).

纯 Lua

如果您拥有使用 纯 Lua 编写插件(仅限 Lua 代码)，请参阅 创建 Lua 插件。

Native/混合

如果您的插件是用 native 代码或 hybrid native + Lua 编写的，应当通过已与您共享的 Bitbucket 仓库提交插件（该仓库的结构必须遵循特定的格式）。当您的仓库有更新时，您可以生成一个拉取请求。

为了帮助您开始，我们创建了一个 插件提交模板，其中包含 starter 文件，但缺少 plugins 二进制目录。从本质上讲，您应该使用以下结构打包您的 native/hybrid 插件文件

metadata.json

此 JSON 文件包含发行者的信息、插件在 Lua 中的名称以及其他相关信息，例如：

{
    "contact": "[email protected]",
    "url": "http://www.mycompany.com",
    "pluginName": "plugin.mylibrary",
    "publisherId": "com.mycompany"
}

metadata.lua

对于 本机/混合 插件，每个平台 metadata.lua 文件描述插件二进制文件属性。对于 Android、iOS 和 iOS 模拟器，需要此文件。

• 对于 Android，需要指定二进制文件的格式。目前支持 .jar 和 .so。此外，还可以指定需要修改以支持插件的 AndroidManifest.xml 文件中的元素。

• 对于 iOS 和 iOS 模拟器，metadata.lua 文件应该相同。在这两种情况下，都需要指定二进制文件的格式。目前仅支持静态库（.a）。

• 可以通过 coronaManifest 部分声明依赖项。这些插件将在 Corona 模拟器构建期间下载并与您自己的插件捆绑在一起。

• 插件提交模板 提供存根版本。以下是一些示例

-- Android
local metadata =
{
    plugin =
    {
        format = "jar",
        manifest = 
        {
            permissions = {},
            usesPermissions =
            {
                "android.permission.INTERNET",
                "android.permission.ACCESS_NETWORK_STATE",
                "android.permission.READ_PHONE_STATE",
            },
            usesFeatures = {},
            applicationChildElements =
            {
                -- Array of strings
                [[
                    <activity android:name="com.mycompany.MyActivity"
                    android:configChanges="keyboard|keyboardHidden"/>
                ]],
            },
        },
    },
    coronaManifest = {
        dependencies = {
            ["shared.memoryBitmap"] = "com.coronalabs",
        },
    },
}

return metadata

-- iOS / iOS Simulator
local metadata =
{
    plugin =
    {
        format = "staticLibrary",

        -- This is the name without the "lib" prefix
        -- In this case, the static library is called "libplugin_openudid.a"
        staticLibs = { "plugin_openudid", },

        frameworks = {},
        frameworksOptional = {},
    },
    coronaManifest = {
        dependencies = {
            ["shared.memoryBitmap"] = "com.coronalabs",
        },
    },
}

return metadata

Android 资源

对于 Android，资源可以在构建后放入生成的 .apk 中的 assets 或 res 目录中。

要将资源打包到 assets 目录中，请将资源放入下面指定的 assets 文件夹中。该目录结构将一直保存在构建过程中。

要将资源打包到 res 目录中，请将资源放入下面指定的 res 文件夹中。该 res 文件夹可以包含子文件夹，这些子文件夹是本机 Android 构建中的相同文件夹，例如 drawable、layout 等。

iOS 资源

若要将资源包含在 .app 捆绑包中，请将其放入下面指出的 resources 文件夹中。这些资源将相对于基本目录添加到捆绑包中。例如，如果您将 example.png 放入 resources 文件夹中，那么它将像 example.app/example.png 一样被包含。

选择版本

对于新插件，我们强烈建议您支持最新的公开版本。这可确保您的插件可供尽可能最广泛的用户使用。

多个版本

通常情况下，当您更新插件二进制文件时，您只需重新提交该插件。但是，偶尔会出现插件较新版本破坏向后兼容性，或者您的更新插件依赖于较新 Solar2D 编译 中提供的新的功能的情况。

在这种情况下，您应部署一个单独的插件二进制文件。该二进制文件将对应于 Solar2D 的不同的/较新编译版本。然后，开发者可以轻松获取该版本来访问插件的较新版本。按照这种方式，您可以保留旧版本插件二进制文件以保持向后兼容性。