mirror of
https://github.com/TriM-Organization/Musicreater.git
synced 2024-11-11 01:27:35 +08:00
更新文档
This commit is contained in:
EillesWan
parent
782395b6c9
commit
290db45c23
@ -22,27 +22,33 @@
|
||||
|
||||
1. 参数说明
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659974810147043475/运行.png>
|
||||
<img src=https://foruda.gitee.com/images/1674146209644269990/26b53aa7_9911226.png>
|
||||
|
||||
- midi路径：含有mid文件路径、文件名、后缀的完整文件路径，或者一个目录（demo可接受批量转换）。可以使用相对或绝对路径皆可
|
||||
- midi路径：含有mid文件路径、文件名、后缀的完整文件路径，或者一个目录（magicDemo可接受批量转换）。可以使用相对或绝对路径皆可
|
||||
|
||||
- 输出路径：输出文件夹的路径，不需要指示文件名
|
||||
|
||||
- 是否重置计分板：`1`或`0`（歌曲放完是否重置，推荐`1`）
|
||||
- 输出格式：目前的演示程序仅支持`BDX`结构和`MCPACK`包
|
||||
|
||||
- 进度条：是否启用进度条，以及自定义进度条样式。输入`0`或`False`表示不启用进度条，输入`1`或`True`表示使用默认进度条，其余的输入均表示使用输入的格式作为自定义的进度条样式
|
||||
|
||||
若不支持自定义，则仅能输入`0`或`1`表示“关闭”或“开启”
|
||||
- 播放方式：目前的转换库仅支持**计分板**和**延迟**的两种播放方式，具体地关于这些播放方式如何使用的问题，详见[生成文件的使用说明](./%E7%94%9F%E6%88%90%E6%96%87%E4%BB%B6%E7%9A%84%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E.md)
|
||||
|
||||
- 计分板名称：游戏内的计分板名称
|
||||
- 音量：小数数据，在0~1（包含首尾）的范围之内，用以表示播放音量大小。
|
||||
|
||||
- 音量：0-1之间的小数（含0，1）正常来说推荐`1`
|
||||
- 速度倍率：小数数据，其值不可为0，用以标记游戏中播放此音乐的速度
|
||||
|
||||
- 速度倍率：小数数据，其值不可为0，一般写`1`
|
||||
- 进度条：是否启用进度条。目前的转换库已经支持自定义进度条，但是当前的演示程序并不能做到这一点。具体的有关进度条自定义的内容，可以看[功能文档](./%E5%BA%93%E7%9A%84%E7%94%9F%E6%88%90%E4%B8%8E%E5%8A%9F%E8%83%BD%E6%96%87%E6%A1%A3.md#%E8%BF%9B%E5%BA%A6%E6%9D%A1%E8%87%AA%E5%AE%9A%E4%B9%89)中的相关部分自行修改参数。
|
||||
|
||||
- 玩家选择器：包括 `@x` 在内的全部选择器，即若要选择全部标签为`Holo`的玩家，则需要如此输入：`@a[tag=Holo]`
|
||||
- 计分板名称（仅计分板播放器）：游戏内的计分板名称
|
||||
|
||||
- 没有报错且在输出路径下找到mcpack或bdx即为生成成功：
|
||||
- 是否重置计分板（仅计分板播放器）：歌曲放完是否重置，推荐选择自动重置
|
||||
|
||||
- 玩家选择器（仅延迟播放器）：包括 `@x` 在内的全部选择器。例：若要选择全部标签为`Holo`的玩家，则需要如此输入：`@a[tag=Holo]`
|
||||
|
||||
- 作者（仅BDX结构）：音乐结构的生成作者
|
||||
|
||||
- 指令结构最大高度（仅结构输出）：生成音乐结构的最大堆叠高度，可以查看相关[结构部分的开发文档](./%E5%BA%93%E7%9A%84%E7%94%9F%E6%88%90%E4%B8%8E%E5%8A%9F%E8%83%BD%E6%96%87%E6%A1%A3.md#%E7%94%9F%E6%88%90%E6%96%87%E4%BB%B6%E7%BB%93%E6%9E%84##%E6%96%87%E4%BB%B6%E6%A0%BC%E5%BC%8F)了解详细知识。
|
||||
|
||||
- 没有报错且在输出路径下找到对应的文件即为生成成功：
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659973655881460036/输出.png>
|
||||
|
||||
@ -59,47 +65,8 @@
|
||||
|
||||
答2：详见问1，切换你所需要的播放器即可。
|
||||
|
||||
## 对于 进度条自定义 功能的说明
|
||||
## 查看开发文档
|
||||
|
||||
因为我们提供了可以自动转换进度条的功能，因此在这里给出进度条自定义参数的详细解释。
|
||||
|
||||
请注意，并非所有的演示样例程序都支持自定义进度条。
|
||||
|
||||
一个进度条，明显地，有**固定部分**和**可变部分**来构成。而可变部分又包括了文字和图形两种（当然，《我的世界》里头的进度条，可变的图形也就是那个“条”了）。这一点你需要了解，因为后文中包含了很多这方面的概念需要你了解。
|
||||
|
||||
进度条的自定义功能使用一个字符串来定义自己的样式，其中包含众多**标识符**来表示可变部分。
|
||||
|
||||
标识符如下（注意大小写）：
|
||||
|
||||
| 标识符 | 指定的可变量 |
|
||||
|---------|----------------|
|
||||
| `%%N` | 乐曲名(即传入的文件名)|
|
||||
| `%%s` | 当前计分板值 |
|
||||
| `%^s` | 计分板最大值 |
|
||||
| `%%t` | 当前播放时间 |
|
||||
| `%^t` | 曲目总时长 |
|
||||
| `%%%` | 当前进度比率 |
|
||||
| `_` | 用以表示进度条占位|
|
||||
|
||||
表示进度条占位的 `_` 是用来标识你的进度条的。也就是可变部分的唯一的图形部分。
|
||||
|
||||
**样式定义字符串**的样例如下，这也是默认的进度条的样式：
|
||||
|
||||
`▶ %%N [ %%s/%^s %%% __________ %%t|%^t]`
|
||||
|
||||
这是单独一行的进度条，当然你也可以制作多行的，如果是一行的，输出时所使用的指令便是 `title`，而如果是多行的话，输出就会用 `titleraw` 作为进度条字幕。
|
||||
|
||||
哦对了，上面的只不过是样式定义，同时还需要定义的是可变图形的部分，也就是进度条上那个真正的“条”。
|
||||
|
||||
对于这个我们就采用了固定参数的方法，对于一个进度条，无非就是“已经播放过的”和“没播放过的”两种形态，所以，使用一个元组来传入这两个参数就是最简单的了。元组的格式也很简单：`(str: 播放过的部分长啥样, str: 没播放过的部分长啥样)` 。例如，我们默认的进度“条”的定义是这样的：
|
||||
|
||||
`('§e=§r', '§7=§r')`
|
||||
|
||||
综合起来，把这些参数传给函数需要一个参数整合，你猜用的啥？啊对对对，我用的还是元组！
|
||||
|
||||
我们的默认定义参数如下：
|
||||
|
||||
`(r'▶ %%N [ %%s/%^s %%% __________ %%t|%^t]',('§e=§r', '§7=§r'))`
|
||||
|
||||
*对了！为了避免生成错误，请尽量避免使用标识符作为定义样式字符串的其他部分*
|
||||
目前仅仅提供了部分文档，不过相关函数的参数都是很清晰的，应该不难理解。
|
||||
|
||||
文档中介绍了关于生成结构和自定义进度条功能的内容，详见[此处](./%E5%BA%93%E7%9A%84%E7%94%9F%E6%88%90%E4%B8%8E%E5%8A%9F%E8%83%BD%E6%96%87%E6%A1%A3.md)。
|
||||
@ -6,12 +6,10 @@
|
||||
<img width="128" height="128" src="https://s1.ax1x.com/2022/05/06/Ouhghj.md.png" >
|
||||
</p>
|
||||
|
||||
**此为开发相关文档，内容包括：所生成文件结构的详细说明、特殊参数的详细解释**
|
||||
|
||||
# 生成文件结构
|
||||
|
||||
*由于先前的 **读我文件**(README.md) 过于冗杂，现另辟蹊径来给大家全方位的教程。*
|
||||
|
||||
*这是本库生成后文件结构的相关说明，不是使用本库的教程，若要查看**本库的演示程序**使用教程，可点击[此处](%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E.md)*
|
||||
|
||||
## 名词解释
|
||||
|
||||
|名词|解释|备注|
|
||||
@ -104,4 +102,51 @@
|
||||
|
||||
其中后四个参数决定了这个音的性质。
|
||||
|
||||
由于这样的延迟数据是依赖于指令方块的设置项，所以使用这种播放器所转换出的结果仅可以存储在包含方块NBT信息及方块实体NBT信息的结构文件中，或者直接输出至世界。
|
||||
由于这样的延迟数据是依赖于指令方块的设置项，所以使用这种播放器所转换出的结果仅可以存储在包含方块NBT信息及方块实体NBT信息的结构文件中，或者直接输出至世界。
|
||||
|
||||
|
||||
|
||||
# 进度条自定义
|
||||
|
||||
因为我们提供了可以自动转换进度条的功能，因此在这里给出进度条自定义参数的详细解释。
|
||||
|
||||
请注意，并非所有的演示样例程序都支持自定义进度条。
|
||||
|
||||
一个进度条，明显地，有**固定部分**和**可变部分**来构成。而可变部分又包括了文字和图形两种（当然，《我的世界》里头的进度条，可变的图形也就是那个“条”了）。这一点你需要了解，因为后文中包含了很多这方面的概念需要你了解。
|
||||
|
||||
进度条的自定义功能使用一个字符串来定义自己的样式，其中包含众多**标识符**来表示可变部分。
|
||||
|
||||
标识符如下（注意大小写）：
|
||||
|
||||
| 标识符 | 指定的可变量 |
|
||||
|---------|----------------|
|
||||
| `%%N` | 乐曲名(即传入的文件名)|
|
||||
| `%%s` | 当前计分板值 |
|
||||
| `%^s` | 计分板最大值 |
|
||||
| `%%t` | 当前播放时间 |
|
||||
| `%^t` | 曲目总时长 |
|
||||
| `%%%` | 当前进度比率 |
|
||||
| `_` | 用以表示进度条占位|
|
||||
|
||||
表示进度条占位的 `_` 是用来标识你的进度条的。也就是可变部分的唯一的图形部分。
|
||||
|
||||
**样式定义字符串**的样例如下，这也是默认的进度条的样式：
|
||||
|
||||
`▶ %%N [ %%s/%^s %%% __________ %%t|%^t]`
|
||||
|
||||
这是单独一行的进度条，当然你也可以制作多行的，如果是一行的，输出时所使用的指令便是 `title`，而如果是多行的话，输出就会用 `titleraw` 作为进度条字幕。
|
||||
|
||||
哦对了，上面的只不过是样式定义，同时还需要定义的是可变图形的部分，也就是进度条上那个真正的“条”。
|
||||
|
||||
对于这个我们就采用了固定参数的方法，对于一个进度条，无非就是“已经播放过的”和“没播放过的”两种形态，所以，使用一个元组来传入这两个参数就是最简单的了。元组的格式也很简单：`(str: 播放过的部分长啥样, str: 没播放过的部分长啥样)` 。例如，我们默认的进度“条”的定义是这样的：
|
||||
|
||||
`('§e=§r', '§7=§r')`
|
||||
|
||||
综合起来，把这些参数传给函数需要一个参数整合，你猜用的啥？啊对对对，我用的还是元组！
|
||||
|
||||
我们的默认定义参数如下：
|
||||
|
||||
`(r'▶ %%N [ %%s/%^s %%% __________ %%t|%^t]',('§e=§r', '§7=§r'))`
|
||||
|
||||
*对了！为了避免生成错误，请尽量避免使用标识符作为定义样式字符串的其他部分*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user