本项目采用前后端分离方式。其中full-hub 属于后端文件夹,而live-2d 属于前端文件夹
其中核心代码都在live-2d文件夹。后端文件夹负责的只是单纯的将各种服务启动,例如:TTS服务(文本转语音)、ASR(语音转文本) 等。暴露出对应的API端口。让前端代码可以调用。所以主要功能很固定,很少会去修改。
而live-2d文件夹属于真正的核心功能区,下面我会一步一步的指导如何为此项目提交pr,留下印记成为本项目的贡献者
1.找一个空文件夹打开终端
2.git clone https://github.com/你的github用户名/new-my-neuro.git
3.cd new-my-neuro
# 具体分支名可以自己取,例如修Bug可以取名:fix/bug 添加新功能可以:feature/add-new-feature 简单易懂就行 下面是示例
git checkout -b 你的分支名字
这一步需要部署项目
首先是后端部署,可以偷懒用云端API 这样就省去了下载各种模型的操作。(因为之前说了,后端代码几乎不用改。所以可以偷懒用我提供的云端API)
# 进入live-2d文件夹
cd live-2d
npm install
#然后去mcp路径运行
cd mcp
npm install上述操作完成后,就可以开始修改代码加功能、修bug等操作了,如果是增加功能,那一次建议只更改一个功能。不要在一次提交中包含多个功能。这是为了防止后续如果出问题,排查困难。
git add .git commit -m "描述你做了什么"
git push origin 你的分支名字