No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3aa44df Oct 1, 2018
Permalink
Failed to load latest commit information.
data Fix invalidation wasm. Oct 1, 2018
pylib Merge pull request #2 from yamachu/feat/support_python3 Feb 8, 2018
.gitignore Initial commit Aug 22, 2017
README.md Update README.md. Apr 20, 2018
gencs.py enable on python3 Sep 12, 2017
genjs.py enable on python3 Sep 12, 2017

README.md

Cubism SDK Bindings

Welcome to the project for generating bindings to the Cubism SDK.

If you're interested in generating available bindings or in using this project for generating your own bindings, read on.

If you came here looking for official Live2D homepage, instead, you'll find it here.

Overview

The project basically consitsts of 3 parts:

  1. A representation of the Cubism SDK API in YAML
  2. Templates the YAML data is run through
  3. Generators that patch the YAML data and control what templates are to be expanded

Prerequisites

  1. Python (as that's the language the generators are written in)
  2. PyYAML (used for parsing the API descriptors)
  3. Pystache (used in the templates)

Available Generators

JavaScript

This generator doesn't only provide bindings, but also allows building a fully working JavaScript Core library. Be aware that the Core license applies to the built library as well. The generator involves a few steps:

  1. It generates TypeScript bindings for a Cubism Core to be compiled with Emscripten.
  2. It generates a script for building the Cubism Core with Emscripten and for merging all sources into one library.

Prerequisites

  1. Emscripten
  2. TypeScript
  3. Cubism SDK for Native

Usage

  1. Run python ./genjs.py. By default, this will output artefacts to ./out/js.
  2. Run python ./out/js/make.py --coredir <path-to-Cubism-SDK-Core-directory>. This will output the final library and TypeScript declarations to ./out/js/out.

C#

Usage

  1. Run python ./gencs.py. By default, this will output artefacts to ./out/cs.

Contributing

There are many ways to contribute to the project: logging bugs, submitting pull requests on this GitHub, and reporting issues and making suggestions at Live2D Community.

Discussion Etiquette

Please limit the discussion to English and keep it professional and things on topic.

TODO

  • Investigate framework generators.

License

The license applying to the source code in this project allows you modify all sources without the need to submit any changes you made. Refer to this license for the gritty details.