yinwanxi / fas-rs-extension-module

fas-rs插件的模板仓库。Template repository for fas-rs extension.

fas-rs插件模板

• English

介绍

• 本仓库是项目fas-rs的插件系统的模板仓库
• 本仓库同时也是一个magisk/ksu模块的模板仓库，这是因为fas-rs插件推荐以独立模块的形式存在

API

• 插件脚本是自文档化的，查看对应版本的main.lua以获取API说明
• fas-rs 致力于保持向后兼容性。也就是说，即使更新的fas-rs发生了插件API更新，老的插件也依然能正常工作

插件api	最小fas-rs版本
v0(不声明api版本时的默认)	v2.3.0
v1	v3.0.0

使用

• magisk/ksu模块的标准可参考magisk官方说明，本仓库的模块模板开箱即用，如无特殊需求修改模块名和main.lua即可
• 插件实际被fas-rs调用的代码应全部在main.lua中编写
• main.lua是自文档化的，包含了如何编写插件脚本的说明
• 记得修改module/module.prop来更改模块名 & 模块id
• 执行bash ./package.sh即可打包模块，打包完成后模块位于output文件夹
• ps: 可以检查getprop fas-rs-installed的输出来确认用户是否安装了fas-rs

FAQ

• 为什么推荐以magisk/ksu模块的形式开发插件？

  • 有以下原因:
  • 模块的id是唯一的，因此避免了插件重名导致的相互冲突
  • 方便用户管理插件
  • 方便进行依赖检查，比如此模板在未安装fas-rs时会拒绝安装

• 可以通过别的方式制作插件吗/插件最基础的注册方式是什么？

  • 复制后缀为.lua的lua脚本到/dev/fas_rs/extensions文件夹(待它出现后)即可，要求和文档和main.lua相同
  • 当对/dev/fas_rs/extensions下的脚本进行删除/创建/修改等操作时，fas-rs会重新读取所有插件脚本，也就是说插件是可以即时更新的