mirror of
https://github.com/TriM-Organization/Musicreater.git
synced 2025-02-07 19:36:46 +08:00
更新部分文档，以及英文语言支持
This commit is contained in:
parent
4b9550db21
commit
032e2f0f0a
10
README.md
10
README.md
@ -44,12 +44,12 @@
|
||||
|
||||
- 感谢 **昀梦**\<QQ1515399885\> 找出指令生成错误bug并指正
|
||||
- 感谢由 **Charlie_Ping “查理平”** 带来的BDX文件转换参考，以及MIDI-我的世界对应乐器参考表格
|
||||
- 感谢由 **CMA_2401PT** 为我们的软件开发的一些方面进行指导，同时我们参考了他的BDXworkshop作为BDX结构编辑的参考
|
||||
- 感谢由 **Dislink Sforza “断联·斯福尔扎”**\<QQ1600515314\> 带来的midi音色解析以及转换指令的算法，我们将其改编并应用；同时，感谢他的[网页版转换器](https://dislink.github.io/midi2bdx/)给我们的开发与更新带来巨大的压力和动力，让我们在原本一骑绝尘的摸鱼道路上转向开发，希望他能考上一个理想的大学！
|
||||
- 感谢由 **[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导入测试支持，为我们的新结构生成算法提供了大量的实际理论支持
|
||||
- 感谢 **神羽** 对我们项目的支持与宣传
|
||||
- 感谢 **Ammelia “艾米利亚”**\<QQ2838334637\> 敦促我们进行新的功能开发，并为新功能提出了非常优秀的大量建议，以及提供的BDX导入测试支持，为我们的新结构生成算法提供了大量的实际理论支持
|
||||
- 感谢 **[神羽](https://gitee.com/snowykami) “[SnowyKami](https://github.com/snowyfirefly)”** 对我们项目的支持与宣传
|
||||
|
||||
> 感谢广大群友为此程序提供的测试等支持
|
||||
>
|
||||
@ -57,7 +57,7 @@
|
||||
|
||||
## 联系我们📞
|
||||
|
||||
若遇到库中的问题，欢迎在[此](https://gitee.com/EillesWan/Musicreater/issues/new)提出你的issue。
|
||||
若遇到库中的问题，欢迎在[此](https://gitee.com/TriM-Organization/Musicreater/issues/new)提出你的issue。
|
||||
|
||||
如果需要与开发组进行交流，欢迎加入我们的[开发闲聊Q群](https://jq.qq.com/?_wv=1027&k=hpeRxrYr)。
|
||||
|
||||
|
||||
49
README_EN.md
49
README_EN.md
@ -18,51 +18,50 @@
|
||||
[简体中文🇨🇳](README.md) | English🇬🇧
|
||||
|
||||
|
||||
**Notice that the language support of *README* may be a little SLOW.**
|
||||
**Notice that the language translation of *Musicreater* may be a little SLOW.**
|
||||
|
||||
## Introduction🚀
|
||||
|
||||
Musicreater(音·创) is a free open source software which is used for making and also creating music in **Minecraft: Bedrock Edition**.
|
||||
Musicreater(音·创) is a free open source software which is used for making and also creating music in *Minecraft: Bedrock Edition*.
|
||||
|
||||
Musicreater pkgver(Package Version 音·创 库版) is a free open source library used for convert midi file into formats that is suitable for **Minecraft: Bedrock Edition**.
|
||||
Musicreater pkgver(Package Version 音·创 库版) is a free open source library used for convert midi file into formats that could be read in *Minecraft: Bedrock Edition*.
|
||||
|
||||
Welcome to join our QQ group: [861684859](https://jq.qq.com/?_wv=1027&k=hpeRxrYr)
|
||||
|
||||
### **SEEEEEEEEE Tutorials [HERE](./docs/Use%20of%20Funtions.md)**
|
||||
**This branch is the Package Version of Musicreater, that means that the lib can be imported for other softwares**
|
||||
|
||||
### **If you want to use the demo to convert MIDI musics directly, SEEEEEEEEE [Tutorials HERE](./docs/Use%20of%20Funtions.md)**
|
||||
|
||||
### Authors✒
|
||||
|
||||
Eilles (金羿)：A high school student, individual developer, unfamous BilibiliUPer, which knows a little about commands in *Minecraft: Bedrock Edition*
|
||||
Eilles (金羿)：A senior high school student, individual developer, unfamous Bilibili UPer, which knows a little about commands in *Minecraft: Bedrock Edition*
|
||||
|
||||
bgArray "诸葛亮与八卦阵": Fix bugs, improve code aesthetics, add new functions, change data format, etc.
|
||||
bgArray "诸葛亮与八卦阵": A junior high school student, player of *Minecraft: Bedrock Edition*, which is a fan of music and programming.
|
||||
|
||||
|
||||
## Thanks🙏
|
||||
This list is not in any order.
|
||||
|
||||
- Thank *昀梦*\<QQ1515399885\> for finding and correcting the bugs in the commands that *Musicreater* Created.
|
||||
- Thank *Charlie_Ping “查理平”* for bdx convert function, and
|
||||
the data label that's used to convert the mid's instruments into minecraft's instruments.
|
||||
- Thank *CMA_2401PT* for BDXWorkShop as the .bdx structure's operation guide.
|
||||
- Thank *Dislink Sforza* \<QQ1600515314\> for the algorithm brought to us, his midi analysis algorithm became one of us's best ones
|
||||
- Thank *Arthur Morgan*\<QQ312280061\> for his/her biggest support for the debugging of Musicreater
|
||||
- Thank *Touch “偷吃”*\<QQ1793537164\> for support of debugging and testing program and algorithm, as well his/her suggestions to the improvement of our project
|
||||
- Thank *Mono*\<QQ738893087\> for reporting problems while installing
|
||||
- Thanks for a lot of groupmates who support me and help me to test the program.
|
||||
- If you have give me some help but u haven't been in the list, please contact me.
|
||||
- Thank *昀梦*\<QQ1515399885\> for finding and correcting the bugs in the commands that *Musicreater* generated.
|
||||
- Thank *Charlie_Ping “查理平”* for bdx convert function for reference, and the chart that's used to convert the mid's instruments into Minecraft's instruments.
|
||||
- Thank *[CMA_2401PT](https://github.com/CMA2401PT)* for BDXWorkShop for reference of the .bdx structure's operation, and his guidance in some aspects of our development.
|
||||
- Thank *[Dislink Sforza](https://github.com/Dislink) “断联·斯福尔扎”* \<QQ1600515314\> for his midi analysis algorithm brought to us, we had adapted it and made it applied in one of our working method; Also, thank him for the [WebConvertor](https://dislink.github.io/midi2bdx/) which brought us so much pressure and power to develop as well as update our projects better, instead of loaf on our project. We hope he can get into a good university as he wantted to!
|
||||
- Thank *Touch “偷吃”*\<QQ1793537164\> for support of debugging and testing program and algorithm, as well his/her suggestions to the improvement of our project
|
||||
- Thank *Mono*\<QQ738893087\> for reporting problems while installing
|
||||
- Thank *Ammelia “艾米利亚”*\<QQ2838334637\> for urging us to develop new functions, and put forward a lot of excellent suggestions for new functions, as well as the BDX file's importing test support provided, which has given a lot of practical theoretical support for our new Structure Generating Algorithm
|
||||
- 感谢 **[神羽](https://gitee.com/snowykami) “[SnowyKami](https://github.com/snowyfirefly)”** for supporting and promoting our project
|
||||
|
||||
## Contact Information📞
|
||||
> Thanks for a lot of groupmates's support and help
|
||||
>
|
||||
> If you have given contribution but haven't been in the list, please contact us!
|
||||
|
||||
## Contact Us📞
|
||||
|
||||
### Author *Eilles*(金羿)
|
||||
|
||||
1. QQ 2647547478
|
||||
2. E-mail EillesWan2006@163.com
|
||||
W-YI_DoctorYI@outlook.com EillesWan@outlook.com
|
||||
3. WeChat WYI_DoctorYI
|
||||
4. Telegram [@EillesWan](https://t.me/EillesWan)
|
||||
Meet problems? Welcome to give out your issue [here](https://gitee.com/EillesWan/Musicreater/issues/new)!
|
||||
|
||||
### Author *bgArray*(诸葛亮与八卦阵)
|
||||
|
||||
1. QQ 4740437765
|
||||
Want to get in contact of developers? Welcome to join our [Chat QQ group](https://jq.qq.com/?_wv=1027&k=hpeRxrYr).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -7,194 +7,15 @@
|
||||
|
||||
# Instructions for Using Demo(s)
|
||||
|
||||
*This is a tutorial for using the demo(s) of this library, not the Development Guide. If you want to see so, please read Below*
|
||||
*This is a tutorial for using the demo(s) of this library, not the Development Guide.*
|
||||
|
||||
## Under Windows
|
||||
*Developing Documentation is now not translated yet, you can see here for the [Chinese Orignal Version](%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) if you understand Chinese*
|
||||
|
||||
0. Install Python 3.6+
|
||||
## Instructions of Downloading and Starting using Demo
|
||||
|
||||
First of all, you need to install the runtime environment of this library, *Python*. And a Installation Pack maybe the best choice:
|
||||
|
||||
> [Downloading Python 64-bit](https://www.python.org/ftp/python/3.8.10/python-3.8.10-amd64.exe)
|
||||
> [Downloading Python 32-bit](https://www.python.org/ftp/python/3.8.10/python-3.8.10.exe)
|
||||
|
||||
While installing, it's better to check `Add Python 3.X to PATH`(just as the screenshot showed below), otherwise it needs to be set manually which may cause some time wasting
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1662736520757331846/e38efb81_9911226.png>
|
||||
|
||||
If you are new to Python or not very familiar to Computer Programming, and having the disk space in your PC's System Partition (usually C:) of 150 MB, you can directly choose *Install Now*.
|
||||
|
||||
However, if you want to do it like a pro, choosing *Customize Installation*, it's a necessary to be sure to check `pip` and `py launcher` will be installed on your computer(see screenshot below). The two options is required for the next step of installing the requirements.
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1662736621235871190/2ac3d98f_9911226.png>
|
||||
|
||||
After the installation, you can enter in your terminal(CMD/PowerShell/Bash/etc): "python" to ensure whether the installation was successful. If it was, your terminal will show things like below:
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659972669907359295/cmd.png>
|
||||
|
||||
|
||||
1. Installing Requirements
|
||||
|
||||
It's better to open your terminal(CMD/PowerShell/Bash/etc) under Administrator Mode.
|
||||
|
||||
For example, if you want to use CMD in Administrator Mode, you can search `cmd` in the *Start Menu*, right click it and *Run as Administrator*
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1662736878650993886/62487dd8_9911226.png">
|
||||
|
||||
Okay, after that, please enter in your terminal:
|
||||
|
||||
`pip install mido`
|
||||
|
||||
`pip install brotli`
|
||||
|
||||
If successful you will see something like below:
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1662737676719454287/f61a70f7_9911226.png">
|
||||
|
||||
|
||||
|
||||
2. Download This Package and Demo(s)
|
||||
|
||||
- If you using Git, you can use the following commands to clone this lib:
|
||||
|
||||
`git clone -b pkgver https://gitee.com/EillesWan/Musicreater.git`
|
||||
|
||||
- If Git is not installed, you can download the zip package from the code page(from [GitHub](https://github.com/EillesWan/Musicreater.git) or [Gitee](https://gitee.com/EillesWan/Musicreater.git)). Or you are a Chinese fan having a QQ account, you can [Join the QQ Group 861684859](https://jq.qq.com/?_wv=1027&k=hpeRxrYr) and get it from our GroupFiles.
|
||||
|
||||
<img src=" https://foruda.gitee.com/images/1659972440341216712/下载.png" >
|
||||
|
||||
|
||||
2. Start Using Demo(s)
|
||||
|
||||
Open your terminal in the directory of this, taking CMD, for example, just enter the directory and enter `cmd` in the path box:
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659974437388532868/输入.png>
|
||||
<img src=https://foruda.gitee.com/images/1659974754378201859/输入c.png>
|
||||
|
||||
And enter one of the commands below by choosing what you need:
|
||||
|
||||
`python demo_convert.py`
|
||||
|
||||
`python demo_convert_bdx_byDelay.py`
|
||||
|
||||
|
||||
### Addition for Error(s) Using or Installing
|
||||
|
||||
1. Environment Error of Microsoft Visual C++ Redistributable
|
||||
|
||||
If you meet this condition as the screenshot shows:
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659972789779764953/bug.jpeg>
|
||||
|
||||
Your MSVC Environment may be not installed, and you can download and install
|
||||
> [Here of 64-Bit VCREDIST](https://aka.ms/vs/17/release/vc_redist.x64.exe)
|
||||
> [Here of 32-Bit VCREDIST](https://aka.ms/vs/17/release/vc_redist.x86.exe)
|
||||
|
||||
Thank our groupmate *Mono* again for helping finding this problem.
|
||||
|
||||
|
||||
|
||||
## Under Linux OS
|
||||
|
||||
|
||||
### Install Runtime Environment
|
||||
|
||||
0. Install and Verify Python Runtime
|
||||
|
||||
Common Linux Releases do include a Python Runtime Environment, what we should do only is to check it is a satisfied version to our program. If the version ≥Python3.6, theoretically our program can be run.
|
||||
|
||||
We can type:
|
||||
|
||||
```bash
|
||||
python -V
|
||||
```
|
||||
|
||||
To check the Python version, as the follows
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1665120915821957090/429561fd_9911226.png>
|
||||
|
||||
- Not Necessary
|
||||
|
||||
If you want to change a Python version just as what I want to do, it is such a great fantastic action! Let do as the follows:
|
||||
|
||||
- pacman Package Manager（In Arch Linux Mostly）
|
||||
|
||||
Let's write python3 into the ingore list of updating. Via `vim` to edit `/etc/pacman.conf`, add `python3` after `IgnorePkg`.
|
||||
|
||||
```bash
|
||||
sudo vim /etc/pacman.conf
|
||||
```
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1665124611490335193/5e99ca26_9911226.png>
|
||||
|
||||
Then we can search for python releases in [Arch Achieve](https://archive.archlinux.org/packages/).（*HERE, under Arch, Python refers to Python3 defaultly, while some other Linux releases using Python2 as default. So dose Arch Achieve.*）What I find here is [Python3.8.6](https://archive.archlinux.org/packages/p/python/python-3.8.6-1-x86_64.pkg.tar.zst), so let's download she via `pacman`:
|
||||
|
||||
```bash
|
||||
sudo pacman -U https://archive.archlinux.org/packages/p/python/python-3.8.6-1-x86_64.pkg.tar.zst
|
||||
```
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1665126362769399903/ea4b9598_9911226.png>
|
||||
|
||||
Perfect!
|
||||
|
||||
1. Install and Verify pip Package Manager
|
||||
|
||||
Before installing, it is to be checked, wheather Python's pip is OK:
|
||||
|
||||
```bash
|
||||
python -m pip # To check is pip installed
|
||||
# If a long tip occured, it is OK
|
||||
|
||||
# If returned as this, then not.
|
||||
/usr/bin/python: No module named pip
|
||||
# We can install pip via:
|
||||
sudo pacman -S python-pip
|
||||
# Verfy, remember.
|
||||
python -m pip
|
||||
|
||||
|
||||
# If you did but failed, we should use other methods to install pip:
|
||||
wget https://bootstrap.pypa.io/get-pip.py
|
||||
sudo python get-pip.py
|
||||
# Verfy, must.
|
||||
python -m pip
|
||||
```
|
||||
|
||||
Over after checking, lets install the dependences.
|
||||
|
||||
```bash
|
||||
pip install mido -i https://mirrors.aliyun.com/pypi/simple/
|
||||
pip install brotli -i https://mirrors.aliyun.com/pypi/simple/
|
||||
```
|
||||
|
||||
See the tips below as successfully installed：
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1662737676719454287/f61a70f7_9911226.png">
|
||||
|
||||
|
||||
### Download this sources pack and Using its demos.
|
||||
|
||||
1. 使用Git下载本库及其示例代码
|
||||
|
||||
```bash
|
||||
git clone -b pkgver https://gitee.com/EillesWan/Musicreater.git MSCTpkgver
|
||||
```
|
||||
|
||||
当上述命令执行成功，你会在执行此命令的所在位置发现一个名为 `MSCTpkgver` 的文件夹，其中包含的正是我们心心念念下载的本程序和示例代码。
|
||||
而我们要运行的也正是示例代码，因此，赶快进入下载到的文件夹：
|
||||
|
||||
```bash
|
||||
cd MSCTpkgver
|
||||
```
|
||||
|
||||
1. 开始使用
|
||||
|
||||
在目录下打开终端，执行以下命令：(选择你需要的)
|
||||
|
||||
```bash
|
||||
python demo_convert.py
|
||||
python demo_convert_bdx_byDelay.py
|
||||
```
|
||||
### [Windows OS](./download%26start_EN/Windows.md)
|
||||
### [Linux OS](./download%26start_EN/Linux.md)
|
||||
### [Android OS](./download%26start_EN/Android.md)
|
||||
|
||||
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1662736621235871190/2ac3d98f_9911226.png>
|
||||
|
||||
4. 安装结束之后可以在*终端*(命令行/PowerShell/Bash/etc)中输入：python 试试是否安装成功，成功安装之后，在终端中输入python会显示诸如如下图片的提示：
|
||||
4. 安装结束之后可以在*终端*(命令行/PowerShell/Bash/etc)中输入：`python` 试试是否安装成功，成功安装之后，在终端中输入python会显示诸如如下图片的提示：
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659972669907359295/cmd.png>
|
||||
|
||||
@ -48,12 +48,12 @@
|
||||
- 若您使用git，请直接克隆本仓库：
|
||||
|
||||
```bash
|
||||
git clone -b pkgver https://gitee.com/EillesWan/Musicreater.git
|
||||
git clone -b pkgver https://gitee.com/TriM-Organization/Musicreater.git
|
||||
```
|
||||
|
||||
- 若您不使用git，可以在[*码云*(Gitee)](https://gitee.com/EillesWan/Musicreater.git)或[*GitHub*](https://github.com/EillesWan/Musicreater.git)下载zip包，或者[加入QQ群聊861684859](https://jq.qq.com/?_wv=1027&k=hpeRxrYr)，在群文件中获取。
|
||||
- 若您不使用git，可以在[*码云*(Gitee)](https://gitee.com/TriM-Organization/Musicreater.git)或[*GitHub*](https://github.com/TriM-Organization/Musicreater.git)下载zip包，或者[加入QQ群聊861684859](https://jq.qq.com/?_wv=1027&k=hpeRxrYr)，在群文件中获取。
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1669540786443169766/fabf0acd_9911226.png" >
|
||||
<img src="https://foruda.gitee.com/images/1669540786443169766/fabf0acd_9911226.png">
|
||||
|
||||
值得注意的是，这张图上有1、2两个数字，虽然是手写的，但确实是数字，表示着要进行的步骤。希望眼尖得能找出我的口头禅的你们能够发现这两个用鼠标手写的数字并在安装时认真地执行。我认为这并不算十分的难，移动鼠标并单击大约消耗不了多少卡路里，不过我没有进行精确的计算，我也不是十分的清楚这个活动对于一个常人来讲有多难，但我怀疑它不难。
|
||||
|
||||
@ -69,6 +69,8 @@
|
||||
<img src=https://foruda.gitee.com/images/1659974437388532868/输入.png>
|
||||
<img src=https://foruda.gitee.com/images/1659974754378201859/输入c.png>
|
||||
|
||||
使用以下指令：
|
||||
|
||||
```bash
|
||||
python ./magicDemo.py
|
||||
```
|
||||
97
docs/download&start_EN/Android.md
Normal file
97
docs/download&start_EN/Android.md
Normal file
@ -0,0 +1,97 @@
|
||||
## Before we Use
|
||||
|
||||
### Installing Terminal APP
|
||||
|
||||
We choose **Termux** as the Terminal APP as it is the powerful Linux simulator.
|
||||
|
||||
1. Dowloading
|
||||
|
||||
From both [GitHub](https://github.com/termux/termux-app/releases) or [F-Droid](https://f-droid.org/en/packages/com.termux/) to download is OK.
|
||||
|
||||
2. Installing
|
||||
|
||||
*APK* file is easy to install and you must know it without my instruments, you can see something like below after opening this app.
|
||||
|
||||
<img height="512" src="https://foruda.gitee.com/images/1665933025120627254/a0479618_9911226.jpeg">
|
||||
|
||||
3. Finish
|
||||
|
||||
OK, congratulations for ok installing *Termux*.
|
||||
|
||||
### Installing Runtime Environment
|
||||
|
||||
1. Installing **Python**
|
||||
|
||||
```bash
|
||||
apt-get install python3
|
||||
```
|
||||
|
||||
The picture left below is while you may enter `Y` to continue.
|
||||
Aftering succeed in installing you will see as right bicture below.
|
||||
|
||||
<table><tr>
|
||||
<td><img src="https://foruda.gitee.com/images/1665933181440420034/7f0fb5fd_9911226.jpeg"></td>
|
||||
<td><img src="https://foruda.gitee.com/images/1665933238339972260/a9f06f4f_9911226.jpeg"></td>
|
||||
</tr></table>
|
||||
|
||||
OK, let try whether success installing **Python** via
|
||||
|
||||
```bash
|
||||
python3 -V
|
||||
```
|
||||
|
||||
Sth. like `Python 3.X.X` will occur if so.
|
||||
|
||||
3. Installing dependences
|
||||
|
||||
```bash
|
||||
pip install mido
|
||||
pip install brotli
|
||||
```
|
||||
|
||||
Sth. like below will occur if successful.
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1662737676719454287/f61a70f7_9911226.png">
|
||||
|
||||
### Install Downloading Tool
|
||||
|
||||
Tired to translate, QwQ.....
|
||||
Sleep for a while and this can be a TO-DO.
|
||||
|
||||
既然已经有了运行环境，那么我们就需要下载下我们的**音·创库版示例代码**工具，我非常推崇**Git**这种方便快捷好用还能下载仓库的代码管理器，这个世界上你也找不到第二个，所以我们来安装一下：
|
||||
|
||||
```bash
|
||||
pkg install git
|
||||
```
|
||||
|
||||
安装完成后记得测试一下：
|
||||
|
||||
<img height="512" src="https://foruda.gitee.com/images/1665933331269483373/9374c85d_9911226.jpeg">
|
||||
|
||||
## 本代码库的下载与演示程序的使用
|
||||
|
||||
1. 使用Git下载本库及其示例代码
|
||||
|
||||
```bash
|
||||
git clone -b pkgver https://gitee.com/EillesWan/Musicreater.git MSCTpkgver
|
||||
```
|
||||
|
||||
当上述命令执行成功，你会在执行此命令的所在位置发现一个名为 `MSCTpkgver` 的文件夹，其中包含的正是我们心心念念下载的本程序和示例代码。
|
||||
而我们要运行的也正是示例代码，因此，赶快进入下载到的文件夹：
|
||||
|
||||
```bash
|
||||
cd MSCTpkgver
|
||||
```
|
||||
|
||||
1. 开始使用演示程序
|
||||
|
||||
依照你的需要，执行以下命令以运行库的演示程序：
|
||||
|
||||
```bash
|
||||
python magicDemo.py
|
||||
```
|
||||
|
||||
运行成功了，哦耶！
|
||||
|
||||
<img height="512" src="https://foruda.gitee.com/images/1665933366784631363/db9f80f6_9911226.jpeg">
|
||||
|
||||
102
docs/download&start_EN/Linux.md
Normal file
102
docs/download&start_EN/Linux.md
Normal file
@ -0,0 +1,102 @@
|
||||
|
||||
## Install Runtime Environment
|
||||
|
||||
### Install and Verify Python Runtime
|
||||
|
||||
0. Common Linux Distributions do include a Python Runtime Environment, what we should do is only to check whether it is a satisfied version to our program. If the version ≥Python3.6, theoretically our program can be run.
|
||||
|
||||
We can type:
|
||||
|
||||
```bash
|
||||
python -V
|
||||
```
|
||||
|
||||
To check the Python version, as the follows
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1665120915821957090/429561fd_9911226.png>
|
||||
|
||||
1. **Not Necessary**
|
||||
|
||||
If you want to change a Python version just as what I want to do, it is such a great fantastic action! Let do as the follows:
|
||||
|
||||
- pacman Package Manager（In Arch Linux Mostly）
|
||||
|
||||
1. Let's write python3 into the ingore list of updating. Via `vim` to edit `/etc/pacman.conf`, add `python3` after `IgnorePkg`.
|
||||
|
||||
```bash
|
||||
sudo vim /etc/pacman.conf
|
||||
```
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1665124611490335193/5e99ca26_9911226.png>
|
||||
|
||||
2. Then we can search for python releases in [Arch Achieve](https://archive.archlinux.org/packages/).（*HERE, under Arch, Python refers to Python3 defaultly, while some other Linux releases using Python2 as default. So dose Arch Achieve.*）What I find here is [Python3.8.6](https://archive.archlinux.org/packages/p/python/python-3.8.6-1-x86_64.pkg.tar.zst), so let's download she via `pacman`:
|
||||
|
||||
```bash
|
||||
sudo pacman -U https://archive.archlinux.org/packages/p/python/python-3.8.6-1-x86_64.pkg.tar.zst
|
||||
```
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1665126362769399903/ea4b9598_9911226.png>
|
||||
|
||||
3. Perfect!
|
||||
|
||||
- Other Package Manager
|
||||
|
||||
None yet.
|
||||
|
||||
### Install and Verify pip Package Manager
|
||||
|
||||
1. Before installing, it is to be checked, wheather Python's pip is OK:
|
||||
|
||||
```bash
|
||||
python -m pip # To check is pip installed
|
||||
# If a long tip occured, it is OK
|
||||
|
||||
# If returned as this, then not.
|
||||
/usr/bin/python: No module named pip
|
||||
# We can install pip via:
|
||||
sudo pacman -S python-pip
|
||||
# Verfy, remember.
|
||||
python -m pip
|
||||
|
||||
|
||||
# If you did but failed, we should use other methods to install pip:
|
||||
wget https://bootstrap.pypa.io/get-pip.py
|
||||
sudo python get-pip.py
|
||||
# Verfy, must.
|
||||
python -m pip
|
||||
```
|
||||
|
||||
2. After checking, let's install the dependences.
|
||||
|
||||
```bash
|
||||
pip install mido -i
|
||||
pip install brotli -i
|
||||
```
|
||||
|
||||
3. See the tips below as successfully installed：
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1662737676719454287/f61a70f7_9911226.png">
|
||||
|
||||
|
||||
## Download this lib's sources code and Using its demos.
|
||||
|
||||
1. Download via Git
|
||||
|
||||
```bash
|
||||
git clone -b pkgver https://github.com/TriM-Organization/Musicreater.git MSCTpkgver
|
||||
```
|
||||
|
||||
If succeed, a directory named `MSCTpkgver` well be found in the path you run this command, and inside it is the source code and demo(s) we wantted to download.
|
||||
What we want to use is the demo(s) so enter the folder via:
|
||||
|
||||
```bash
|
||||
cd MSCTpkgver
|
||||
```
|
||||
|
||||
1. Starting Using Demo(s)
|
||||
|
||||
Via
|
||||
|
||||
```bash
|
||||
python magicDemo.py
|
||||
```
|
||||
92
docs/download&start_EN/Windows.md
Normal file
92
docs/download&start_EN/Windows.md
Normal file
@ -0,0 +1,92 @@
|
||||
## Install Runtime Environment
|
||||
|
||||
### Install Python 3.6+
|
||||
|
||||
1. First of all, you need to install the runtime environment of this library, *Python*. And a Installation Pack maybe the best choice:
|
||||
|
||||
> [Downloading Python 64-bit](https://www.python.org/ftp/python/3.8.10/python-3.8.10-amd64.exe)
|
||||
> [Downloading Python 32-bit](https://www.python.org/ftp/python/3.8.10/python-3.8.10.exe)
|
||||
|
||||
2. While installing, it's best to check `Add Python 3.X to PATH`(just as the screenshot showed below), otherwise it needs to be set manually which may cause some time wasting.
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1662736520757331846/e38efb81_9911226.png>
|
||||
|
||||
- If you are new to Python or not very familiar to Computer Programming, and having the disk space in your PC's System Partition (usually C:) of 150 *MB*, you can directly choose *Install Now*.
|
||||
|
||||
3. However, if you want to do it like a pro, choosing *Customize Installation*, it's necessary to be sure to check `pip` and `py launcher` will be installed on your computer(see screenshot below). The two options is required for the next step of installing the requirements.
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1662736621235871190/2ac3d98f_9911226.png>
|
||||
|
||||
4. After the installation, you can enter in your *Terminal*(CMD/PowerShell/Bash/etc): `python` to ensure whether the installation was successful. If it was, your terminal will show things like below:
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659972669907359295/cmd.png>
|
||||
|
||||
|
||||
### Installing Requirements
|
||||
|
||||
1. It's better to open your *Terminal*(CMD/PowerShell/Bash/etc) under Administrator Mode.
|
||||
|
||||
For example, if you want to use CMD in Administrator Mode, you can search `cmd` in the *Start Menu*, right click it and *Run as Administrator*
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1662736878650993886/62487dd8_9911226.png">
|
||||
|
||||
2. Okay, after that, please enter in your Terminal:
|
||||
|
||||
```bash
|
||||
pip install mido
|
||||
pip install brotli
|
||||
```
|
||||
|
||||
3. If successful you will see something like below:
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1662737676719454287/f61a70f7_9911226.png">
|
||||
|
||||
|
||||
## Downloading & Using of this tool
|
||||
|
||||
1. Download This Package and Demo(s)
|
||||
|
||||
- If you use Git, you can clone this lib via the following commands:
|
||||
|
||||
```bash
|
||||
git clone -b pkgver https://github.com/TriM-Organization/Musicreater.git
|
||||
```
|
||||
|
||||
- If Git is not installed, you can download the zip package from the code page(from [GitHub](https://github.com/TriM-Organization/Musicreater.git) or [Gitee](https://gitee.com/TriM-Organization/Musicreater.git)). Or you are a Chinese fan having a QQ account, you can [Join the QQ Group 861684859](https://jq.qq.com/?_wv=1027&k=hpeRxrYr) and get it from our GroupFiles.
|
||||
|
||||
<img src="https://foruda.gitee.com/images/1669540786443169766/fabf0acd_9911226.png">
|
||||
|
||||
But it should be noticed that you're clear instructed to choose the branch "pkgver" first instead of downloading it directly from the "master" branch, the master branch is now under developing and has no practical use.
|
||||
|
||||
|
||||
2. Start Using Demo(s)
|
||||
|
||||
You can directly double click `magicDemo.py` to run the demo, or follow instructions below using Terminal APP to run it.
|
||||
|
||||
Open your terminal in the directory of this, taking CMD, for example, just enter the directory and enter `cmd` in the path box:
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659974437388532868/输入.png>
|
||||
<img src=https://foruda.gitee.com/images/1659974754378201859/输入c.png>
|
||||
|
||||
And enter the commands below:
|
||||
|
||||
```bash
|
||||
python ./magicDemo.py
|
||||
```
|
||||
|
||||
|
||||
## Addition for Error(s) Using or Installing
|
||||
|
||||
1. Environment Error of Microsoft Visual C++ Redistributable
|
||||
|
||||
If you meet this condition as the screenshot shows:
|
||||
|
||||
<img src=https://foruda.gitee.com/images/1659972789779764953/bug.jpeg>
|
||||
|
||||
Your MSVC Environment may be not installed, and you can download and install
|
||||
> [Here of 64-Bit VCREDIST](https://aka.ms/vs/17/release/vc_redist.x64.exe)
|
||||
> [Here of 32-Bit VCREDIST](https://aka.ms/vs/17/release/vc_redist.x86.exe)
|
||||
or follow [this page](https://learn.microsoft.com/en-gb/cpp/windows/latest-supported-vc-redist)'s instructions.
|
||||
|
||||
Thanks to our groupmate *Mono* for helping us finding this problem.
|
||||
|
||||
@ -14,9 +14,9 @@
|
||||
|
||||
## 下载与启动教程
|
||||
|
||||
### [视窗(Windows)操作系统](./download%26atart/Windows.md)
|
||||
### [里纽克斯(Linux)操作系统](./download%26atart/Linux.md)
|
||||
### [安卓(Android)与安卓衍生操作系统](./download%26atart/Android.md)
|
||||
### [视窗(Windows)操作系统](./download%26start/Windows.md)
|
||||
### [里纽克斯(Linux)与其衍生操作系统](./download%26start/Linux.md)
|
||||
### [安卓(Android)与其衍生操作系统](./download%26start/Android.md)
|
||||
|
||||
## 演示程序使用教程
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user