Musicreater/docs/使用教程.md

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

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


## 使用教程📕

> 0. 安装python3.6+
>    
>    在安装时，一定要勾选Add Python 3.X to PATH，不然就要手动设置！！
>    
>    同时，装完之后记得在cmd中输入：python 试试是否安装成功，
>    python的安装可以去网上随便找一下。
>    成功安装之后，在cmd中输入python会显示：
>    <img src=https://foruda.gitee.com/images/1659972669907359295/cmd.png>
>    之类的东西。
> 1. 下载本程序
>   
>   git的话，可以使用以下命令：
> 
> `git clone -b pkgver https://gitee.com/EillesWan/Musicreater.git`
> 
> 没有安装git的话，可以下载zip包，解压后进入目录即可。
> <img src=" https://foruda.gitee.com/images/1659972440341216712/下载.png" >
> 2. 运行（进入目录）
> 在目录下打开cmd，进入到目录下，执行以下命令：
> <img src=https://foruda.gitee.com/images/1659974437388532868/输入.png>
> <img src=https://foruda.gitee.com/images/1659974754378201859/输入c.png>
> 回车一下，然后：
> <img src=https://foruda.gitee.com/images/1659974794561970425/pip.png>
> 输入下面的三个指令即可！
> 
> `pip install mido`
> 
> `pip install brotli`
> 
> `pip install openpyxl`
> 
> 3. 开始使用！
> 在目录下打开cmd（步骤与上面的图片一致，只是执行的代码换了），进入到目录下，执行以下命令：(选择你需要的)
> 
> `python example_convert_bdx.py`
> 
> `python example_convert_mcpack.py`
> 
> 4. 错误补充说明
> 如果你遇到了以下这种情况
> <img src=https://foruda.gitee.com/images/1659972789779764953/bug.jpeg>
> 那么，请按照这篇文章指引做：
> https://blog.csdn.net/qq_41179280/article/details/123804948
> 
> 感谢Mono帮我们发现这个问题
> 
> 5. 使用补充说明
> <img src=https://foruda.gitee.com/images/1659974810147043475/运行.png>
> midi路径：含有mid文件路径、文件名、后缀的完整绝对路径
> 
> 输出路径：输出文件夹的路径，就写一个英文.(句号)可以表示生成到当前目录下
> (意思就是支持相对路径)
> 
> 是否重置计分板：1或0（歌曲放完是否重置，推荐1）
> 
> 是否启用进度条：1或0（看个人需要）
> 
> 计分板名称：游戏内的计分板名称
> 
> 音量：0-1之间的小数（含0，1）正常来说推荐1
> 
> 变速：float数据，一般写1
> 
> 没有报错且在输出路径下找到mcpack或bdx即为生成成功：
> <img src=https://foruda.gitee.com/images/1659973655881460036/输出.png>


### 对于 进度条自定义 功能的说明

因为我们提供了可以自动转换进度条的功能，因此在这里给出进度条自定义参数的详细解释。

一个进度条，明显地，有**固定部分**和**可变部分**来构成。而可变部分又包括了文字和图形两种（当然，《我的世界》里头的进度条，可变的图形也就是那个“条”了）。这一点你需要了解，因为后文中包含了很多这方面的概念需要你了解。

进度条的自定义功能使用一个字符串来定义自己的样式，其中包含众多**标识符**来表示可变部分。

标识符如下（注意大小写）：

| 标识符   | 指定的可变量     |
|---------|----------------|
| `%%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'))`

*对了！为了避免生成错误，请尽量避免使用标识符作为定义样式字符串的其他部分*