diff --git a/README.ja.md b/README.ja.md index ef36463..317a934 100644 --- a/README.ja.md +++ b/README.ja.md @@ -2,12 +2,26 @@ # SpriteStudioPlayer for Godot +**Godot のゲームに、プロフェッショナルな2Dアニメーションを。直感的な使いやすさと、極限のパフォーマンスを両立するプラグイン。** + > **注意:** 本 `develop` ブランチは現在開発中のバージョンです。安定版は [main ブランチ](https://github.com/SpriteStudio/SSPlayerForGodot/tree/main) または [Releases](https://github.com/SpriteStudio/SSPlayerForGodot/releases) から取得してください。本ブランチで扱う API・ワークフローは予告なく変更される可能性があり、いかなる保証もサポートも提供しません（リクエストやバグ報告への返信もできません）。 -[OPTPiX SpriteStudio 7](https://www.webtech.co.jp/spritestudio/) で作成したアニメーションを [Godot Engine](https://godotengine.org/) 上で再生するためのハイパフォーマンスなプラグインです。 -このプラグインを使用することで、ラスターベースの2Dアニメーションを Godot プロジェクトへ簡単に実装・再生することができます。 +**[OPTPiX SpriteStudio 7](https://www.webtech.co.jp/spritestudio/)** のアニメーション (`.ssab`) を [Godot Engine](https://godotengine.org/) 上で再生するためのハイパフォーマンスな拡張プラグイン（GDExtension / カスタムモジュール）です。Godot の強力な機能と、専用アニメーションツールの表現力を組み合わせることで、リッチな2Dゲーム開発をサポートします。 + +## ✨ SpriteStudio を Godot で使うメリット + +- **キャラクターからUI、エフェクトまで完結する「圧倒的な汎用性」** + キャラクター特化型のツールとは異なり、メッシュ変形を用いたキャラクターアニメーションから、UIトランジション、リッチなパーティクルエフェクトまで、すべてを一つの専用エディタで完結できます。お使いのラスター画像の表現力を極限まで引き出します。 +- **背景やエフェクトを含めた「シーン全体」の構築** + キャラクター単体だけでなく、背景、エフェクト、UI を組み合わせた「カットシーン」や「画面全体」の演出をエディタ上で丸ごと構築し、Godot 上で1つのアニメーションとしてそのまま再生できます。 +- **他エンジンと完全に一致する「視覚的整合性」** + 複雑な状態計算は独立したコアランタイムが処理するため、Godotの独自仕様による「見た目のブレ」が構造的に発生しません。エディタ上の見た目や他エンジン上での再生結果と完全に一致することが保証されます。サブフレーム補間により、高リフレッシュレートでも滑らかに描画されます。 +- **Godotの「ノード」としての自然な統合と、コンフリクト回避** + `SpriteStudioPlayer2D` は標準的なノードとして Godot のシーンにシームレスに統合されるため、ノードツリーを肥大化させず GDScript から簡単に制御できます。同時に、アニメーションデータ自体はシーンから分離されるため、チーム開発時の Git コンフリクトを未然に防ぎます。 +- **ゼロコピー・ロードと SIMD 活用による極限パフォーマンス** + 最適化されたバイナリ（`.ssab` / FlatBuffers）へコンバートして使用することで、実行時のパース負荷をゼロに抑え、オンメモリで即座に再生できます。内部計算でSIMDをフル活用しており、最小のCPU・メモリ負荷で最大のアニメーション再生パフォーマンスを叩き出します。大量のキャラクターを描画するゲームや、モバイル環境でも余裕のある動作を実現します。 -## ドキュメント +## 📚 ドキュメント 詳細な使い方は `docs/` フォルダ内のドキュメントを参照してください。 @@ -24,7 +38,7 @@ - [ビルドガイド](./docs/ja/setup/build.md) - [v1.x からのマイグレーション](./docs/ja/migration_from_v1.md) -## GDExtension を用いたクイックスタート +## 🚀 GDExtension を用いたクイックスタート 初めての方向けに、サンプルプロジェクトを使用した動作確認と、ご自身のプロジェクトへ導入する手順の2つを用意しています。 @@ -43,13 +57,13 @@ 詳細は [インストールガイド](./docs/ja/setup/install.md) を参照してください。 -## 概要 (Overview) +## 💡 概要 (Overview) 本プラグインは、**SpriteStudio と Godot エディタをシームレスに行き来できる強力なアセットパイプライン**を備え、一瞬でアセットを更新することが可能です。 データフロー図、主な機能、対応バージョンなどの詳細は **[ドキュメント (日本語)](./docs/ja/index.md)** を参照してください。 -## サンプル +## 🎬 サンプル [examples フォルダ](./examples/) に SDK のテストプロジェクトに基づいたサンプルプロジェクトがあります。 @@ -61,11 +75,11 @@ - [overall_gdextension](./examples/overall_gdextension) — GDExtension 版での総合テスト - [ParticleEffect](./examples/ParticleEffect) — エフェクト機能のテスト -## 関連リポジトリ +## 🔗 関連リポジトリ - [SpriteStudio-SDK](https://github.com/cri-middleware/SpriteStudio-SDK) — `libssruntime` / `libssconverter` を提供する SDK 本体 -## ライセンス +## 📄 ライセンス [LICENSE.md](./LICENSE.md) を参照してください。 diff --git a/README.md b/README.md index 3118cf3..1f1d794 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,26 @@ # SpriteStudioPlayer for Godot +**Professional 2D animations for your Godot games. A plugin that balances intuitive usability with extreme performance.** + > **Note:** This `develop` branch is a work-in-progress version. The stable version can be obtained from the [main branch](https://github.com/SpriteStudio/SSPlayerForGodot/tree/main) or from [Releases](https://github.com/SpriteStudio/SSPlayerForGodot/releases). The APIs and workflows in this branch may change without notice, and no warranty or support is provided (we cannot respond to feature requests or bug reports). -A high-performance plugin for playing back animations created with [OPTPiX SpriteStudio 7](https://www.webtech.co.jp/spritestudio/) inside [Godot Engine](https://godotengine.org/). -This plugin allows you to easily implement and play back raster-based 2D animations within your Godot projects. +A high-performance extension plugin (GDExtension / Custom Module) for playing animations (`.ssab`) created with **[OPTPiX SpriteStudio 7](https://www.webtech.co.jp/spritestudio/)** on [Godot Engine](https://godotengine.org/). By combining Godot's powerful features with the expressive capabilities of a dedicated animation tool, it fully supports the development of rich 2D games. + +## ✨ Why use SpriteStudio with Godot? + +- **Unmatched Versatility: From Characters to UI and Effects** + Unlike character-specific tools, you can author everything from character animations using mesh deformation to UI transitions and rich particle effects, all within a single dedicated editor. It maximizes the expressive power of your raster images. +- **Build "Entire Scenes" including Backgrounds and Effects** + Beyond animating individual characters, you can construct entire "cutscenes" or "full screen" presentations—combining characters, backgrounds, effects, and UI—directly in the editor, and play them back as a single animation in Godot. +- **Cross-Engine Visual Consistency** + Since complex state calculations are handled by an independent core runtime, structural "visual deviations" caused by Godot's unique specifications do not occur. It is guaranteed that the appearance in the editor and the playback results in other engines perfectly match. Sub-frame interpolation ensures smooth rendering even at high refresh rates. +- **Natural Integration as a Godot "Node" and Conflict Avoidance** + `SpriteStudioPlayer2D` seamlessly integrates into your Godot scenes as a standard node, allowing easy control from GDScript without bloating the Node tree. At the same time, the animation data itself is separated from the scene, preventing Git conflicts during team development. +- **Extreme Performance via Zero-copy Loading and SIMD** + By converting your data into optimized binaries (`.ssab` / FlatBuffers) for use, parsing load is reduced to zero at runtime, allowing instant playback from memory. By fully utilizing SIMD in internal calculations, it achieves maximum animation playback performance with minimal CPU and memory overhead, ensuring smooth operation even in mobile environments or games rendering massive numbers of characters. -## Documentation +## 📚 Documentation Comprehensive documentation is available in the `docs/` folder: @@ -24,7 +38,7 @@ Comprehensive documentation is available in the `docs/` folder: - [Build Guide](./docs/en/setup/build.md) - [Migration from v1.x](./docs/en/migration_from_v1.md) -## Quick Start with GDExtension +## 🚀 Quick Start with GDExtension We provide two Quick Starts: one for quickly checking the operation using a sample project, and another for setting up your own project. @@ -43,13 +57,13 @@ We provide two Quick Starts: one for quickly checking the operation using a samp For more details, see the [Installation Guide](./docs/en/setup/install.md). -## Overview +## 💡 Overview This plugin features a **powerful asset pipeline that allows you to seamlessly transition between SpriteStudio and Godot**, enabling you to update assets instantly. For the data-flow diagram, key features, supported versions, and more, see the **[Documentation (English)](./docs/en/index.md)**. -## Samples +## 🎬 Samples Sample projects based on SDK test projects are available under the [examples folder](./examples/). @@ -61,11 +75,11 @@ Sample projects based on SDK test projects are available under the [examples fol - [overall_gdextension](./examples/overall_gdextension) — Comprehensive test for GDExtension - [ParticleEffect](./examples/ParticleEffect) — Test for effect features -## Related Repositories +## 🔗 Related Repositories - [SpriteStudio-SDK](https://github.com/cri-middleware/SpriteStudio-SDK) — The SDK itself, providing `libssruntime` / `libssconverter` -## License +## 📄 License See [LICENSE.md](./LICENSE.md). diff --git a/ss_player/SpriteStudio-SDK b/ss_player/SpriteStudio-SDK index 0ef594f..e49c4b6 160000 --- a/ss_player/SpriteStudio-SDK +++ b/ss_player/SpriteStudio-SDK @@ -1 +1 @@ -Subproject commit 0ef594f330f8a554461652d2cd36f8e4d08a12ef +Subproject commit e49c4b66722f8ee24b6cd5690d214f5404b80513