Skip to content

A lightweight 2.5D character player for the web, with lip sync and webcam face tracking.

Docs: add Vietnamese README

Huyvux129192ff99446b
diff --git a/README.ja.md b/README.ja.md
index 18be7ca..6d72216 100644
--- a/README.ja.md
+++ b/README.ja.md
@@ -10,7 +10,7 @@
さまざまなスタイルの厳選キャラクター 21 体を同梱。すぐに使えます。
</p>
-<p align="center"><a href="README.md">English</a> · <a href="README.zh-CN.md">中文</a> · <b>日本語</b></p>
+<p align="center"><a href="README.md">English</a> · <a href="README.zh-CN.md">中文</a> · <b>日本語</b> · <a href="README.vi.md">Tiếng Việt</a></p>
<p align="center"><img src="media/demo.gif" alt="厳選キャラクターが呼吸し、まばたきし、振り向き、話す様子" width="720"></p>
diff --git a/README.md b/README.md
index 1075c96..e56041c 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@
Comes with 21 featured characters in different styles, ready to use.
</p>
-<p align="center"><b>English</b> · <a href="README.zh-CN.md">中文</a> · <a href="README.ja.md">日本語</a></p>
+<p align="center"><b>English</b> · <a href="README.zh-CN.md">中文</a> · <a href="README.ja.md">日本語</a> · <a href="README.vi.md">Tiếng Việt</a></p>
<p align="center"><img src="media/demo.gif" alt="Featured characters breathing, blinking, turning their heads and talking" width="720"></p>
diff --git a/README.vi.md b/README.vi.md
new file mode 100644
index 0000000..5098447
--- /dev/null
+++ b/README.vi.md
@@ -0,0 +1,163 @@
+<p align="center">
+ <picture>
+ <source media="(prefers-color-scheme: dark)" srcset="media/livliv-player-wordmark-white.svg">
+ <img alt="LivLiv Player" src="media/livliv-player-wordmark-2000.png" width="360">
+ </picture>
+</p>
+
+<p align="center">
+ Trình phát nhân vật 2.5D nhẹ cho web, có đồng bộ môi (lip sync) và theo dõi khuôn mặt qua webcam. Chỉ vài dòng code là đưa được nhân vật vào trang web, lớp phủ stream hay ứng dụng.<br>
+ Đi kèm 21 nhân vật nổi bật với nhiều phong cách khác nhau, sẵn sàng dùng ngay.
+</p>
+
+<p align="center"><a href="README.md">English</a> · <a href="README.zh-CN.md">中文</a> · <a href="README.ja.md">日本語</a> · <b>Tiếng Việt</b></p>
+
+<p align="center"><img src="media/demo.gif" alt="Các nhân vật nổi bật đang thở, chớp mắt, quay đầu và nói chuyện" width="720"></p>
+
+- WebGL2, không phụ thuộc thư viện ngoài, lõi chỉ khoảng 30 KB sau khi nén gzip
+- Đồng bộ môi (microphone, audio, video) và theo dõi khuôn mặt qua webcam (MediaPipe), đều chạy trong trình duyệt, chỉ được tải khi bạn cần
+- Phát nhân vật LivLiv, VRM và PNGTuber qua cùng một API
+- 21 nhân vật nổi bật trong [`characters/`](characters/), sẵn sàng dùng
+
+## Thử ngay
+
+- **Trực tuyến**: các ví dụ chạy trên [livliv-dev.github.io/player](https://livliv-dev.github.io/player/).
+- **Tại đây**: `npm install && npm run build`, phục vụ thư mục này bằng bất kỳ static server nào rồi mở `/example/demo.html`
+ (biểu cảm, hành động, microphone, camera; `?model=../characters/<id>/` chọn nhân vật khác).
+ `/example/png.html` và `/example/vrm.html` cho thấy một PNGTuber và một VRM.
+- **Trên livliv.ai**: trang của mỗi nhân vật ở đó phát nhân vật bằng cùng trình phát này. Bắt đầu tại
+ [livliv.ai/discover](https://livliv.ai/discover).
+
+## Dùng trong trang của bạn
+
+```js
+import { Player } from '@livliv/player'
+
+const player = new Player(document.querySelector('canvas'))
+await player.load('characters/k01/') // a folder with model.json and textures/, or a .livliv file
+
+player.setExpression('smile') // ids are in player.expressions
+player.act('nod')
+player.params.mouthOpen = 0.6 // 0..1
+```
+
+Đồng bộ môi và theo dõi khuôn mặt:
+
+```js
+import { createSpeech } from '@livliv/player/voice'
+import { startFaceTracking } from '@livliv/player/tracking' // needs @mediapipe/tasks-vision
+
+const speech = createSpeech(player)
+button.onclick = () => { speech.unlock(); speech.say('/reply.mp3') }
+
+await startFaceTracking(player)
+```
+
+VRM hay PNGTuber đều dùng chung một API:
+
+```js
+import { BodyPlayer } from '@livliv/player/body'
+import { VrmBody } from '@livliv/player/vrm' // needs three and @pixiv/three-vrm
+import { PngBody } from '@livliv/player/png'
+
+const vrm = new BodyPlayer(canvasA, new VrmBody())
+await vrm.load('/avatars/me.vrm')
+const png = new BodyPlayer(canvasB, new PngBody())
+await png.load({ closed: 'me-closed.png', open: 'me-open.png' })
+```
+
+Toàn bộ API có trong [API.md](API.md): các tùy chọn, tham số, biểu cảm và hành động, driver, nhân vật VRM và PNGTuber,
+giới hạn với file không đáng tin, gói model và phiên bản định dạng. Định dạng gói LivLiv (`.livliv`,
+`model.json` v4) có trong [FORMAT.md](FORMAT.md), kèm JSON Schema trong [`schema/`](schema/); các gói xuất trước v4
+được mô tả trong [FORMAT-v3.md](FORMAT-v3.md) và vẫn phát được.
+
+> Chưa có trên npm: hãy build từ repository này rồi import `dist/index.js`.
+
+## Nhân vật nổi bật
+
+`characters/` có 21 nhân vật, sẵn sàng để `load()`. Các nhân vật mang một dấu LivLiv nhỏ ở góc dưới bên phải, do
+trình phát vẽ lên. Các nhân vật này **không** thuộc phạm vi Giấy phép Apache. Hầu hết do LivLiv tạo ra: bạn được dùng miễn phí cho dự án cá nhân, phi thương mại kèm ghi công
+("Characters: LivLiv (livliv.ai)"); không được bán, dùng thương mại hay huấn luyện mô hình AI trên các nhân vật này. Nana là
+linh vật của LivLiv. Điều khoản có trong [characters/LICENSE.md](characters/LICENSE.md).
+
+Kujira, Kujira Q và Pen là tác phẩm của người khác: giấy phép và ghi công đó không áp dụng cho các nhân vật này. Nguồn,
+ghi công và điều khoản của họ có trong [characters/CREDITS.md](characters/CREDITS.md).
+
+Mỗi nhân vật còn có một `cover.webp` (512 x 768, khoảng 50 KB), là khung hình đầu tiên của nhân vật khi chưa có dấu. Hãy hiển thị ảnh này dưới canvas với
+`object-fit: contain` rồi làm nhân vật hiện dần lên trên nó, như [example/loading.js](example/loading.js) đã làm: trang có ngay
+một hình ảnh, và không có gì bị nhảy hình.
+
+| id | name | id | name | id | name |
+|---|---|---|---|---|---|
+| `k01` | Sena | `d01` | Yui | `v01` | Aster |
+| `k02` | Elio | `d02` | Leo | `v03` | Mira |
+| `char06` | Aoi | `d03` | Nana | `v04` | Kai |
+| `char07` | Sora | `d03ft` | Nana (refined) | `v05` | Lilith |
+| `s01` | Hana | `p01` | Kujira | `v06` | Usa |
+| `q02` | Mochi | `p02` | Kujira Q | `v07` | Stella |
+| `q03` | Kotaro | `p03` | Pen | `w01` | Max |
+
+## Nhân vật của riêng bạn
+
+Bạn có thể đưa vào ảnh của một PNGTuber, hoặc một VRM (vẽ bằng three.js); hoặc tự tạo nhân vật của mình từ một
+ảnh trên [livliv.ai](https://livliv.ai).
+
+- **Một PNGTuber**: hai ảnh (miệng đóng, miệng mở), và thêm hai ảnh nhắm mắt nếu bạn có.
+- **Một VRM**: từ VRoid Studio hoặc bất kỳ công cụ nào xuất VRM 0.x hay 1.0.
+- **Một model LivLiv**: tạo một model từ một ảnh trên [livliv.ai](https://livliv.ai), rồi tải gói model của model đó từ
+ trang của nhân vật (**Model package**): một file `.livliv`. Đưa file đó vào `load()` nguyên như vậy (một URL, hoặc `File`
+ người dùng đã chọn), hoặc giải nén thành thư mục. Các gói trên gói miễn phí mang dấu LivLiv, và trình phát sẽ vẽ dấu đó.
+
+## Về trình phát và các nhân vật
+
+LivLiv Player và định dạng `.livliv` là sản phẩm của chính LivLiv. Chúng không dùng phần mềm Live2D hay Cubism SDK và không
+đọc file `.moc3` hay `.cmo3`. "Live2D" là nhãn hiệu của Live2D Inc.; LivLiv không liên kết với công ty đó.
+
+Việc tạo nhân vật trên livliv.ai có dùng AI. Bản thân trình phát chỉ phát: nó không gọi dịch vụ AI nào và chỉ đọc các file
+bạn chỉ tới. Theo dõi khuôn mặt chạy MediaPipe của Google trong trình duyệt, và hình ảnh camera vẫn ở trên thiết bị; API.md có
+chi tiết về mạng.
+
+Các nhân vật nổi bật trong repository này cũng được tạo trên LivLiv, cũng bằng AI; Kujira, Kujira Q và Pen phỏng theo
+nhân vật của người khác ([ghi công](characters/CREDITS.md)). Nana bản tinh chỉnh (`d03ft`) còn có thêm
+các bộ phận đung đưa và keyform xoay đầu, được thêm bằng công cụ của chính LivLiv.
+
+`meta.author` và `meta.license` của một gói ghi lại ai đã tạo gói đó và với điều khoản nào: hãy giữ nguyên các trường này và tuân theo chúng. Khi bạn
+cho công chúng xem một nhân vật được tạo bằng LivLiv, hãy nói rằng nhân vật đó được tạo bằng AI, và đừng trình bày nó như được vẽ tay hay
+rig tay.
+
+## Nhúng không cần code
+
+```html
+<iframe src="https://livliv.ai/live/k01" width="480" height="640" allow="camera; microphone"
+ style="border:0;background:transparent"></iframe>
+```
+
+Trang `/live/<id>` tương tự có nền trong suốt và hoạt động như một OBS Browser Source.
+
+## Phát triển
+
+```sh
+git clone https://github.com/livliv-dev/player
+cd player
+npm install
+npm run check # types
+npm run build # dist/: index.js, tracking.js, voice.js, body.js, png.js, vrm.js (ES modules), chunks/ and types/
+npm test # unit and fuzz tests (Node 22.18 or newer, no browser)
+npm run test:browser # every featured character drawn in headless Chromium; once: npx playwright-core install chromium-headless-shell
+```
+
+`src/runtime/` là code renderer và chuyển động mà livliv.ai đang chạy; repository này được xuất bản từ code đó. Xem
+[CONTRIBUTING.md](CONTRIBUTING.md). Báo cáo bảo mật: [SECURITY.md](SECURITY.md).
+
+## Trình duyệt hỗ trợ
+
+WebGL2 và ES2023: Chrome / Edge 97+, Firefox 104+, Safari 15.4+. Đã kiểm tra trên các trình duyệt desktop hiện tại, chưa kiểm tra trên điện thoại.
+
+## Giấy phép
+
+Code thuộc [Giấy phép Apache 2.0](LICENSE) (xem thêm [NOTICE](NOTICE)). Các nhân vật nổi bật có
+giấy phép riêng, [characters/LICENSE.md](characters/LICENSE.md). Không giấy phép nào trong hai giấy phép trên bao hàm tên và logo LivLiv.
+
+## Cảm ơn
+
+Cảm ơn 上善无形, ZipZipPipe và 贱兔死顺盖, những người mà các nhân vật Kujira, Kujira Q và Pen dựa trên: xem [characters/CREDITS.md](characters/CREDITS.md).
diff --git a/README.zh-CN.md b/README.zh-CN.md
index 1ca952f..c9cd357 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -10,7 +10,7 @@
自带 21 个风格各异的精选角色,即开即用。
</p>
-<p align="center"><a href="README.md">English</a> · <b>中文</b> · <a href="README.ja.md">日本語</a></p>
+<p align="center"><a href="README.md">English</a> · <b>中文</b> · <a href="README.ja.md">日本語</a> · <a href="README.vi.md">Tiếng Việt</a></p>
<p align="center"><img src="media/demo.gif" alt="精选角色在呼吸、眨眼、转头、说话" width="720"></p>