Musicreater/docs/功能使用说明.md

<h1 align="center">音·创 Musicreater</h1>

<h2 align="center">库版 Package Version</h2>

<p align="center">
<img width="128" height="128" src="https://s1.ax1x.com/2022/05/06/Ouhghj.md.png" >
</p>

# 演示程序使用教程

*由于先前的 **读我文件**(README.md) 过于冗杂，现另辟蹊径来给大家全方位的教程。*

*这是演示程序（demo）的使用教程，将在这里提供演示程序的相应的使用教程*

## 下载与启动教程

### [视窗(Windows)操作系统](./download%26start/Windows.md)
### [里纽克斯(Linux)与其衍生操作系统](./download%26start/Linux.md)
### [安卓(Android)与其衍生操作系统](./download%26start/Android.md)

## 演示程序使用教程

1.	参数说明

<img src=https://foruda.gitee.com/images/1674146209644269990/26b53aa7_9911226.png>

-	midi路径：含有mid文件路径、文件名、后缀的完整文件路径，或者一个目录（magicDemo可接受批量转换）。可以使用相对或绝对路径皆可

-	输出路径：输出文件夹的路径，不需要指示文件名

-	输出格式：目前的演示程序仅支持`BDX`结构和`MCPACK`包

-	播放方式：目前的转换库仅支持**计分板**和**延迟**的两种播放方式，具体地关于这些播放方式如何使用的问题，详见[生成文件的使用说明](./%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，用以标记游戏中播放此音乐的速度

-	进度条：是否启用进度条。目前的转换库已经支持自定义进度条，但是当前的演示程序并不能做到这一点。具体的有关进度条自定义的内容，可以看[功能文档](./%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]`

-   作者（仅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>


# 其他说明

## 对于 延迟播放器 的说明

问1：什么是延迟播放器？

答1：播放音乐，不同的音符之间存在间隔，可以用不同的方式实现音符间空白的时间。其一是计分板，通过给计分板加分，对应分数播放对应的音符就可以间隔到，还有就是命令方块自带的延迟，这样也可以实现音符间空白。延迟播放器即后者，但是因为只能对命令方块写入这样的延迟数据，所以仅可以使用包含NBT的结构导出或者直接输出至世界。

问2：可不可以不要积分板？

答2：详见问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)。