Skip to content

Latest commit

 

History

History
103 lines (65 loc) · 2.41 KB

DEVELOPMENT.md

File metadata and controls

103 lines (65 loc) · 2.41 KB
Raw

Cloning the repo

Cloning via SSH

Run the following command to clone the repo with submodule:

git clone [email protected]:guansss/pixi-live2d-display.git --recursive

Cloning via HTTPS

Run the following command to clone the repo without submodule:

git clone https://github.com/guansss/pixi-live2d-display.git

Then follow one of the following methods to manually install the submodule:

Method 1

git config --global url."https://github.com/guansss/CubismWebFramework.git".insteadOf "[email protected]:guansss/CubismWebFramework.git"

git submodule sync
git submodule update --init

Method 2

Edit .gitmodules and replace [email protected]:guansss/CubismWebFramework.git with https://github.com/guansss/CubismWebFramework.git (don't commit this change if you are contributing to this project!).

Then run:

git submodule sync
git submodule update --init

Setup

Install dependencies:

npm install

Download Live2D core files into ./core:

npm run setup

Testing

There's a bundle test that requires a production build. Before running the tests for the first time, you need to build the project: (at some point I will automate this step so you don't have to do it manually)

npm run build

Then you can run the tests:

npm run test

Or run the tests and update snapshots:

npm run test:u

If you get an error like This version of ChromeDriver only supports Chrome version XX, you need to either upgrade or downgrade your Chrome browser to match that version, or run npm install chromedriver@<version> to install the correct version of ChromeDriver (don't commit this change if you are contributing to this project!).

Playground

The playground is for debugging and testing. To run the playground:

npm run playground

Then make changes to playground/index.ts and check the result.

Changes to this file should not be committed to git. You can run this command to tell git not to track this file:

git update-index --skip-worktree playground/index.ts

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any ideas or suggestions.

Before contributing, or better yet, before each commit, please run the following command to lint and fix the code:

npm run lint:fix

If there are any errors that cannot be fixed automatically, please fix them manually.