TriM-Organization/Musicreater
2
0
Fork 0
mirror of https://github.com/TriM-Organization/Musicreater.git synced 2024-11-11 01:27:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

修改部分文档

Browse Source
This commit is contained in:
EillesWan 2023-03-11 18:23:40 +08:00
parent b1fb82712d
commit 7cc70d6948
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/库的生成与功能文档.md
View File

@ -10,28 +10,38 @@
# 库的简单调用
参见[magicDemo.py的相关部分](../magicDemo.py#L436)，使用此库进行MIDI转换非常简单。
参见[example.py的相关部分](../example.py#L120)，使用此库进行MIDI转换非常简单。
```python
import msctPkgver # 导入转换库
import Musicreater # 导入转换库
# 首先新建转换对象。
conversion = msctPkgver.midiConvert()
conversion = Musicreater.midiConvert()
# 值得注意的是，一个转换对象可以转换多个文件。
# 也就是在实例化的时候不进行对文件的绑定。
# 如果有调试需要，可以在实例化时传入参数 debug = True
# 如：conversion = msctPkgver.midiConvert(debug=True)
# 如：conversion = Musicreater.midiConvert(debug=True)
# 设置输入输出地址，并指定execute指令语法
# 地址都为字符串类型，不能传入文件流
midi_path = "./where/you/place/.midi/files.mid"
output_folder = "./where/you/want2/convert/into/"
old_execute_format = False # 指定是否使用旧的execute指令语法（即1.18及以前的《我的世界：基岩版》语法）
# 设定基本转换参数
conversion.convert(midi_path,output_folder,old_execute_format)
# 进行转换并接受输出，具体的参数均在文档中有相关说明
method_id = 2 # 指定使用的转换算法
convertion_result = conversion.tomcpack(method_id,*prompts)
# 进行转换并接受输出，具体的参数均在代码之文档中有相关说明
method_id = 3 # 指定使用的转换算法
# 使用计分板播放器，转换为附加包文件
convertion_result = conversion.to_mcpack(method_id,*prompts)
# 使用计分板播放器，转换为BDX结构文件
convertion_result = conversion.to_BDX_file(method_id,*prompts)
# 使用延迟播放器，转换为BDX结构文件
convertion_result = conversion.to_BDX_file_with_delay(method_id,*prompts)
# 转换结果是一个元组。
# 若其转换成功，则前三位必为