Update to Cubism 4 SDK for Web R5
wada
parent
2a2d4f34c6
commit
33087bc4d4
|
|
@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
|
|||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
||||
|
||||
|
||||
## [4-r.5] - 2022-09-08
|
||||
|
||||
### Added
|
||||
|
||||
* Add the multilingual supported documents.
|
||||
|
||||
|
||||
## [4-r.5-beta.5] - 2022-08-04
|
||||
|
||||
### Changed
|
||||
|
|
@ -146,6 +153,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|||
* Fix issue with reloading model images in WebKit.
|
||||
|
||||
|
||||
[4-r.5]: https://github.com/Live2D/CubismWebSamples/compare/4-r.5-beta.5...4-r.5
|
||||
[4-r.5-beta.5]: https://github.com/Live2D/CubismWebSamples/compare/4-r.5-beta.4...4-r.5-beta.5
|
||||
[4-r.5-beta.4]: https://github.com/Live2D/CubismWebSamples/compare/4-r.5-beta.3...4-r.5-beta.4
|
||||
[4-r.5-beta.3]: https://github.com/Live2D/CubismWebSamples/compare/4-r.5-beta.2...4-r.5-beta.3
|
||||
|
|
|
|||
|
|
@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
|
|||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
||||
|
||||
|
||||
## 2022-09-08
|
||||
|
||||
### Added
|
||||
|
||||
* Add the multilingual supported documents.
|
||||
* Support Visual Studio 2022.
|
||||
|
||||
|
||||
## 2022-08-04
|
||||
|
||||
### Fixed
|
||||
|
|
|
|||
|
|
@ -0,0 +1,30 @@
|
|||
[English](README.md) / [日本語](README.ja.md)
|
||||
|
||||
---
|
||||
|
||||
# Live2D Cubism Core
|
||||
|
||||
このフォルダーには、JavaScriptまたはTypeScriptアプリケーションを開発するためのコアライブラリファイルが含まれています。
|
||||
|
||||
|
||||
## ファイルリスト
|
||||
|
||||
### live2dcubismcore.d.ts
|
||||
|
||||
このファイルには、`live2dcubismcore.js`に関するTypeScriptの型情報が含まれています。
|
||||
TypeScriptで開発する場合は、このファイルを`live2dcubismcore.js`とともに使用してください。
|
||||
|
||||
### live2dcubismcore.js
|
||||
|
||||
このファイルには、CubismCoreの機能といくつかのラッパーが含まれています。
|
||||
JavaScriptで開発する場合は、このファイルを使用してください。
|
||||
|
||||
### live2dcubismcore.js.map
|
||||
|
||||
このファイルは、`live2dcubismcore.d.ts`と`live2dcubismcore.js`の間のソースマップです。
|
||||
デバッグ時にこのファイルを使用します。
|
||||
|
||||
### live2dcubismcore.min.js
|
||||
|
||||
このファイルは、`live2dcubismcore.js`のminify版です。
|
||||
このファイルを本番環境で使用します。
|
||||
|
|
@ -1,3 +1,7 @@
|
|||
[English](README.md) / [日本語](README.ja.md)
|
||||
|
||||
---
|
||||
|
||||
# Live2D Cubism Core
|
||||
|
||||
This folder contains core library files for developing JavaScript or TypeScript applications.
|
||||
|
|
@ -22,5 +26,5 @@ Use this file when debugging.
|
|||
|
||||
### live2dcubismcore.min.js
|
||||
|
||||
This file is minified of `live2dcubismcore.js`.
|
||||
This file is the minified version of `live2dcubismcore.js`.
|
||||
Use this file in production.
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Subproject commit e115df6e1e7a190ecdd7795c15ef222254fb193c
|
||||
Subproject commit e3df50532b68d8a13fe7966bec1aa418a7d09e87
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
[English](NOTICE.md) / [日本語](NOTICE.ja.md)
|
||||
|
||||
---
|
||||
|
||||
# お知らせ
|
||||
|
||||
## [注意事項] Cubism 4 SDK for Web R1 以降へのアップデートに伴う注意
|
||||
|
||||
Cubism 4 SDK for Web R1 にてそれ以前のベータ版から正式版のリリースに伴い、
|
||||
利便性向上のためパッケージ及びリポジトリの構造変更がおこなわれました。
|
||||
|
||||
この変更は Cubism 4 SDK for Native と構造を変えずに運用がなされるほか、
|
||||
ユーザに管理が不必要なファイルが混在することを避けることが理由です。
|
||||
|
||||
構造の変更点、及び Cubism 4 SDK for Web beta2 以前のプロジェクトからの更新方法に関して、
|
||||
[Cubism SDK Manual] に詳細を記載しています。アップデートを行う際は必ずご確認ください。
|
||||
|
||||
[Cubism SDK Manual]: https://docs.live2d.com/cubism-sdk-manual/warning-for-cubism4-web-r1-update/
|
||||
|
||||
---
|
||||
|
||||
©Live2D
|
||||
21
NOTICE.md
21
NOTICE.md
|
|
@ -1,12 +1,19 @@
|
|||
## [注意事項] Cubism 4 SDK for Web R1 以降へのアップデートに伴う注意
|
||||
[English](NOTICE.md) / [日本語](NOTICE.ja.md)
|
||||
|
||||
Cubism 4 SDK for Web R1 にてそれ以前のベータ版から正式版のリリースに伴い、
|
||||
利便性向上のためパッケージ及びリポジトリの構造変更がおこなわれました。
|
||||
---
|
||||
|
||||
この変更は Cubism 4 SDK for Native と構造を変えずに運用がなされるほか、
|
||||
ユーザに管理が不必要なファイルが混在することを避けることが理由です。
|
||||
# Notices
|
||||
|
||||
構造の変更点、及び Cubism 4 SDK for Web beta2 以前のプロジェクトからの更新方法に関して、
|
||||
[Cubism SDK Manual] に詳細を記載しています。アップデートを行う際は必ずご確認ください。
|
||||
## [Caution] Precautions for updating to Cubism 4 SDK for Web R1 or later
|
||||
|
||||
With the release of the official version of the Cubism 4 SDK for Web R1 from the previous beta version, the structure of packages and repositories has been changed to improve usability.
|
||||
|
||||
The reason for this change is to operate without changing the structure of Cubism 4 SDK for Native, and to avoid mixing files that do not require management by users.
|
||||
|
||||
Details on structural changes and how to update from projects prior to Cubism 4 SDK for Web beta2 are described in the [Cubism SDK Manual]. Please be sure to check it when updating.
|
||||
|
||||
[Cubism SDK Manual]: https://docs.live2d.com/cubism-sdk-manual/warning-for-cubism4-web-r1-update/
|
||||
|
||||
---
|
||||
|
||||
©Live2D
|
||||
|
|
|
|||
|
|
@ -0,0 +1,136 @@
|
|||
[English](README.md) / [日本語](README.ja.md)
|
||||
|
||||
---
|
||||
|
||||
# Cubism Web Samples
|
||||
|
||||
Live2D Cubism 4 Editor で出力したモデルを表示するアプリケーションのサンプル実装です。
|
||||
|
||||
Cubism Web Framework および Live2D Cubism Core と組み合わせて使用します。
|
||||
|
||||
|
||||
## ライセンス
|
||||
|
||||
本 SDK を使用する前に、[ライセンス](LICENSE.md)をご確認ください。
|
||||
|
||||
|
||||
## お知らせ
|
||||
|
||||
本 SDK を使用する前に、[お知らせ](NOTICE.ja.md)をご確認ください。
|
||||
|
||||
|
||||
## ディレクトリ構成
|
||||
|
||||
```
|
||||
.
|
||||
├─ .vscode # Visual Studio Code 用プロジェクト設定ディレクトリ
|
||||
├─ Core # Live2D Cubism Core が含まれるディレクトリ
|
||||
├─ Framework # レンダリングやアニメーション機能などのソースコードが含まれるディレクトリ
|
||||
└─ Samples
|
||||
├─ Resources # モデルのファイルや画像などのリソースが含まれるディレクトリ
|
||||
└─ TypeScript # TypeScript のサンプルプロジェクトが含まれるディレクトリ
|
||||
```
|
||||
|
||||
|
||||
## Live2D Cubism Core for Web
|
||||
|
||||
モデルをロードするためのライブラリです。
|
||||
|
||||
当リポジトリではCubism Coreを管理していません。
|
||||
[こちら](https://www.live2d.com/download/cubism-sdk/download-web/)からCubism SDK for Webをダウンロードして、
|
||||
Coreディレクトリのファイルをコピーしてください。
|
||||
|
||||
|
||||
## 開発環境構築
|
||||
|
||||
1. [Node.js] と [Visual Studio Code] をインストールします
|
||||
1. Visual Studio Code で **本 SDK のトップディレクトリ** を開き、推奨拡張機能をインストールします
|
||||
* ポップアップ通知の他、拡張機能タブから `@recommended` を入力することで確認できます
|
||||
|
||||
### サンプルデモの動作確認
|
||||
|
||||
コマンドパレット（*View > Command Palette...*）で `>Tasks: Run Task` を入力することで、タスク一覧が表示されます。
|
||||
|
||||
1. タスク一覧から `npm: install - Samples/TypeScript/Demo` を選択して依存パッケージのダウンロードを行います
|
||||
1. タスク一覧から `npm: build - Samples/TypeScript/Demo` を選択してサンプルデモのビルドを行います
|
||||
1. タスク一覧から `npm: serve - Samples/TypeScript/Demo` を選択して動作確認用の簡易サーバを起動します
|
||||
1. ブラウザの URL 欄に `http://localhost:5000/Samples/TypeScript/Demo/` と入力してアクセスします
|
||||
1. コマンドパレットから `>Tasks: Terminate Task` を入力して `npm: serve` を選択すると簡易サーバが終了します
|
||||
|
||||
その他のタスクに関してはサンプルプロジェクトの [README.md](Samples/TypeScript/README.ja.md) を参照ください。
|
||||
|
||||
NOTE: デバック用の設定は、`.vscode/tasks.json` に記述しています。
|
||||
|
||||
### プロジェクトのデバック
|
||||
|
||||
Visual Studio Code で **本 SDK のトップディレクトリ** を開き、 *F5* キーを入力すると Debugger for Chrome が起動します。
|
||||
|
||||
Visual Studio Code 上でブレイクポイントを貼って Chrome ブラウザと連動してデバックを行うことができます。
|
||||
|
||||
NOTE: デバック用の設定は、`.vscode/launch.json` に記述しています。
|
||||
|
||||
|
||||
## SDKマニュアル
|
||||
|
||||
[Cubism SDK Manual](https://docs.live2d.com/cubism-sdk-manual/top/)
|
||||
|
||||
|
||||
## 変更履歴
|
||||
|
||||
当リポジトリの変更履歴については [CHANGELOG.md](CHANGELOG.md) を参照ください。
|
||||
|
||||
|
||||
## 開発環境
|
||||
|
||||
### Node.js
|
||||
|
||||
* 18.8.0
|
||||
* 16.17.0
|
||||
* 14.20.0
|
||||
|
||||
|
||||
## 動作確認環境
|
||||
|
||||
| プラットフォーム | ブラウザ | バージョン |
|
||||
| --- | --- | --- |
|
||||
| Android | Google Chrome | 104.0.5112.97 |
|
||||
| Android | Microsoft Edge | 104.0.1293.63 |
|
||||
| Android | Mozilla Firefox | 104.1.0 |
|
||||
| iOS / iPadOS | Google Chrome | 104.0.5112.99 |
|
||||
| iOS / iPadOS | Microsoft Edge | 104.0.1293.63 |
|
||||
| iOS / iPadOS | Mozilla Firefox | 104.0 |
|
||||
| iOS / iPadOS | Safari | 15.6.1 |
|
||||
| macOS | Google Chrome | 104.0.5112.101 |
|
||||
| macOS | Microsoft Edge | 104.0.1293.70 |
|
||||
| macOS | Mozilla Firefox | 104.0 |
|
||||
| macOS | Safari | 15.6.1 |
|
||||
| Windows | Google Chrome | 104.0.5112.102 |
|
||||
| Windows | Microsoft Edge | 104.0.1293.70 |
|
||||
| Windows | Mozilla Firefox | 104.0 |
|
||||
|
||||
Note: 動作確認時のサーバの起動は `./Samples/TypeScript/Demo/package.json` の `serve` スクリプトを使用して行っています。
|
||||
|
||||
|
||||
## プロジェクトへの貢献
|
||||
|
||||
プロジェクトに貢献する方法はたくさんあります。バグのログの記録、このGitHubでのプルリクエストの送信、Live2Dコミュニティでの問題の報告と提案の作成です。
|
||||
|
||||
### フォークとプルリクエスト
|
||||
|
||||
修正、改善、さらには新機能をもたらすかどうかにかかわらず、プルリクエストに感謝します。ただし、ラッパーは可能な限り軽量で浅くなるように設計されているため、バグ修正とメモリ/パフォーマンスの改善のみを行う必要があることに注意してください。メインリポジトリを可能な限りクリーンに保つために、必要に応じて個人用フォークと機能ブランチを作成してください。
|
||||
|
||||
### バグ
|
||||
|
||||
Live2Dコミュニティでは、問題のレポートと機能リクエストを定期的にチェックしています。バグレポートを提出する前に、Live2Dコミュニティで検索して、問題のレポートまたは機能リクエストがすでに投稿されているかどうかを確認してください。問題がすでに存在する場合は、関連するコメントを追記してください。
|
||||
|
||||
### 提案
|
||||
|
||||
SDKの将来についてのフィードバックにも関心があります。Live2Dコミュニティで提案や機能のリクエストを送信できます。このプロセスをより効果的にするために、それらをより明確に定義するのに役立つより多くの情報を含めるようお願いしています。
|
||||
|
||||
|
||||
## コミュニティ
|
||||
|
||||
ユーザー同士でCubism SDKの活用方法の提案や質問をしたい場合は、是非コミュニティをご活用ください。
|
||||
|
||||
- [Live2D 公式コミュニティ](https://creatorsforum.live2d.com/)
|
||||
- [Live2D community(English)](https://community.live2d.com/)
|
||||
140
README.md
140
README.md
|
|
@ -1,115 +1,135 @@
|
|||
[English](README.md) / [日本語](README.ja.md)
|
||||
|
||||
---
|
||||
|
||||
# Cubism Web Samples
|
||||
|
||||
Live2D Cubism 4 Editor で出力したモデルを表示するアプリケーションのサンプル実装です。
|
||||
This is a sample implementation of an application that displays models output by Live2D Cubism 4 Editor.
|
||||
|
||||
Cubism Web Framework および Live2D Cubism Core と組み合わせて使用します。
|
||||
It is used in conjunction with the Cubism Web Framework and Live2D Cubism Core.
|
||||
|
||||
|
||||
## ライセンス
|
||||
## License
|
||||
|
||||
本 SDK を使用する前に、[ライセンス](LICENSE.md)をご確認ください。
|
||||
Please check the [license](LICENSE.md) before using this SDK.
|
||||
|
||||
|
||||
## 注意事項
|
||||
## Notices
|
||||
|
||||
本 SDK を使用する前に、[注意事項](NOTICE.md)をご確認ください。
|
||||
Please check the [notices](NOTICE.md) before using this SDK.
|
||||
|
||||
|
||||
## ディレクトリ構成
|
||||
## Directory structure
|
||||
|
||||
```
|
||||
.
|
||||
├─ .vscode # Visual Studio Code 用プロジェクト設定ディレクトリ
|
||||
├─ Core # Live2D Cubism Core が含まれるディレクトリ
|
||||
├─ Framework # レンダリングやアニメーション機能などのソースコードが含まれるディレクトリ
|
||||
├─ .vscode # Project settings directory for Visual Studio Code
|
||||
├─ Core # Directory containing Live2D Cubism Core
|
||||
├─ Framework # Directory containing source code such as rendering and animation functions
|
||||
└─ Samples
|
||||
├─ Resources # モデルのファイルや画像などのリソースが含まれるディレクトリ
|
||||
└─ TypeScript # TypeScript のサンプルプロジェクトが含まれるディレクトリ
|
||||
├─ Resources # Directory containing resources such as model files and images
|
||||
└─ TypeScript # Directory containing TypeScript sample projects
|
||||
```
|
||||
|
||||
|
||||
## Live2D Cubism Core for Web
|
||||
|
||||
モデルをロードするためのライブラリです。
|
||||
A library for loading the model.
|
||||
|
||||
当リポジトリではCubism Coreを管理していません。
|
||||
[こちら](https://www.live2d.com/download/cubism-sdk/download-web/)からCubism SDK for Webをダウンロードして、
|
||||
Coreディレクトリのファイルをコピーしてください。
|
||||
This repository does not manage Cubism Core.
|
||||
Download the Cubism SDK for Web from [here](https://www.live2d.com/download/cubism-sdk/download-web/) and copy the files in the Core directory.
|
||||
|
||||
|
||||
## 開発環境構築
|
||||
## Development environment construction
|
||||
|
||||
1. [Node.js] と [Visual Studio Code] をインストールします
|
||||
1. Visual Studio Code で **本 SDK のトップディレクトリ** を開き、推奨拡張機能をインストールします
|
||||
* ポップアップ通知の他、拡張機能タブから `@recommended` を入力することで確認できます
|
||||
1. Install [Node.js] and [Visual Studio Code]
|
||||
1. Open **the top directory of this SDK** in Visual Studio Code and install the recommended extensions
|
||||
* In addition to pop-up notifications, you can check the others by typing `@recommended` from the Extensions tab
|
||||
|
||||
### サンプルデモの動作確認
|
||||
### Operation check of sample demo
|
||||
|
||||
コマンドパレット（*View > Command Palette...*）で `>Tasks: Run Task` を入力することで、タスク一覧が表示されます。
|
||||
Enter `>Tasks: Run Task` in the command palette (*View > Command Palette...*) to display the task list.
|
||||
|
||||
1. タスク一覧から `npm: install - Samples/TypeScript/Demo` を選択して依存パッケージのダウンロードを行います
|
||||
1. タスク一覧から `npm: build - Samples/TypeScript/Demo` を選択してサンプルデモのビルドを行います
|
||||
1. タスク一覧から `npm: serve - Samples/TypeScript/Demo` を選択して動作確認用の簡易サーバを起動します
|
||||
1. ブラウザの URL 欄に `http://localhost:5000/Samples/TypeScript/Demo/` と入力してアクセスします
|
||||
1. コマンドパレットから `>Tasks: Terminate Task` を入力して `npm: serve` を選択すると簡易サーバが終了します
|
||||
1. Select `npm: install - Samples/TypeScript/Demo` from the task list to download the dependent packages
|
||||
1. Select `npm: build - Samples/TypeScript/Demo` from the task list to build the sample demo
|
||||
1. Select `npm: serve - Samples/TypeScript/Demo` from the task list to start the simple server for operation check
|
||||
1. Enter `http://localhost:5000/Samples/TypeScript/Demo/` in the URL field of your browser to access it
|
||||
1. Enter `>Tasks: Terminate Task` from the command palette and select `npm: serve` to terminate the simple server
|
||||
|
||||
その他のタスクに関してはサンプルプロジェクトの [README.md](Samples/TypeScript/README.md) を参照ください。
|
||||
For other tasks, see [README.md](Samples/TypeScript/README.md) of the sample project.
|
||||
|
||||
NOTE: デバック用の設定は、`.vscode/tasks.json` に記述しています。
|
||||
NOTE: Settings for debugging are described in `.vscode/tasks.json`.
|
||||
|
||||
### プロジェクトのデバック
|
||||
### Project debugging
|
||||
|
||||
Visual Studio Code で **本 SDK のトップディレクトリ** を開き、 *F5* キーを入力すると Debugger for Chrome が起動します。
|
||||
Open **the top directory of this SDK** in Visual Studio Code and enter the *F5* key to start Debugger for Chrome.
|
||||
|
||||
Visual Studio Code 上でブレイクポイントを貼って Chrome ブラウザと連動してデバックを行うことができます。
|
||||
You can place breakpoints in Visual Studio Code to debug in conjunction with the Chrome browser.
|
||||
|
||||
NOTE: デバック用の設定は、`.vscode/launch.json` に記述しています。
|
||||
NOTE: Settings for debugging are described in `.vscode/launch.json`.
|
||||
|
||||
|
||||
## SDKマニュアル
|
||||
## SDK manual
|
||||
|
||||
[Cubism SDK Manual](https://docs.live2d.com/cubism-sdk-manual/top/)
|
||||
|
||||
|
||||
## 変更履歴
|
||||
## Changelog
|
||||
|
||||
当リポジトリの変更履歴については [CHANGELOG.md](CHANGELOG.md) を参照ください。
|
||||
Please refer to [CHANGELOG.md](CHANGELOG.md) for the changelog of this repository.
|
||||
|
||||
|
||||
## 開発環境
|
||||
## Development environment
|
||||
|
||||
### Node.js
|
||||
|
||||
* 18.7.0
|
||||
* 16.16.0
|
||||
* 18.8.0
|
||||
* 16.17.0
|
||||
* 14.20.0
|
||||
|
||||
|
||||
## 動作確認環境
|
||||
## Operation environment
|
||||
|
||||
| プラットフォーム | ブラウザ | バージョン |
|
||||
| Platform | Browser | Version |
|
||||
| --- | --- | --- |
|
||||
| Android | Google Chrome | 103.0.5060.129 |
|
||||
| Android | Microsoft Edge | 101.0.1210.47 |
|
||||
| Android | Mozilla Firefox | 100.1.2 |
|
||||
| iOS / iPadOS | Google Chrome | 101.0.4951.58 |
|
||||
| iOS / iPadOS | Microsoft Edge | 101.1210.47 |
|
||||
| iOS / iPadOS | Mozilla Firefox | 100.1 |
|
||||
| iOS / iPadOS | Safari | 15.6 |
|
||||
| macOS | Google Chrome | 101.0.4951.64 |
|
||||
| macOS | Microsoft Edge | 101.0.1210.47 |
|
||||
| macOS | Mozilla Firefox | 100.0.1 |
|
||||
| macOS | Safari | 15.6 |
|
||||
| Windows | Google Chrome | 102.0.5005.115 |
|
||||
| Windows | Microsoft Edge | 103.0.1264.71 |
|
||||
| Windows | Mozilla Firefox | 100.0 |
|
||||
| Android | Google Chrome | 104.0.5112.97 |
|
||||
| Android | Microsoft Edge | 104.0.1293.63 |
|
||||
| Android | Mozilla Firefox | 104.1.0 |
|
||||
| iOS / iPadOS | Google Chrome | 104.0.5112.99 |
|
||||
| iOS / iPadOS | Microsoft Edge | 104.0.1293.63 |
|
||||
| iOS / iPadOS | Mozilla Firefox | 104.0 |
|
||||
| iOS / iPadOS | Safari | 15.6.1 |
|
||||
| macOS | Google Chrome | 104.0.5112.101 |
|
||||
| macOS | Microsoft Edge | 104.0.1293.70 |
|
||||
| macOS | Mozilla Firefox | 104.0 |
|
||||
| macOS | Safari | 15.6.1 |
|
||||
| Windows | Google Chrome | 104.0.5112.102 |
|
||||
| Windows | Microsoft Edge | 104.0.1293.70 |
|
||||
| Windows | Mozilla Firefox | 104.0 |
|
||||
|
||||
Note: 動作確認時のサーバの起動は `./Samples/TypeScript/Demo/package.json` の `serve` スクリプトを使用して行っています。
|
||||
Note: You can start the server for operation check by running the `serve` script of `./Samples/TypeScript/Demo/package.json`.
|
||||
|
||||
|
||||
## コミュニティ
|
||||
## Contributing
|
||||
|
||||
ユーザー同士でCubism SDKの活用方法の提案や質問をしたい場合は、是非コミュニティをご活用ください。
|
||||
There are many ways to contribute to the project: logging bugs, submitting pull requests on this GitHub, and reporting issues and making suggestions in Live2D Community.
|
||||
|
||||
- [Live2D 公式コミュニティ](https://creatorsforum.live2d.com/)
|
||||
- [Live2D community(English)](https://community.live2d.com/)
|
||||
### Forking And Pull Requests
|
||||
|
||||
We very much appreciate your pull requests, whether they bring fixes, improvements, or even new features. Note, however, that the wrapper is designed to be as lightweight and shallow as possible and should therefore only be subject to bug fixes and memory/performance improvements. To keep the main repository as clean as possible, create a personal fork and feature branches there as needed.
|
||||
|
||||
### Bugs
|
||||
|
||||
We are regularly checking issue-reports and feature requests at Live2D Community. Before filing a bug report, please do a search in Live2D Community to see if the issue-report or feature request has already been posted. If you find your issue already exists, make relevant comments and add your reaction.
|
||||
|
||||
### Suggestions
|
||||
|
||||
We're also interested in your feedback for the future of the SDK. You can submit a suggestion or feature request at Live2D Community. To make this process more effective, we're asking that you include more information to help define them more clearly.
|
||||
|
||||
|
||||
## Community
|
||||
|
||||
If you want to suggest or ask questions about how to use the Cubism SDK between users, please use the community.
|
||||
|
||||
- [Live2D community](https://community.live2d.com/)
|
||||
- [Live2D 公式コミュニティ (Japanese)](https://creatorsforum.live2d.com/)
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -11,19 +11,19 @@
|
|||
"clean": "rimraf dist"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@typescript-eslint/eslint-plugin": "^5.31.0",
|
||||
"@typescript-eslint/parser": "^5.31.0",
|
||||
"eslint": "^8.20.0",
|
||||
"@typescript-eslint/eslint-plugin": "^5.35.1",
|
||||
"@typescript-eslint/parser": "^5.35.1",
|
||||
"eslint": "^8.22.0",
|
||||
"eslint-config-prettier": "^8.5.0",
|
||||
"eslint-plugin-prettier": "^4.2.1",
|
||||
"prettier": "^2.7.1",
|
||||
"rimraf": "^3.0.2",
|
||||
"serve": "^14.0.1",
|
||||
"ts-loader": "^9.3.1",
|
||||
"typescript": "^4.7.4",
|
||||
"typescript": "^4.8.2",
|
||||
"webpack": "^5.74.0",
|
||||
"webpack-cli": "^4.10.0",
|
||||
"webpack-dev-server": "^4.9.3"
|
||||
"webpack-dev-server": "^4.10.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"whatwg-fetch": "^3.6.2"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,72 @@
|
|||
[English](README.md) / [日本語](README.ja.md)
|
||||
|
||||
---
|
||||
|
||||
# Cubism Web Samples for TypeScript
|
||||
|
||||
TypeScript で実装したアプリケーションのサンプル実装です。
|
||||
|
||||
|
||||
## 開発環境
|
||||
|
||||
| パッケージ | バージョン |
|
||||
| --- | --- |
|
||||
| TypeScript | 4.8.2 |
|
||||
| Webpack | 5.74.0 |
|
||||
|
||||
その他のパッケージに関しては、各プロジェクトの `package.json` を確認してください。
|
||||
また、その他の開発環境・動作確認環境はトップディレクトリにある [README.md](/README.ja.md) を参照してください。
|
||||
|
||||
|
||||
## タスク一覧
|
||||
|
||||
### `npm: start`
|
||||
|
||||
開発用のローカルサーバが起動され、プロジェクトの監視ビルドが行われます。
|
||||
プロジェクトの変更を行うと自動的に再ビルドが行われ、ブラウザのリロードが発生します。
|
||||
[プロジェクトのデバック]から Visual Studio Code 上でデバックを行うことができます。
|
||||
|
||||
Visual Studio Code 上で終了する場合は、
|
||||
コマンドパレットから `>Tasks: Terminate Task` を入力してタスクを選択します。
|
||||
|
||||
### `npm: build`
|
||||
|
||||
`dist` ディレクトリに、TypeScript のビルド成果物を出力します。
|
||||
Webpack を用いて1つにまとめられた JavaScript ファイルが出力されます。
|
||||
|
||||
`tsconfig.json` 及び `webpack.config.js` を編集することで設定内容を変更できます。
|
||||
|
||||
### `npm: build:prod`
|
||||
|
||||
上記のビルドを最適化した上で行います。
|
||||
ビルドサイズが削減されるため、本番環境用の成果物の出力に使用します。
|
||||
|
||||
### `npm: test`
|
||||
|
||||
TypeScript の型チェックテストを行います。
|
||||
|
||||
`tsconfig.json` を編集することで設定内容を変更できます。
|
||||
|
||||
### `npm: lint`
|
||||
|
||||
`src` ディレクトリ内の TypeScript ファイルの静的解析を行います。
|
||||
|
||||
`.eslintrc.yml` を編集することで設定内容を変更できます。
|
||||
|
||||
### `npm: lint:fix`
|
||||
|
||||
`src` ディレクトリ内の TypeScript ファイルの静的解析及び自動修正を行います。
|
||||
|
||||
`.eslintrc.yml` を編集することで設定内容を変更できます。
|
||||
|
||||
### `npm: serve`
|
||||
|
||||
簡易ローカルサーバを起動します。
|
||||
ブラウザからサーバ内の `/Samples/TypeScript/Demo` にアクセスすることで index.html の確認ができます。
|
||||
事前にプロジェクトのビルドを行なっている必要があります。
|
||||
|
||||
本番環境に近い環境で成果物の検証を行うことができます。
|
||||
|
||||
### `npm: clean`
|
||||
|
||||
ビルド成果物ディレクトリ（`dist`）を削除します。
|
||||
|
|
@ -1,68 +1,71 @@
|
|||
[English](README.md) / [日本語](README.ja.md)
|
||||
|
||||
---
|
||||
|
||||
# Cubism Web Samples for TypeScript
|
||||
|
||||
TypeScript で実装したアプリケーションのサンプル実装です。
|
||||
This is a sample implementation of an application implemented with TypeScript.
|
||||
|
||||
|
||||
## 開発環境
|
||||
## Development environment
|
||||
|
||||
| パッケージ | バージョン |
|
||||
| Package | Version |
|
||||
| --- | --- |
|
||||
| TypeScript | 4.6.4 |
|
||||
| Webpack | 5.72.1 |
|
||||
| TypeScript | 4.8.2 |
|
||||
| Webpack | 5.74.0 |
|
||||
|
||||
その他のパッケージに関しては、各プロジェクトの `package.json` を確認してください。
|
||||
また、その他の開発環境・動作確認環境はトップディレクトリにある [README.md](/README.md) を参照してください。
|
||||
For other packages, check the `package.json` for each project.
|
||||
For other development environments and operation environments, see [README.md](/README.md) in the top directory.
|
||||
|
||||
|
||||
## タスク一覧
|
||||
## Task list
|
||||
|
||||
### `npm: start`
|
||||
|
||||
開発用のローカルサーバが起動され、プロジェクトの監視ビルドが行われます。
|
||||
プロジェクトの変更を行うと自動的に再ビルドが行われ、ブラウザのリロードが発生します。
|
||||
[プロジェクトのデバック]から Visual Studio Code 上でデバックを行うことができます。
|
||||
Starts a local server for development and creates a project monitor build.
|
||||
Any changes you make to the project will automatically rebuild and cause the browser to reload.
|
||||
You can debug in Visual Studio Code from [Debug Project].
|
||||
|
||||
Visual Studio Code 上で終了する場合は、
|
||||
コマンドパレットから `>Tasks: Terminate Task` を入力してタスクを選択します。
|
||||
To terminate in Visual Studio Code, type `>Tasks: Terminate Task` and select the task from the command palette.
|
||||
|
||||
### `npm: build`
|
||||
|
||||
`dist` ディレクトリに、TypeScript のビルド成果物を出力します。
|
||||
Webpack を用いて1つにまとめられた JavaScript ファイルが出力されます。
|
||||
Outputs a TypeScript build deliverable to the `dist` directory.
|
||||
The output is a JavaScript file that has been bundled into one using Webpack.
|
||||
|
||||
`tsconfig.json` 及び `webpack.config.js` を編集することで設定内容を変更できます。
|
||||
You can change the settings by editing `tsconfig.json` and `webpack.config.js`.
|
||||
|
||||
### `npm: build:prod`
|
||||
|
||||
上記のビルドを最適化した上で行います。
|
||||
ビルドサイズが削減されるため、本番環境用の成果物の出力に使用します。
|
||||
Creates above build after optimizing it.
|
||||
It is used to output deliverables for production environments as it reduces the build size.
|
||||
|
||||
### `npm: test`
|
||||
|
||||
TypeScript の型チェックテストを行います。
|
||||
Performs a TypeScript type check test.
|
||||
|
||||
`tsconfig.json` を編集することで設定内容を変更できます。
|
||||
You can change the settings by editing `tsconfig.json`.
|
||||
|
||||
### `npm: lint`
|
||||
|
||||
`src` ディレクトリ内の TypeScript ファイルの静的解析を行います。
|
||||
Performs static analysis of TypeScript files in the `src` directory.
|
||||
|
||||
`.eslintrc.yml` を編集することで設定内容を変更できます。
|
||||
You can change the settings by editing `.eslintrc.yml`.
|
||||
|
||||
### `npm: lint:fix`
|
||||
|
||||
`src` ディレクトリ内の TypeScript ファイルの静的解析及び自動修正を行います。
|
||||
Performs static analysis and automatic modification of TypeScript files in the `src` directory.
|
||||
|
||||
`.eslintrc.yml` を編集することで設定内容を変更できます。
|
||||
You can change the settings by editing `.eslintrc.yml`.
|
||||
|
||||
### `npm: serve`
|
||||
|
||||
簡易ローカルサーバを起動します。
|
||||
ブラウザからサーバ内の `/Samples/TypeScript/Demo` にアクセスすることで index.html の確認ができます。
|
||||
事前にプロジェクトのビルドを行なっている必要があります。
|
||||
Starts a simple local server.
|
||||
You can check the index.html by accessing `/Samples/TypeScript/Demo` in the server from your browser.
|
||||
The project needs to be built in advance.
|
||||
|
||||
本番環境に近い環境で成果物の検証を行うことができます。
|
||||
Deliverables can be verified in an environment close to the production environment.
|
||||
|
||||
### `npm: clean`
|
||||
|
||||
ビルド成果物ディレクトリ（`dist`）を削除します。
|
||||
Deletes the build deliverable directory (`dist`).
|
||||
|
|
|
|||
Loading…
Reference in New Issue