Update to Cubism SDK 4-r.2. Incompatible scaling changes.

[mouse-tracker-for-cubism.git] / README.md

diff --git a/README.md b/README.md
index 16a8c46..61387c3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -31,12 +31,12 @@ if you don't have C++17 support.
 1. Install dependencies.
 
    You will require a recent C/C++ compiler, `make`, `patch`, CMake >= 3.16,
-   libxdo, and PulseAudio. To compile the example
+   libxdo, PulseAudio, and a stable version of gtkmm 3. 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:
 
-       libxdo-dev libpulse-dev libgl1-mesa-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libglu1-mesa-dev
+       libxdo-dev libpulse-dev libgl1-mesa-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libglu1-mesa-dev libgtkmm-3.0-dev
 
 2. Clone this repository including its submodule (editline)
 
@@ -53,14 +53,14 @@ To build the example program:
 4. Download "Cubism 4 SDK for Native R1" 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.
 
 5. 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
@@ -103,6 +103,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 Mouse Tracker
    for Cubism library. See below for more details.
 
@@ -123,7 +126,9 @@ The library itself is provided under the MIT license. By "the library itself"
 I refer to the following files that I have provided under this repo:
 
  * src/mouse_cursor_tracker.cpp
- * include/mouse_cursor_tracker.cpp
+ * src/mouse_cursor_tracker_gui.cpp
+ * src/gui.glade
+ * include/mouse_cursor_tracker.h
  * and if you decide to build the binary for the library, the resulting
    binary file (typically build/libMouseTrackerForCubism.a)