/touchsprite-extension

触动精灵插件 For VSCode

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

TouchSprite Extension

license version installs downloads

TouchSprite Extension ( 触动精灵开发插件 ) 是基于触动精灵官方的 API 库进行开发的第三方插件,为开发者提供在 VSCode 进行触动精灵脚本开发的条件。

目录

功能

  • ✅ 运行工程
  • ✅ 运行测试工程
  • ✅ 运行当前脚本
  • ✅ 停止运行
  • ✅ 上传文件
  • ✅ 清空脚本
  • ✅ 打包工程
  • ✅ 发布工程

使用

使用前

该插件仅针对触动方面进行扩展,由于市面上存在很多 Lua 相关插件,所以部分编写需求功能本插件不再提供,以下推荐比较常用的插件,配合本插件能获得更好的代码编写体验。

  • Lua : Lua 语言服务,该插件提供语法检测,代码高亮,悬停提示,代码补全,格式化等功能,推荐使用

初始化

以下功能需要先在设置中填写开发者 AccessKey 项,如果你不使用以下功能,请忽略。

  • 运行工程, 运行测试工程, 运行当前脚本, 停止运行, 上传文件, 清空脚本, 取色器截图

以下功能需要先在设置中填写开发者后台 Cookie 项,如果你不使用以下功能,请忽略。

  • 发布工程

开始使用

快捷键 Ctrl+Shift+P 调出输入框,输入 触动插件 ,以 触动插件 开头的命令均为本插件提供的命令。

插件启用后 点击左下角 触动插件 按钮,即可列出命令清单。

插件启用后 在 Lua 文件中点击 F5 F6 F7,会调用默认绑定的命令,具体请查看下方快捷键说明

AccessKey

进入触动开发者后台 - 个人中心 - API,即可看到 AccessKey,注意设备已满的话请先清空设备。

avatar

发布工程

发布工程前需要填写开发者后台 Cookie。

  1. 进入触动开发者后台

  2. 登陆,确认已经是登陆状态

  3. 网页中点击 右键 - 检查 调出开发者工具

  4. 选择 Network(网络) 标签页

    avatar

  5. 点击刷新按钮,等待刷新完毕

    avatar

  6. 找到 index 项,通常在首位,展开

    avatar

  7. 找到Headers - Request Headers - cookie 项,复制该项的值填入设置中即可,请使用选取复制而非右键复制,否则有可能会导致 cookie 无法识别

    avatar

  8. (可选) 发布工程会自动检测工程目录下的 luaconfig.lua 文件,该文件应返回一个表,id 字段 ( 普通工程 ) , idEnt 字段 ( 企业版工程 ) ,version 字段会被读取使用,如果该文件不存在或者无法读取,会导致发布失败

    e.g. luaconfig.lua

    return {
        id = '123456', --普通工程
        idEnt = '123456', --企业版工程
        version = '1.0.0', --工程版本号
    }

    如同一个工程需配置不同 ID 的配置,文件应返回表和索引,索引表示要使用哪个配置进行发布

    e.g. luaconfig.lua

    return ({
        {
            id = '123456',
            version = '1.0.0',
        },
        {
            id = '223456',
            version = '2.0.0',
        },
    })[1]
  9. (可选) 发布工程会自动检测工程目录下的 CHANGELOG.md 文件,该文件提供脚本的更新日志,最上层的版本更新日志会被读取使用,如果文件不存在或者无法读取,更新日志默认为“ ”(一个空格)

    e.g. CHANGELOG.md

    ## [1.0.1]
    
    -   新增 ...
    -   修复 ...
    
    ## [1.0.0]
    
    -   新增 ...
    -   修复 ...

    如果需要把日志作为最新版本的更新日志,则可以使用 [latest] 标签,插件会自动将 [latest] 更换成最新版的版本号

    e.g. CHANGELOG.md

    ## [latest]
    
    -   新增 ...
    -   修复 ...
    
    ## [1.0.0]
    
    -   新增 ...
    -   修复 ...

快捷键

以下快捷键为默认快捷键,如果热键被插件占用,请自行修改。

  • F5 运行测试工程
  • F6 运行工程
  • F7 停止运行

以下为 Snapshop v1 取色器快捷键

  • W A S D 移动光标
  • 1 - 9 / 鼠标左键 抓取颜色
  • Q E 选取点 1,2
  • Z 清空取色记录
  • X 清空点 1,2
  • F G H J K 生成颜色代码

Todo

  • [x] 重构触动 API 功能
  • [x] 优化信息反馈模块
  • [x] 多编辑器无法独立使用插件的问题
  • [x] 发布工程模块允许更多自定义
  • [x] 调试模块精简 1 期
  • [x] 字库代码生成
  • [x] 脚手架生成
  • [ ] 调试模块精简 2 期
  • [ ] 触动函数代码补全

插件目前由我一个人进行开发并进行维护,由于时间精力有限,难免会存在 BUG 以及一些其他问题。如果你发现了任何错误,或者愿意协助我开发插件,或者有什么更好的意见建议,请使用Issues或使用Pull Requests提交,同时也可以通过加群进行反馈。

插件 2.x 版本进行了重构,精简了许多使用频率极低且使用体验不怎么好的功能,并对上述 Todo 进行重新规划。如仍需使用已被移除的功能请安装旧版插件,已被移除的功能会在找到更好的解决方案时重新添加。

3.0 版本已发布。

Contribution

License

GNU General Public License version 3 @AuTsing

声明

插件仅供学习交流使用,使用过程中请遵守相关法律法规;插件为开源软件,不会保存和上传关于你的任何内容。如果你不同意,请立即停止使用并删除插件。

如果你对插件内容有任何异议,请提交Issues,或请联系我。

Enjoy!