Update readme

This commit is contained in:
StageGuard
2020-08-11 22:47:59 +08:00
parent a79a8d10e8
commit b383c98412

View File

@@ -2,9 +2,19 @@
A script to play Sheets generated by SkyStudio automatically in game Sky with accessibility services using Auto.js
</br>使用Auto.js提供的无障碍权限实现在Sky光遇中自动弹奏[SkyStudio](https://play.google.com/store/apps/details?id=com.Maple.SkyStudio)导出的曲谱
## 特性
相比于其他脚本SkyAutoPlayerScript拥有以下优势
* 全GUI操作无需编辑任何代码流畅的UI动画。
* 完整的弹奏控制面板,支持**暂停** **进度控制** **倍速控制**等
* 自设定键位坐标,避免按压琴键的偏移问题
* 在线[共享乐谱](https://github.com/StageGuard/SkyAutoPlayerScript/tree/master/shared_sheets),有许多优质乐谱。</br>~~(甚至有的乐谱复杂到根本无法手弹)~~
* 自动更新及时修复BUG无需担心版本过时问题。
* ...
## 使用
①为Auto.js开启**无障碍服务**和**悬浮窗权限**。
</br>②在Auto.js中新建一个脚本并粘贴以下代码
</br>②在Auto.js中新建一个脚本并粘贴以下代码并运行
```javascript
"ui";
"use strict";
@@ -40,6 +50,32 @@ storages.remove("StageGuard:SkyAutoPlayer:Config");
files.removeDir("/storage/emulated/0/Documents/SkyAutoPlayer/");
```
## 上传乐谱
你可以fork本仓库将你要上传的乐谱添加至`shared_sheets`文件夹,并按照以下要求在`shared_sheets.json`添加项目
```json
{
//乐谱名称
"name": "SheetName",
//乐谱文件名(于shared_sheets文件夹中)
"file": "SheetName.txt",
//你的id
"author": "Author",
//乐谱简介
"desc": "This is a description about my sheet",
//乐谱BPM
"bpm" : 320,
//暂时没用
"suggested_instrument": 1,
//乐谱音高
"pitchLevel": 0
}
```
修改完成后,申请`Pull Request`等待merge即可。
> 请注意:在申请`Pull Request`之前请确保你的SkyAutoPlayerScript仓库已同步至最新以免出现意外问题
## 注意
### 请仔细阅读以下使用须知!
@@ -56,7 +92,7 @@ files.removeDir("/storage/emulated/0/Documents/SkyAutoPlayer/");
[Iconfont-阿里巴巴矢量图标库](https://www.iconfont.cn/)
## 鸣谢
[projectXero](https://gitee.com/projectXero)
[projectXero](https://gitee.com/projectXero) (提供适用于Rhino的`ListAdapter`)
## 许可证协议
```