From a15457a50d3774e13f3cfe4eb8b9175b2cd628ef Mon Sep 17 00:00:00 2001 From: Neko Ayaka Date: Sun, 23 Feb 2025 21:35:15 +0800 Subject: [PATCH] docs(README.md): updated guidelines --- README.md | 42 ++++++++++++++++++++++++++++++++++++------ README.zh-CN.md | 32 +++++++++++++++++++++++++++++++- cspell.config.yaml | 1 + 3 files changed, 68 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4e5ef2e..e602628 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,43 @@ > Heavily inspired by [Neuro-sama](https://www.youtube.com/@Neurosama) +Unlike the other AI driven VTuber open source projects, アイリ VTuber was built with many support of Web technologies such as [WebGPU](https://www.w3.org/TR/webgpu/), [WebAudio](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API), [Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers), [WebAssembly](https://webassembly.org/), [WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket), etc. from the first day. + +This means that **アイリ VTuber is capable to run on modern browsers and devices**, and even on mobile devices (already done with PWA support), this brought a lot of possibilities for us (the developers) to build and extend the power of アイリ VTuber to the next level, while still left the flexibilities for users to enable features that requires TCP connections or other non-Web technologies such as connect to voice channel to Discord, or playing Minecraft, Factorio with you and your friends. + +> [!NOTE] +> +> We are still in the early stage of development where we are seeking out talented developers to join us and help us to make アイリ VTuber a reality. +> +> It's ok if you are not familiar with Vue.js, TypeScript, and devtools that required for this project, you can join us as an artist, designer, or even help us to launch our first live stream. +> +> Even you are a big fan of React or Svelte, even Solid, we welcome you, you can open a sub-directory to add features that you want to see in アイリ VTuber, or would like to experiment with. +> +> Fields (and related projects) that we are looking for: +> +> - Live2D modeller +> - VRM modeller +> - VRChat avatar designer +> - Computer Vision +> - Reinforcement Learning +> - Speech Recognition +> - Speech Synthesis +> - ONNX Runtime +> - Transformers.js +> - vLLM +> - WebGPU +> - Three.js +> - WebXR ([checkout the another project](https://github.com/moeru-ai/n3p6) we have under @moeru-ai organization) +> +> **If you are interested in, why not introduce yourself here? [Would like to join part of us to build Airi?](https://github.com/moeru-ai/airi/discussions/33)** + ## Current progress Capable of - [x] Brain - [x] Play [Minecraft](https://www.minecraft.net) - - [ ] Play [Factorio](https://www.factorio.com) (WIP, but [PoC and demo available](https://github.com/moeru-ai/airi-factorio)) + - [x] Play [Factorio](https://www.factorio.com) (WIP, but [PoC and demo available](https://github.com/moeru-ai/airi-factorio)) - [x] Chat in [Telegram](https://telegram.org) - [x] Chat in [Discord](https://discord.com) - [x] Ears @@ -25,7 +55,7 @@ Capable of - [x] Client side speech recognition - [x] Client side talking detection - [x] Mouth - - [x] ElevenLabs voice synthesis + - [x] [ElevenLabs](https://elevenlabs.io/) voice synthesis - [x] Body - [x] VRM support - [x] Control VRM model @@ -58,9 +88,9 @@ pnpm dev - [x] [Ollama](https://github.com/ollama/ollama) - [x] [Google Gemini](https://developers.generativeai.google) - [x] [OpenAI](https://platform.openai.com/docs/guides/gpt/chat-completions-api) - - [ ] [Azure OpenAI API](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference) + - [ ] [Azure OpenAI API](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference) (PR welcome) - [x] [Anthropic Claude](https://anthropic.com) - - [ ] [AWS Claude](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference) + - [ ] [AWS Claude](https://learn.microsoft.com/en-us/azure/ai-services/openai/reference) (PR welcome) - [x] [DeepSeek](https://www.deepseek.com/) - [x] [Qwen](https://help.aliyun.com/document_detail/2400395.html) - [x] [xAI](https://x.ai/) @@ -77,8 +107,8 @@ pnpm dev - [x] [Minimax](https://api.minimax.chat/) - [x] [Moonshot AI](https://platform.moonshot.cn/) - [x] [Tencent Cloud](https://cloud.tencent.com/document/product/1729) -- [ ] [Sparks](https://www.xfyun.cn/doc/spark/Web.html) -- [ ] [Volcano Engine](https://www.volcengine.com/experience/ark?utm_term=202502dsinvite&ac=DSASUQY5&rc=2QXCA1VI) +- [ ] [Sparks](https://www.xfyun.cn/doc/spark/Web.html) (PR welcome) +- [ ] [Volcano Engine](https://www.volcengine.com/experience/ark?utm_term=202502dsinvite&ac=DSASUQY5&rc=2QXCA1VI) (PR welcome) ## Sub-projects born from this project diff --git a/README.zh-CN.md b/README.zh-CN.md index 0061556..369a860 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -10,13 +10,43 @@ > 深受 [Neuro-sama](https://www.youtube.com/@Neurosama) 启发 +与其他 AI 和 LLM 驱动的 VTuber 开源项目不同，アイリ VTuber 从开始开发的第一天开始就支持多种 Web 技术，涵盖诸如 [WebGPU](https://www.w3.org/TR/webgpu/)、[WebAudio](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API)、[Web Workers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Using_web_workers)、[WebAssembly](https://webassembly.org/)、[WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket) 等已经广泛应用或仍在大量实验的 API。 + +这意味着 **アイリ VTuber 能够在现代浏览器和设备上运行**，甚至能够在移动设备上运行（已经通过 PWA 支持），这为我们（贡献者们）带来了更多的可能性，使我们能够构建和扩展 アイリ VTuber 的外部功能，使其更上一层楼，而与此同时也依然给予用户灵活配置的可能性，可以选择性地在不同设备上启用会需要 TCP 连接或其他非 Web 技术的功能，例如连接到 Discord 的语音频道一起开黑，或是和你和你的朋友们一起玩 Minecraft（我的世界）、Factorio（异星工厂）。 + +> [!NOTE] +> +> 我们仍处于早期开发阶段，正在寻求有才华的开发人员加入我们，帮助我们将 アイリ VTuber 变为现实。 +> +> 如果你不熟悉 Vue.js、TypeScript 和这个项目所需的开发工具，也没关系，你可以作为艺术家、设计师、运营策划加入我们，甚至帮助我们启动我们的第一个直播。 +> +> 即使您是 React 或 Svelte，甚至是 Solid 的忠实粉丝也没关系，我们也欢迎您的加入，您可以自己创建一个子目录，添加您希望在 アイリ VTuber 中看到的功能，或想实验性支持的功能。 +> +> 我们正在寻找的领域（和相关项目）： +> +> - Live2D 模型师 +> - VRM 模型师 +> - VRChat 模型设计师 +> - 计算机视觉（CV） +> - 强化学习（RL） +> - 语音识别 +> - 语音合成 +> - ONNX 推理运行时 +> - Transformers.js +> - vLLM +> - WebGPU +> - Three.js +> - WebXR (也可以看看我们在 @moeru-ai 组织下另外的[这个项目](https://github.com/moeru-ai/n3p6)) +> +> **如果你已经感兴趣了，为什么不来这里和大家打个招呼呢？[Would like to join part of us to build Airi?](https://github.com/moeru-ai/airi/discussions/33)** + ## 当前进度 能够 - [x] 大脑 - [x] 玩 [Minecraft](https://www.minecraft.net) - - [ ] 玩 [Factorio](https://www.factorio.com) (WIP, 但 [PoC 和演示可用](https://github.com/moeru-ai/airi-factorio)) + - [x] 玩 [Factorio](https://www.factorio.com) - [x] 在 [Telegram](https://telegram.org) 聊天 - [x] 在 [Discord](https://discord.com) 聊天 - [x] 耳朵 diff --git a/cspell.config.yaml b/cspell.config.yaml index 16d8d75..7c37dcb 100644 --- a/cspell.config.yaml +++ b/cspell.config.yaml @@ -45,6 +45,7 @@ words: - DuckDBWASMQ - DuckDBWASMQuery - elevenlabs + - Factorio - formkit - gcornut - giteeai