Aide Lua Pro 文档

插件文档 v4.0 (alpha)

  • PluginsManager 版本：v4.0

提示

您正在浏览 PluginsManager v4.0.0 版本文档，新版本 Aide Lua 结构发生了巨大变化，删除了旧版本的所有 API。如需浏览旧版本文档，请转到这里。

当前文档正在编写，敬请期待。

危险

PluginsManager v4.0 还正在制作。目前最新版本仍然用的是3.1版本。

本页内容
  • 插件完整模板
  • 插件模板 Lite

提示

  1. 本文档部分说明格式为 “变量名 (数据类型): 说明” 或 “数据类型: 说明”
  2. 标有 已废除 的表示已废除，相关 API 或方法已被移除
  3. 标有 <Badge type="danger" text="*" vertical="middle" / 的表示必须文件、方法 或 变量
  4. 部分 AndroLua+ 插件也可以使用，但是效果不好

警告

已废除的 API 无法继续使用，因此您需要进行特殊的判断，请谨慎提高 targetcode ，以免造成用户体验下降，甚至用户数据丢失

建议最低的最低适配软件版本

我们强烈建议从 v5.2.0(52099) 或以上 开始适配，因为在 v5.2.0 发生了翻天覆地的变化，软件架构及运行逻辑发生了巨大变化。

手动导入

  1. 打开文件管理，进入 内部存储/Android/media/com.jesse205.aidelua2/files/plugins ，如果没有此文件夹就手动新建一个
  2. 下载插件（扩展名通常为 zip 或 alp ，当然也不排除还有其他扩展名）
  3. 使用 zip 格式打开插件，打开 init.lua 文件，复制 packagename (包名) 的参数（ = 后面，不带引号）
  4. 在 plugins 文件夹 里面新建文件夹，重命名为 插件的 packagename (就是刚刚复制的文字)
  5. 解压插件内所有的文件，到第4步新建的文件夹
  6. 重启 Aide Lua（需要强制停止后重启）

警告

插件解压文件夹必须与插件包名一致

注意事项

  1. 目标版本和最低版本请按实际情况填写。
  2. 宿主版本号（Version Code）符合 显示版本 迭代版本 ，其中 迭代版本 为 99 时代表正式版本。如 52099 代表 v5.2.0正式版。
  3. 扩展名应为 alp（兼容 Androlua+ 扩展）或 zip（Aide Lua 专属扩展）
  4. 为了防止污染全局变量，插件内直接赋值为插件的局部变量。如要访问或修改全局变量，请使用 _APP_G.xxx 和 _APP_G.xxx=xxx
  5. 插件管理器不会自动添加插件路径为环境变量。因此您不可以直接使用 import 或者 require
  6. 请充分利用 thirdplugins 变量，因为某些插件可能需要正确的执行顺序才能运行

插件结构

AideLua 插件在原版 AndroLua+ 的基础上再次改进。您的 AndroLua+ 插件可能可以在 Aide Lua 中运行。因为工程结构与编辑器不同，有相当一部分 AndroLua+ 不兼容 Aide Lua。

  • 插件完整模板.zip
    • pages
    • init.lua
    • main.lua
    • 敬请期待

内置插件

Jesse205 Library Support

Jesse205 框架的支持插件

AndroidX Support

通用 API

警告

请尽量避免使用 Jesse205 框架。因为 Jesse205 框架尚不稳定，每次改动都比较大，很容易引起插件报错。

PluginsManager table Manager

插件管理器

插件相关 API，也是支持插件运行的模块

常量说明
_VERSIONstring: 管理器版本
PLUGINS_PATHstring: 插件存放路径
PLUGINS_DATA_PATHstring: 插件数据存放路径

PluginsManager.getPluginDataPath(packageName:string)

获取插件数据目录

参数说明
packageNamestring: 插件包名。
返回值类型说明
string插件数据存放目录

PluginsManager.getPluginPath(packageName:string)

获取插件目录

参数说明
packageNamestring: 插件包名
返回值类型说明
string插件存放目录

PluginsManager.clearEnabledPluginPaths()

清除已启用插件列表，用于重新加载插件

PluginsManager.getEnabledPluginPaths()

获取已启用插件路径列表

返回值类型说明
String[]插件存放目录

activityName string

当前页面 (Activity) 标志，可能为 nil

值说明
main主页面
settings软件设置页面
newproject新建工程页面
viewclass查看类页面
about关于页面
layouthelper布局助手页面
javaapiJavaAPI 查看器页面

pluginDataPath string

插件数据目录，与 PluginsManager.getPluginDataPath(packageName) 完全相同

pluginPath string

插件目录，与 PluginsManager.getPluginPath(packageName) 完全相同

插件文件说明

README.md 文件

插件的说明文档

警告

说明文档的文件名只能是 README.md ，不能是 readme.md（部分分区类型可能会区分大小写）、 README.txt 或其他。

* init.lua 文件

插件入口，也用于存放模块信息的文件

变量说明：

  • * appname: string 插件
  • * packagename: string 插件包名
  • * appver: string 插件版本名
  • * appcode: string 插件版本号
  • mode: string 工程模式，始终为 "plugin"
  • managerversion: string PluginsManager 版本，此变量不起任何作用，当前为 "4.0"
  • thirdplugins: string[] 需要安装的第三方库
    • 内容: 插件的包名
  • supported2: table 支持的宿主字典。PluginsManager会通过此字段判断插件是否支持宿主。
    • 索引: 软件代号 (appTag)
    • 内容: table 支持的版本，mincode 为最低版本，targetcode 为最高版本
    • 注意: 无此字段的插件一律视为 AndroLua+ 的插件
-- 实例
supported2 = {
    aidelua = { mincode = 52000, targetcode = 52099 }
}
  • events: 全局事件

提示

全局事件与独立事件基本一致。

警告

  • init.lua 中执行中不会有各种内置变量，只有在执行后会将环境表设置为 metatable，自动继承 _APP_G 中部分变量
  • 在插件中，插件环境表即init.lua 所用环境表，_G 与 _ENV 都将返回 init.lua 所用环境表
彩蛋
软件代号 ( appTag )代指软件
aideluaAide Lua (Pro)
eddeluaEdde Lua (截止目前此app不支持插件)
alstudioAndroid Lua Studio (截止目前此app仅存于想象)
yunchu_jesse205云储 优化版 (截止目前此app不支持插件)
eddeyunchumanagerEdde 后台管理 (截止目前此app仅存于想象)
userstatistics用户统计 (截止目前此app仅存于想象)
goapk_jesse205GoApk (截止目前此app仅存于想象且已停止)
highapk良心APK (截止目前此app仅存于想象)
eddebrowserEdde 浏览器 (截止目前此app仅存于想象)
eddeconnectEdde 互联 (截止目前此app仅存于想象)
eddestudyEdde 学习桌面 (截止目前此app仅存于想象)
eddemusicEdde 音乐 (截止目前此app仅存于想象)
eddevideoEdde 视频 (截止目前此app仅存于想象)
eddebookEdde 阅读 (截止目前此app仅存于想象)
hellotool哈兔Box (截止目前此app不支持此类型插件)
androidbox安卓工具箱 (截止目前此app仅存于想象)

main.lua 文件

插件主页面

参数顺序 (...)说明
1项目路径
2文件路径

pages/ 文件夹

存放各个页面的独立配置的文件夹

  • 文件扩展名: lua
  • 文件名称: <页面标识>.lua
  • 文件示例: main.lua 、settings.lua ......
  • 更多请见 pages 目录