From 18f4755a7f854145fbdb3678dbd587f76324cac4 Mon Sep 17 00:00:00 2001 From: YY_Serendipity Date: Sat, 28 Oct 2023 13:33:27 +0800 Subject: [PATCH] Update README.md --- README.md | 51 ++++++++++++++++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index a72b3b8..bece6aa 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,19 @@
- [![description](https://img.shields.io/badge/project-Individual-1F1F1F?style=for-the-badge)](https://github.com/KennardWang/VTuber-MomoseHiyori) + [![description](https://img.shields.io/badge/project-Individual-FFB7C5?style=for-the-badge)](https://github.com/KennardWang/VTuber-MomoseHiyori)   [![stars](https://img.shields.io/github/stars/KennardWang/VTuber-MomoseHiyori?style=for-the-badge&color=FDEE21)](https://github.com/KennardWang/VTuber-MomoseHiyori/stargazers)   [![forks](https://img.shields.io/github/forks/KennardWang/VTuber-MomoseHiyori?style=for-the-badge&color=white)](https://github.com/KennardWang/VTuber-MomoseHiyori/forks)   [![contributors](https://img.shields.io/github/contributors/KennardWang/VTuber-MomoseHiyori?style=for-the-badge&color=8BC0D0)](https://github.com/KennardWang/VTuber-MomoseHiyori/graphs/contributors) - +   - + +   +     @@ -22,11 +24,11 @@     - +   - +   - +

@@ -37,7 +39,7 @@
-๐Ÿ‘‹ Hello, I am Momose Hiyori, a Live2D VTuber from Japan. My parents are Cubsim and Unity, my teachers are OpenCV and Deep Learning. I am really good at mimicking faces including poses and expressions, it is a pleasure to meet you all and look forward to being good friends~ โค๏ธ๐Ÿงก๐Ÿฉท๐Ÿฉต๐Ÿ’Ÿ๐Ÿ’—๐Ÿฅฐ๐Ÿ’• +๐Ÿ‘‹ Hello, I am Momose Hiyori, a Live2D VTuber from Japan. My parents are Cubsim and Unity, my teachers are OpenCV and Deep Learning. I am really good at mimicking faces including poses and expressions, it is a pleasure to meet you all and look forward to being good friends~ โค๏ธ๐Ÿงก๐Ÿ’—๐Ÿฅฐ๐Ÿ’•
@@ -74,14 +76,14 @@ | | | | :------: | :----------------------------------------------------------------------------------------------------------: | | System | Windows 10 x64 | -| Language | Python 3.8 (algorithm), C# (Unity Script) | -| IDE | PyCharm 2019.2.5 (algorithm), Live2D Cubism Editor 4.0 (Live2D model), Unity 2019.4.1f1 LTS (Engine) | +| Language | Python 3.8 (algorithm), C# (Unity script) | +| IDE | Visual Studio Code 1.83.1 (algorithm), Live2D Cubism Editor 4.0 (Live2D model), Unity 2022.3.12f1 LTS (Engine) | ## Install -1. Install [Pycharm](https://www.jetbrains.com/pycharm/download/#section=windows), [Unity](https://unity.com/releases/editor/whats-new/2019.4.1) and Python 3.8 (recommend [Anaconda](https://www.anaconda.com/products/individual)). +1. Install Python 3.8 (recommend to use [Anaconda](https://www.anaconda.com/products/individual)), [Unity](https://unity.com/releases/editor/whats-new/2022.3.12) (recommend to use [UnityHub](https://unity.com/download)). 2. Download the executable file from the latest [release](https://github.com/KennardWang/VTuber-MomoseHiyori/releases/tag/v3.1.0). 3. Environment configuration. @@ -98,7 +100,7 @@ pip install -r requirements.txt ``` -5. There are 2 types of running environments, please choose the correct one based on individual conditions. +5. There are 2 types of running environments, please choose the env based on your condition. + CPU env + Install **dlib**, my version is v19.24.2. @@ -120,8 +122,15 @@ ``` pip install torch==1.10.2+cu102 torchvision==0.11.3+cu102 torchaudio===0.10.2+cu102 -f https://download.pytorch.org/whl/cu102/torch_stable.html ``` - - + MacOS (ARM) with Apple M1 + + + MacOS (X86-64) with Intel + + Install [Pytorch](https://pytorch.org/). + + ``` + conda install pytorch torchvision torchaudio -c pytorch + ``` + + + MacOS (ARM64) with Apple M1 + Install [Pytorch](https://pytorch.org/). ``` @@ -184,7 +193,7 @@ If it runs normally, you can see your face, and press `q` to quit. **Optional : Set Parameters** -There are some parameters you can change. The default port number is 14514, you could set another port number via `--port=PORT_NUMBER`, but keep it the same as that in the Unity client. Moreover, you can set the camera via `--cam=CAM_INDEX` if you have more than one camera, the default camera index is 0. Please check the guidance of all parameters by using `python main.py --help`. +There are some parameters you can change. The default port number is `14514`, you could set another port number via `--port=PORT_NUMBER`, but keep it the same as that in the Unity client. Moreover, you can set the camera via `--cam=CAM_INDEX` if you have more than one camera, the default camera index is 0. Please check the guidance of all parameters by using `python main.py --help`.
@@ -201,10 +210,10 @@ There are some parameters you can change. The default port number is 14514, you | File / Folder | Description | | :---------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| UnityAssets | Unity materials for those who want to make Live2D VTuber by themselves, please visit [tutorial](https://github.com/KennardWang/VTuber-MomoseHiyori/issues/3). | -| face_alignment | Module for face detection and landmarks by a powerful face alignment network (FAN), has better performance under GPU env. | +| UnityAssets | Unity materials for those who want to make Live2D VTuber by themselves, see [tutorial](https://github.com/KennardWang/VTuber-MomoseHiyori/issues/3). | +| face_alignment | Module for face detection and landmarks by a powerful face alignment network (FAN), recommend to use under GPU env. | | face_pose | Module for face pose detection, contains the pose estimator and stabilizer. | -| tests | Test folder for GitHub Action. | +| tests | Test folder for GitHub Actions. | | main.py | Main program. | | sock.py | File with Socket class. | | utils.py | File with utility functions. | @@ -213,7 +222,7 @@ There are some parameters you can change. The default port number is 14514, you ## Calibration Algorithms -Obviously, the position of landmarks is meaningless. In most cases, we focus on the ratio (or aspect ratio) which could describe the size, because in Unity, we use a scrolling bar to control actions or events. However, the ratio is mostly not perfect correspondence with the bar value. An interesting question is how to calibrate and map the ratio to the bar value. There are some feasible methods I implement in this project: +Obviously, the position of landmarks is meaningless. In most cases, we focus on the ratio (or aspect ratio) which could describe the degree, because in Unity, we use a scrolling bar to control actions or events. However, the ratio is mostly not perfect correspondence with the bar value. An interesting question is how to calibrate and map the ratio to the bar value. There are some feasible methods I implement in this project: ```python # Copyright 2023 ยฉ Yuyang (Kennard) Wang. @@ -298,7 +307,7 @@ def calibrate_param3(param3): ## Maintainers -![badge](https://img.shields.io/badge/maintenance-Maybe-EF2D5E) [@KennardWang](https://github.com/KennardWang) +![badge](https://img.shields.io/badge/maintenance-NO-EF2D5E) [@KennardWang](https://github.com/KennardWang) @@ -306,13 +315,13 @@ def calibrate_param3(param3): Feel free to [open an issue](https://github.com/KennardWang/VTuber-MomoseHiyori/issues) or submit [PRs](https://github.com/KennardWang/VTuber-MomoseHiyori/pulls). Be careful that the submitted code needs to pass format tests and pytests by GitHub Actions, please self-check before pulling requests. -+ flake8 format test (Windows, Mac and Linux) [![1](https://github.com/KennardWang/VTuber-MomoseHiyori/actions/workflows/flake8.yml/badge.svg)](https://github.com/KennardWang/VTuber-MomoseHiyori/actions/workflows/flake8.yml) ++ flake8 format test (Windows, MacOS and Linux) [![1](https://github.com/KennardWang/VTuber-MomoseHiyori/actions/workflows/flake8.yml/badge.svg)](https://github.com/KennardWang/VTuber-MomoseHiyori/actions/workflows/flake8.yml) ``` flake8 --exclude=face_alignment,face_pose --ignore=E501 . ``` -+ pytest (Windows, Mac and Linux) [![2](https://github.com/KennardWang/VTuber-MomoseHiyori/actions/workflows/pytest.yml/badge.svg)](https://github.com/KennardWang/VTuber-MomoseHiyori/actions/workflows/pytest.yml) ++ pytest (Windows, MacOS and Linux) [![2](https://github.com/KennardWang/VTuber-MomoseHiyori/actions/workflows/pytest.yml/badge.svg)](https://github.com/KennardWang/VTuber-MomoseHiyori/actions/workflows/pytest.yml) ``` pytest tests/test_win.py