Merge branch 'pkgver' of https://gitee.com/TriM-Organization/Musicreater

README.md

@@ -22,118 +22,48 @@
 简体中文 | [English](README_EN.md)
 
 
-## 软件介绍🚀
+## 介绍🚀
 
-音·创 Musicreater 是一款免费开源的 **《我的世界：基岩版》** 音乐制作软件
+音·创 是一个免费开源的针对 **《我的世界》** 的midi音乐转换库
 
 欢迎加群：[861684859](https://jq.qq.com/?_wv=1027&k=hpeRxrYr)
 
-**注意注意注意！！！当前版本正在进行代码重构，详细信息请进入QQ群了解！！**
+## 文档📄
 
-## 软件作者✒
+[生成文件的使用](./docs/%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)
 
-金羿 Eilles：我的世界基岩版指令师，个人开发者，B站不知名UP主，南昌在校高中生。
+[仓库API文档](./docs/%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)
+
+## 作者✒
+
+金羿 Eilles：我的世界基岩版指令师，个人开发者，B站不知名UP主，江西在校高中生。
 
 诸葛亮与八卦阵 bgArray：我的世界基岩版玩家，喜欢编程和音乐，深圳初二学生。
 
-## 软件架构🏢
+## 致谢🙏
+本致谢列表排名无顺序。
 
-软件采用 *Python* 作为第一语言，目前还没有使用其他语言辅助。
-
-支持 Windows7+ 以及各个支持 Python3.6+ 的 Linux
-
-***各位开发人员注意！！！多语言支持请使用函数`_`加载文字！！！如需补充，请在简体中文的语言文件(zh-CN.lang)中补充！！！***
-
-## 使用教程📕
-
-***请注意！音·创是音乐的 编辑 软件，不是转换软件，若要直接转换midi音乐到我的世界，请见 [音·创 包版本](https://gitee.com/EillesWan/Musicreater/blob/pkgver/)***
-
-### 安装教程
-
-下载[音·创自动安装器](https://gitee.com/EillesWan/Musicreater/releases/)，将其放在你希望安装音·创的位置，运行后将自动安装。
-
-提示：下载源最好选择\"2 GitHub\"。
-
-### 从源代码运行教程
-
-#### Windows7+
-
-0.  [Gitee下载（需要登陆）](https://gitee.com/EillesWan/Musicreater)
-    [Github下载（慢）](https://github.com/EillesWan/Musicreater)本程序源代码
-1.  安装Python 3.8.10 
-    [下载64位Python安装包](https://www.python.org/ftp/python/3.8.10/python-3.8.10-amd64.exe)
-    [下载32位Python安装包](https://www.python.org/ftp/python/3.8.10/python-3.8.10.exe)
-2.  以管理员身份运行 作者的自我修养.py :
-    -   点击 “开始” 菜单，搜索 `命令提示符`
-    -   右键点击 `命令提示符` 左键点击 “以管理员身份运行”
-    -   将 “作者的自我修养.py” 拖拽入开启的窗口，按下回车
-3.  等待安装完成后，双击运行 Musicreater.py
-
-#### Linux
-
-0.  若你没有足够优秀的环境，推荐先在终端敲：
-```bash
-sudo apt-get update
-sudo apt-get upgrade
-sudo apt-get install python3
-sudo apt-get install python3-pip
-sudo apt-get install git
-```
-1.  若你足够自信，该整的都整了，就在你想下载此程序的地方打开终端，敲：
-```bash
-sudo git clone https://gitee.com/EillesWan/Musicreater.git
-cd Musicreater
-python3 作者的自我修养.py
-python3 Musicreater.py
-```
-
-### 使用说明
-
-1.  直接运行就好
-2.  后期会出详细的使用教程
-3.  如果在使用过程中发现了bug拜托请上报给我，详见下方联系方式
-
-## 诸葛亮与八卦阵的关于羽音缭绕资源包应用地说明（不必要）📖
-
-0. ***注意注意！！！这一条说明是供给老版本(Delta 0.1.x)使用的***
-1. 首先！这里的提示是给想使用多音色资源包的人的，如果你想用就请下载 [神羽资源包（神羽自己的链接）](https://pan.baidu.com/s/11uoq5zwN7c3rX-98DqVpJg)提取码:ek3t
-2. 下载到你自己电脑上某个位置，可以不放置于本项目下。音色资源包较大，可以选取只下载：
-    `神羽资源包_乐器、音源的资源包\羽音缭绕-midiout_25.0` 这个文件夹，再嫌麻烦的话，也可以只下载其中的：
-    `神羽资源包_乐器\音源的资源包\羽音缭绕-midiout_25.0\mcpack(国际版推荐)格式_25.0` 或者：
-    `神羽资源包_乐器\音源的资源包\羽音缭绕-midiout_25.0\zip格式_25.0`
-4. 接下来就是关键了：在*音创*中绑定资源包
-    首先，先打开 *音创*->帮助与疑问->\[神羽资源包位置选择\]：选择文件夹... 这时候，会跳出选择框
-    关键来了，选择：***您下载的`羽音缭绕-midiout_25.0`文件夹，或者`mcpack(国际版推荐)格式_25.0`或`zip格式_25.0`的上级目录***
-    举个例子：我的文件路径是这样的：
-    `L:\shenyu\音源的资源包\羽音缭绕-midiout_25.0`这里面有：`神羽资源包_25.0_使用方法.xls`、
-    `mcpack(国际版推荐)格式_25.0`、`zip格式_25.0`两个文件夹和一个.xls文件，而你在音创中
-    也应该选择这个文件夹：**L:\shenyu\音源的资源包\羽音缭绕-midiout_25.0**
-6. 如果你想使用音色资源包来制作函数，那么解析时你应该用 *音创*->编辑->从midi导入音轨且用新方法解析，
-    然后再使用 *音创*->函数（包）->下面的四个新函数
-
-## 致谢列表🙏
-
-- 感谢由 **[Fuckcraft](https://github.com/fuckcraft)** **鸣凤鸽子**等 带来的我的世界websocket服务器功能
 - 感谢 **昀梦**\<QQ1515399885\> 找出指令生成错误bug并指正
-- 感谢由 **Charlie_Ping** “**查理平**” 带来的bdx转换功能
-- 感谢由 **CMA_2401PT** 带来的 BDXWorkShop 供本程序对于bdx操作的指导
-- 感谢由 **神羽** (**Miracle Plume**)\<QQshenyu40403\>带来的羽音缭绕基岩版音色资源包
-- 感谢 **Arthur Morgan**\<QQ312280061\> 对本程序的排错提出了最大的支持
-- 感谢由 **Dislink Sforza** \<QQ1600515314\>带来的midi音色解析以及转换指令的算法，我们将其改编并应用
-- 感谢 **Touch** “**偷吃**” \<QQ1793537164\>提供的测试支持，并对程序的改进提供了丰富的意见
-- 感谢 **Mono**\<QQ738893087\>反馈安装时的问题
+- 感谢由 **Charlie_Ping “查理平”** 带来的BDX文件转换参考，以及MIDI-我的世界对应乐器参考表格
+- 感谢由 **[CMA_2401PT](https://github.com/CMA2401PT)** 为我们的软件开发的一些方面进行指导，同时我们参考了他的BDXworkshop作为BDX结构编辑的参考
+- 感谢由 **[Dislink Sforza](https://github.com/Dislink) “断联·斯福尔扎”**\<QQ1600515314\> 带来的midi音色解析以及转换指令的算法，我们将其改编并应用；同时，感谢他的[网页版转换器](https://dislink.github.io/midi2bdx/)给我们的开发与更新带来巨大的压力和动力，让我们在原本一骑绝尘的摸鱼道路上转向开发，希望他能考上一个理想的大学！
+- 感谢 **Touch “偷吃”**\<QQ1793537164\> 提供的BDX导入测试支持，并对程序的改进提供了丰富的意见；同时也感谢他的不断尝试新的内容，使我们的排错更进一步
+- 感谢 **Mono**\<QQ738893087\> 反馈安装时的问题，辅助我们找到了视窗操作系统下的兼容性问题
+- 感谢 **Ammelia “艾米利亚”**\<QQ2838334637\> 敦促我们进行新的功能开发，并为新功能提出了非常优秀的大量建议，以及提供的BDX导入测试支持，为我们的新结构生成算法提供了大量的实际理论支持
+- 感谢 **[神羽](https://gitee.com/snowykami) “[SnowyKami](https://github.com/snowyfirefly)”** 对我们项目的支持与宣传
+- 感谢 **指令师_苦力怕 playjuice123**\<QQ240667197\>为我们的程序找出错误，并提醒我们修复一个一直存在的大bug。
+- 感谢 **雷霆**\<QQ3555268519\>为我们的程序找出错误，并提醒修复bug。
 
->  感谢广大群友为此程序提供的测试等支持
+>	感谢广大群友为此程序提供的测试等支持
 >
->  若您对我们有所贡献但您的名字没有显示在此列表中，请联系我！
+>	若您对我们有所贡献但您的名字没有显示在此列表中，请联系我们！
 
-## 联系我们📞
+## 联系📞
 
+若遇到库中的问题，欢迎在[此](https://gitee.com/TriM-Organization/Musicreater/issues/new)提出你的issue。
 
+如果需要与开发组进行交流，欢迎加入我们的[开发闲聊Q群](https://jq.qq.com/?_wv=1027&k=hpeRxrYr)。
 
-## 待办事项⏲
-
--   [] 喵喵喵
 
 
 [Bilibili: 凌云金羿]: https://img.shields.io/badge/Bilibili-%E5%87%8C%E4%BA%91%E9%87%91%E7%BE%BF-00A1E7?style=for-the-badge