Use OpenSeeFace to control Live2D model
[facial-landmarks-for-cubism.git] / README.md
index 21b72ac..77a7383 100644 (file)
--- a/README.md
+++ b/README.md
@@ -51,10 +51,15 @@ performance.
    and the OpenCV library (I'm using version 4.3.0). To compile the example
    program you will also require the OpenGL library (and its dev headers)
    among other libraries required for the example program. The libraries I
-   had to install (this list may not be exhaustive) are:
+   had to install on Ubuntu 18.04 (this list may not be exhaustive) are:
 
        libgl1-mesa-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libglu1-mesa-dev
 
+   A Debian Bullseye user has [reported](https://github.com/adrianiainlam/facial-landmarks-for-cubism/issues/2)
+   the following extra requirements:
+
+       libopencv-dev libopenblas-dev liblapack-dev
+
 2. Clone this repository including its submodule (dlib)
 
        git clone --recurse-submodules https://github.com/adrianiainlam/facial-landmarks-for-cubism.git
@@ -80,17 +85,17 @@ To build the example program:
 5. Copy the extracted dlib dataset from step 4 to the "example" folder
    of this repo.
 
-6. Download "Cubism 4 SDK for Native R1" from the Live2D website:
+6. Download "Cubism 4 SDK for Native R2" from the Live2D website:
    <https://www.live2d.com/en/download/cubism-sdk/download-native/>.
 
-   Extract the archive -- put the "CubismSdkForNative-4-r.1" folder under
+   Extract the archive -- put the "CubismSdkForNative-4-r.2" folder under
    the "example" folder of this repo.
 
    Note: The Cubism SDK is the property of Live2D and is not part of this
    project. You must agree to Live2D's license agreements to use it.
 
 7. Go into the
-   "example/CubismSdkForNative-4-r.1/Samples/OpenGL/thirdParty/scripts"
+   "example/CubismSdkForNative-4-r.2/Samples/OpenGL/thirdParty/scripts"
    directory and run
 
        ./setup_glew_glfw
@@ -122,6 +127,9 @@ for the Facial Landmarks for Cubism library.
  * `--translate-y`, `-y`: Vertical translation of the model within the window
  * `--model`, `-m`: Name of the model to be used. This must be located inside
    the "Resources" folder.
+ * `--old-param-id`, `-o`: If set to 1, translate new (Cubism 3+) parameter
+   IDs to old (Cubism 2.1) IDs. This is necessary, for example, for
+   [the Chitose model available from Live2D](https://www.live2d.com/en/download/sample-data/).
  * `--config`, `-c`: Path to the configuration file for the Facial Landmarks
    for Cubism library. See below for more details.