From 8b8b681a61b97cbd9f41e8f8d5eaccb04e68ca43 Mon Sep 17 00:00:00 2001 From: Sakutaro Date: Sat, 30 May 2026 17:57:19 +0900 Subject: [PATCH] docs(README): update Homebrew Cask and scoop install tip for all languages (#1880) ## Description Adds the official Homebrew Cask install command for macOS to the README installation tip. This lets macOS users install AIRI directly with: ```sh brew install --cask airi ``` without needing to add a custom Homebrew tap. ## Linked Issues Related to #866 Related to #1431 ## Additional Context AIRI is now available as a Homebrew Cask, so the previous tap-based installation discussion can be resolved with the standard cask install flow. --- README.md | 6 +++++ docs/README.fr.md | 56 ++++++++++++++++++++++++++++++++++++++--- docs/README.ja-JP.md | 58 +++++++++++++++++++++++++++++++++++++----- docs/README.ko-KR.md | 19 +++++++++++--- docs/README.ru-RU.md | 55 +++++++++++++++++++++++++++++++++++++--- docs/README.vi.md | 60 +++++++++++++++++++++++++++++++++++++++++--- docs/README.zh-CN.md | 57 +++++++++++++++++++++++++++++++++++++---- 7 files changed, 286 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 701592bee..7dc89d4e0 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,12 @@ > scoop bucket add airi https://github.com/moeru-ai/airi > scoop install airi/airi > ``` +> +> On macOS, you can install AIRI with [Homebrew Cask](https://brew.sh/) without adding a custom tap: +> +> ```sh +> brew install --cask airi +> ``` > [!WARNING] > **Attention:** We **do not** have any officially minted cryptocurrency or token associated with this project. Please check the information and proceed with caution. diff --git a/docs/README.fr.md b/docs/README.fr.md index c926506e6..f8f9ceb9a 100644 --- a/docs/README.fr.md +++ b/docs/README.fr.md @@ -30,8 +30,6 @@

- -

@@ -136,6 +134,20 @@ > Fortement inspiré par [Neuro-sama](https://www.youtube.com/@Neurosama) +> [!TIP] +> Sous Windows, vous pouvez également installer AIRI avec [Scoop](https://scoop.sh/) : +> +> ```powershell +> scoop bucket add airi https://github.com/moeru-ai/airi +> scoop install airi/airi +> ``` +> +> Sous macOS, vous pouvez installer AIRI avec [Homebrew Cask](https://brew.sh/) sans ajouter de tap personnalisé : +> +> ```sh +> brew install --cask airi +> ``` + > [!WARNING] > **Attention :** Nous **n'avons pas** de crypto-monnaie ou de token officiel associé à ce projet. Veuillez vérifier les informations et procéder avec prudence. @@ -273,6 +285,42 @@ Un package Nix pour Tamagotchi est inclus. Pour lancer AIRI avec Nix, assurez-vo nix run github:moeru-ai/airi ``` +### Stage Pocket (version mobile) + +Lancez le serveur de développement de la version Web Capacitor : + +```shell +pnpm dev:pocket +``` + +Vérifiez l'adresse IP dans la sortie de cette commande : + +```shell + ROLLDOWN-VITE v7.3.0 ready in 1073 ms + + ➜ Local: https://localhost:5273/ + ➜ Network: https://:5273/ + ➜ Vue DevTools: Open https://localhost:5273/__devtools__/ as a separate window + ➜ Vue DevTools: Press Option(⌥)+Shift(⇧)+D in App to toggle the Vue DevTools + ➜ UnoCSS Inspector: https://localhost:5273/__unocss/ +``` + +Ouvrez le projet Xcode : + +```shell +CAPACITOR_DEV_SERVER_URL=https://:5273 pnpm open:ios +``` + +Xcode s'ouvrira ensuite, et vous pourrez cliquer sur le bouton "Run" pour lancer l'application sur un iPhone. + +Si vous devez connecter le canal serveur de Pocket en mode sans fil, vous devez lancer Tamagotchi avec les droits root : + +```shell +sudo pnpm dev:tamagotchi +``` + +Activez ensuite le websocket sécurisé dans `settings/connections` de Tamagotchi. + ### Site de la Documentation ```shell @@ -315,6 +363,7 @@ npx bumpp --no-commit --no-tag - [x] [Baichuan](https://platform.baichuan-ai.com) - [x] [Minimax](https://api.minimax.chat/) - [x] [Moonshot AI](https://platform.moonshot.cn/) +- [x] [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) - [x] [Player2](https://player2.game/) - [x] [Tencent Cloud](https://cloud.tencent.com/document/product/1729) - [ ] [Sparks](https://www.xfyun.cn/doc/spark/Web.html) (PR bienvenue) @@ -445,8 +494,7 @@ flowchart TD ### Non open source -- https://clips.twitch.tv/WanderingCaringDeerDxCat-Qt55xtiGDSoNmDDr - https://www.youtube.com/watch?v=8Giv5mupJNE +- https://clips.twitch.tv/WanderingCaringDeerDxCat-Qt55xtiGDSoNmDDr https://www.youtube.com/watch?v=8Giv5mupJNE - https://clips.twitch.tv/TriangularAthleticBunnySoonerLater-SXpBk1dFso21VcWD - https://www.youtube.com/@NOWA_Mirai diff --git a/docs/README.ja-JP.md b/docs/README.ja-JP.md index 9b4ae3aa8..dab075671 100644 --- a/docs/README.ja-JP.md +++ b/docs/README.ja-JP.md @@ -14,8 +14,7 @@

Project AIRI

-

Neuro-sama を再創造し、AI waifu / バーチャルキャラクターの魂の器をこの世界へ。

-

Neuro-sama のようなバーチャルパートナーも、私たちの暮らしの一部に。

+

Neuro-sama を再創造し、AI waifu / バーチャルキャラクターの魂の器をこの世界へ。/ Neuro-sama のようなバーチャルパートナーも、私たちの暮らしの一部に。

[Discordサーバーに参加する] [試してみる] [English] [简体中文] [Русский] [Tiếng Việt] [Français] [한국어] @@ -31,8 +30,6 @@

- -

@@ -137,9 +134,22 @@ > [Neuro-sama](https://www.youtube.com/@Neurosama) に大きな影響を受けました +> [!TIP] +> Windows では、[Scoop](https://scoop.sh/) でも AIRI をインストールできます： +> +> ```powershell +> scoop bucket add airi https://github.com/moeru-ai/airi +> scoop install airi/airi +> ``` +> +> macOS では、カスタム tap を追加せずに [Homebrew Cask](https://brew.sh/) で AIRI をインストールできます： +> +> ```sh +> brew install --cask airi +> ``` + > [!WARNING] -> **ご注意：** -> 当プロジェクトでは、公式の暗号通貨やトークン等は**一切発行しておりません**。誤情報などにご注意ください。 +> **ご注意：** 当プロジェクトでは、公式の暗号通貨やトークン等は**一切発行しておりません**。誤情報などにご注意ください。 > [!NOTE] > @@ -275,6 +285,42 @@ pnpm dev:tamagotchi nix run github:moeru-ai/airi ``` +### Stage Pocket（モバイル版） + +Capacitor Web 版の開発サーバーを起動します： + +```shell +pnpm dev:pocket +``` + +上記コマンドの出力から IP アドレスを確認してください： + +```shell + ROLLDOWN-VITE v7.3.0 ready in 1073 ms + + ➜ Local: https://localhost:5273/ + ➜ Network: https://:5273/ + ➜ Vue DevTools: Open https://localhost:5273/__devtools__/ as a separate window + ➜ Vue DevTools: Press Option(⌥)+Shift(⇧)+D in App to toggle the Vue DevTools + ➜ UnoCSS Inspector: https://localhost:5273/__unocss/ +``` + +Xcode プロジェクトを開きます： + +```shell +CAPACITOR_DEV_SERVER_URL=https://:5273 pnpm open:ios +``` + +Xcode が開いたら、"Run" ボタンをクリックして iPhone 上でアプリを実行できます。 + +ワイヤレスモードで Pocket のサーバーチャンネルへ接続する必要がある場合は、Tamagotchi を root 権限で起動してください： + +```shell +sudo pnpm dev:tamagotchi +``` + +その後、Tamagotchi の `settings/connections` で secure websocket を有効にしてください。 + ### ドキュメントサイト ```shell diff --git a/docs/README.ko-KR.md b/docs/README.ko-KR.md index b206d771a..f4d7d2340 100644 --- a/docs/README.ko-KR.md +++ b/docs/README.ko-KR.md @@ -134,9 +134,22 @@ > [Neuro-sama](https://www.youtube.com/@Neurosama)에서 큰 영감을 받았습니다 +> [!TIP] +> Windows에서는 [Scoop](https://scoop.sh/)으로도 AIRI를 설치할 수 있습니다: +> +> ```powershell +> scoop bucket add airi https://github.com/moeru-ai/airi +> scoop install airi/airi +> ``` +> +> macOS에서는 별도의 커스텀 tap을 추가하지 않고 [Homebrew Cask](https://brew.sh/)로 AIRI를 설치할 수 있습니다: +> +> ```sh +> brew install --cask airi +> ``` + > [!WARNING] -> **주의:** -> 본 프로젝트와 관련된 공식 암호화폐나 토큰은 **일절 발행하지 않았습니다**. 관련 정보에 주의하시고 신중하게 판단해 주세요. +> **주의:** 본 프로젝트와 관련된 공식 암호화폐나 토큰은 **일절 발행하지 않았습니다**. 관련 정보에 주의하시고 신중하게 판단해 주세요. > [!NOTE] > @@ -306,7 +319,7 @@ CAPACITOR_DEV_SERVER_URL=https://:5273 pnpm open:ios sudo pnpm dev:tamagotchi ``` -그런 다음 Tamagotchi의 `settings/system/general`에서 보안 웹소켓을 활성화하세요. +그런 다음 Tamagotchi의 `settings/connections`에서 보안 웹소켓을 활성화하세요. ### 문서 사이트 diff --git a/docs/README.ru-RU.md b/docs/README.ru-RU.md index 78620add3..c1a19eef0 100644 --- a/docs/README.ru-RU.md +++ b/docs/README.ru-RU.md @@ -134,6 +134,20 @@ Руководство от сообщества: Для более подробного пошагового руководства по настройке, включая получение ключей API и настройку среды, ознакомьтесь с этим замечательным руководством, написанным сообществом. > Сильно вдохновлено [Neuro-sama](https://www.youtube.com/@Neurosama) +> [!TIP] +> В Windows AIRI также можно установить с помощью [Scoop](https://scoop.sh/): +> +> ```powershell +> scoop bucket add airi https://github.com/moeru-ai/airi +> scoop install airi/airi +> ``` +> +> В macOS AIRI можно установить через [Homebrew Cask](https://brew.sh/) без добавления собственного tap: +> +> ```sh +> brew install --cask airi +> ``` + > [!WARNING] > **Внимание:** У нас **нет** официально выпущенной криптовалюты или токена, связанного с этим проектом. Пожалуйста, проверяйте информацию и действуйте с осторожностью. @@ -246,9 +260,7 @@ > Для подробных инструкций по разработке этого проекта следуйте [CONTRIBUTING.md](../.github/CONTRIBUTING.md) > [!NOTE] -> По умолчанию `pnpm dev` запустит сервер разработки для Stage Web (версия для браузера). -> Если вы хотите попробовать разработку десктопной версии, пожалуйста, убедитесь, -> что вы прочитали [CONTRIBUTING.md](../.github/CONTRIBUTING.md), чтобы правильно настроить среду. +> По умолчанию `pnpm dev` запустит сервер разработки для Stage Web (версия для браузера). Если вы хотите попробовать разработку десктопной версии, пожалуйста, убедитесь, что вы прочитали [CONTRIBUTING.md](../.github/CONTRIBUTING.md), чтобы правильно настроить среду. ```shell pnpm i @@ -273,6 +285,42 @@ pnpm dev:tamagotchi nix run github:moeru-ai/airi ``` +### Stage Pocket (мобильная версия) + +Запустите сервер разработки веб-версии Capacitor: + +```shell +pnpm dev:pocket +``` + +Найдите IP-адрес в выводе этой команды: + +```shell + ROLLDOWN-VITE v7.3.0 ready in 1073 ms + + ➜ Local: https://localhost:5273/ + ➜ Network: https://:5273/ + ➜ Vue DevTools: Open https://localhost:5273/__devtools__/ as a separate window + ➜ Vue DevTools: Press Option(⌥)+Shift(⇧)+D in App to toggle the Vue DevTools + ➜ UnoCSS Inspector: https://localhost:5273/__unocss/ +``` + +Откройте проект Xcode: + +```shell +CAPACITOR_DEV_SERVER_URL=https://:5273 pnpm open:ios +``` + +После этого откроется Xcode, и вы сможете нажать кнопку "Run", чтобы запустить приложение на iPhone. + +Если нужно подключить серверный канал Pocket в беспроводном режиме, запустите Tamagotchi с правами root: + +```shell +sudo pnpm dev:tamagotchi +``` + +Затем включите secure websocket в `settings/connections` Tamagotchi. + ### Сайт документации ```shell @@ -315,6 +363,7 @@ npx bumpp --no-commit --no-tag - [x] [Baichuan](https://platform.baichuan-ai.com) - [x] [Minimax](https://api.minimax.chat/) - [x] [Moonshot AI](https://platform.moonshot.cn/) +- [x] [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) - [x] [Player2](https://player2.game/) - [x] [Tencent Cloud](https://cloud.tencent.com/document/product/1729) - [ ] [Sparks](https://www.xfyun.cn/doc/spark/Web.html) (PR welcome) diff --git a/docs/README.vi.md b/docs/README.vi.md index 055119481..f8d1b38cc 100644 --- a/docs/README.vi.md +++ b/docs/README.vi.md @@ -134,11 +134,27 @@ > Lấy cảm hứng mạnh mẽ từ [Neuro-sama](https://www.youtube.com/@Neurosama) +> [!TIP] +> Trên Windows, bạn cũng có thể cài AIRI bằng [Scoop](https://scoop.sh/): +> +> ```powershell +> scoop bucket add airi https://github.com/moeru-ai/airi +> scoop install airi/airi +> ``` +> +> Trên macOS, bạn có thể cài AIRI bằng [Homebrew Cask](https://brew.sh/) mà không cần thêm custom tap: +> +> ```sh +> brew install --cask airi +> ``` + > [!WARNING] > **Chú ý:** Chúng tôi **không** phát hành bất kỳ loại tiền điện tử hay token chính thức nào liên quan đến dự án này. Hãy kiểm tra kỹ thông tin trước khi tham gia. > [!NOTE] +> > Chúng tôi có cả một tổ chức riêng [@proj-airi](https://github.com/proj-airi) cho các dự án con xuất phát từ AIRI. Hãy xem qua nhé! +> > Bao gồm: RAG, hệ thống bộ nhớ, cơ sở dữ liệu nhúng, icon, tiện ích Live2D, và nhiều hơn nữa. > [!TIP] @@ -155,8 +171,6 @@ Có lẽ bạn đã biết [Neuro-sama](https://www.youtube.com/@Neurosama). Cô Do đó, dự án AIRI mang đến một lựa chọn khác: **cho phép bạn sở hữu thực thể số của riêng mình, dễ dàng, mọi lúc, mọi nơi.** ---- - ## DevLogs Đã Đăng & Cập Nhật Gần Đây - [DevLog @ 2026.03.23](https://airi.moeru.ai/docs/en/blog/DevLog-2026.03.23/) ngày 23 tháng 3, 2026 @@ -182,6 +196,7 @@ Khác với các dự án VTuber AI mã nguồn mở khác, **アイリ** đư Điều này có nghĩa là **アイリ có thể chạy trên các trình duyệt và thiết bị hiện đại**, kể cả thiết bị di động (đã hỗ trợ PWA). Điều này mở ra nhiều khả năng để chúng tôi (nhà phát triển) nâng VTuber アイリ lên tầm cao mới, đồng thời vẫn để người dùng linh hoạt bật các tính năng cần TCP hoặc công nghệ ngoài Web như kết nối kênh thoại Discord hay chơi Minecraft, Factorio với bạn bè. > [!NOTE] +> > Chúng tôi vẫn đang ở giai đoạn đầu phát triển và tìm kiếm nhà phát triển tài năng để cùng hiện thực hoá アイリ. > > Không sao nếu bạn chưa quen Vue.js, TypeScript, hay devtools của dự án này, bạn vẫn có thể tham gia với vai trò hoạ sĩ, nhà thiết kế, hoặc giúp chúng tôi tổ chức buổi livestream đầu tiên. @@ -189,6 +204,7 @@ Khác với các dự án VTuber AI mã nguồn mở khác, **アイリ** đư > Kể cả bạn là fan của React, Svelte hay Solid, chúng tôi vẫn chào đón. Bạn có thể mở thư mục phụ để thêm tính năng mà bạn muốn thử nghiệm cho アイリ. > > Các mảng (và dự án liên quan) chúng tôi cần: +> > - Live2D modeller > - VRM modeller > - Nhà thiết kế avatar VRChat @@ -244,8 +260,7 @@ Khả năng: > Để xem hướng dẫn chi tiết phát triển, tham khảo [CONTRIBUTING.md](../.github/CONTRIBUTING.md) > [!NOTE] -> Mặc định, `pnpm dev` sẽ khởi chạy server cho Stage Web (phiên bản trình duyệt). -> Nếu muốn phát triển bản desktop, hãy đọc [CONTRIBUTING.md](../.github/CONTRIBUTING.md) để cấu hình đúng môi trường. +> Mặc định, `pnpm dev` sẽ khởi chạy server cho Stage Web (phiên bản trình duyệt). Nếu muốn phát triển bản desktop, hãy đọc [CONTRIBUTING.md](../.github/CONTRIBUTING.md) để cấu hình đúng môi trường. ```shell pnpm i @@ -270,6 +285,42 @@ Gói Nix dành cho Tamagotchi được bao gồm. Để chạy airi với Nix, t nix run github:moeru-ai/airi ``` +### Stage Pocket (phiên bản di động) + +Khởi chạy server phát triển cho phiên bản web Capacitor: + +```shell +pnpm dev:pocket +``` + +Kiểm tra địa chỉ IP trong output của lệnh trên: + +```shell + ROLLDOWN-VITE v7.3.0 ready in 1073 ms + + ➜ Local: https://localhost:5273/ + ➜ Network: https://:5273/ + ➜ Vue DevTools: Open https://localhost:5273/__devtools__/ as a separate window + ➜ Vue DevTools: Press Option(⌥)+Shift(⇧)+D in App to toggle the Vue DevTools + ➜ UnoCSS Inspector: https://localhost:5273/__unocss/ +``` + +Mở project Xcode: + +```shell +CAPACITOR_DEV_SERVER_URL=https://:5273 pnpm open:ios +``` + +Sau đó Xcode sẽ mở, và bạn có thể bấm nút "Run" để chạy app trên iPhone. + +Nếu cần kết nối server channel trên Pocket ở chế độ không dây, bạn cần khởi chạy Tamagotchi với quyền root: + +```shell +sudo pnpm dev:tamagotchi +``` + +Sau đó bật secure websocket trong `settings/connections` của Tamagotchi. + ### Trang tài liệu ```shell @@ -312,6 +363,7 @@ npx bumpp --no-commit --no-tag - [x] [Baichuan](https://platform.baichuan-ai.com) - [x] [Minimax](https://api.minimax.chat/) - [x] [Moonshot AI](https://platform.moonshot.cn/) +- [x] [ModelScope](https://modelscope.cn/docs/model-service/API-Inference/intro) - [x] [Player2](https://player2.game/) - [x] [Tencent Cloud](https://cloud.tencent.com/document/product/1729) - [ ] [Sparks](https://www.xfyun.cn/doc/spark/Web.html) (PR welcome) diff --git a/docs/README.zh-CN.md b/docs/README.zh-CN.md index e13970b88..f69fc9d4f 100644 --- a/docs/README.zh-CN.md +++ b/docs/README.zh-CN.md @@ -30,8 +30,6 @@

- -

@@ -136,9 +134,22 @@ > 深受 [Neuro-sama](https://www.youtube.com/@Neurosama) 启发 +> [!TIP] +> 在 Windows 上，你也可以使用 [Scoop](https://scoop.sh/) 安装 AIRI： +> +> ```powershell +> scoop bucket add airi https://github.com/moeru-ai/airi +> scoop install airi/airi +> ``` +> +> 在 macOS 上，你无需添加自定义 tap，即可通过 [Homebrew Cask](https://brew.sh/) 安装 AIRI： +> +> ```sh +> brew install --cask airi +> ``` + > [!WARNING] -> **注意：** -> 我们**没有发行任何**与本项目关联的加密货币或代币，请注意判断资讯并谨慎行事。 +> **注意：** 我们**没有发行任何**与本项目关联的加密货币或代币，请注意判断资讯并谨慎行事。 > [!NOTE] > @@ -213,6 +224,7 @@ ## 当前进度 目前已经能做到： + - [x] 大脑 - [x] 玩 [Minecraft](https://www.minecraft.net) - [x] 玩 [Factorio](https://www.factorio.com)（进行中，但已提供 [PoC 和 demo](https://github.com/moeru-ai/airi-factorio)） @@ -273,6 +285,42 @@ pnpm dev:tamagotchi nix run github:moeru-ai/airi ``` +### Stage Pocket（移动版） + +启动 Capacitor Web 版本的开发服务器： + +```shell +pnpm dev:pocket +``` + +从上述命令的输出中查看 IP 地址： + +```shell + ROLLDOWN-VITE v7.3.0 ready in 1073 ms + + ➜ Local: https://localhost:5273/ + ➜ Network: https://:5273/ + ➜ Vue DevTools: Open https://localhost:5273/__devtools__/ as a separate window + ➜ Vue DevTools: Press Option(⌥)+Shift(⇧)+D in App to toggle the Vue DevTools + ➜ UnoCSS Inspector: https://localhost:5273/__unocss/ +``` + +打开 Xcode 项目： + +```shell +CAPACITOR_DEV_SERVER_URL=https://:5273 pnpm open:ios +``` + +随后 Xcode 会打开，你可以点击 "Run" 按钮在 iPhone 上运行应用。 + +如果需要在无线模式下连接 Pocket 的 server channel，需要以 root 权限启动 Tamagotchi： + +```shell +sudo pnpm dev:tamagotchi +``` + +然后在 Tamagotchi 的 `settings/connections` 中启用 secure websocket。 + ### 文档站 ```shell @@ -455,7 +503,6 @@ flowchart TD ![Repobeats analytics image](https://repobeats.axiom.co/api/embed/a1d6fe2c13ea2bb53a5154435a71e2431f70c2ee.svg 'Repobeats analytics image') ## 鸣谢 - - [AtomGit](https://gitcode.com/moeru-ai/airi): 在国内托管 AIRI，帮助中国大陆用户更快访问项目与下载 Release。 - [Reka UI](https://github.com/unovue/reka-ui): 文档站的设计，新的 landing page 也基于此，并感谢他们实现了大量 UI 组件。（shadcn-vue 使用 Reka UI 作为 headless 组件，去看看！） - [pixiv/ChatVRM](https://github.com/pixiv/ChatVRM)