HJ_Client/extensions/ccc-skeleton-viewer/README.en.md
DESKTOP-15R5JU0\legu 62fef0360c init
2023-11-17 14:13:11 +08:00

129 lines
4.2 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Skeleton Viewer
## Introduction
[Cocos Creator Editor Extension]
**Used to preview skeleton animation. Provide a stand-alone panel and can also be attached to the editor window.**
*Currently, only versions 3.5~4.0 of Spine resources are supported.*
> 🎭 Attention
>
> Current branch is for **Cocos Creator 3.x**, if you're looking for **Cocos Creator 2.x** version ,please switch to branch `master`, Click [here](https://gitee.com/ifaswind/ccc-skeleton-viewer/tree/master/) to switch branch immediately.
## Open Source
This extension is an open source project, here is the git repository: [https://gitee.com/ifaswind/ccc-skeleton-viewer](https://gitee.com/ifaswind/ccc-skeleton-viewer)
If you like this project, don't forget to star [![star](https://gitee.com/ifaswind/ccc-skeleton-viewer/badge/star.svg?theme=dark)](https://gitee.com/ifaswind/ccc-skeleton-viewer/stargazers)!
*If you have any usage problems, just submit an issue or contact me with WeChat `im_chenpipi`.*
## Screenshots
![screenshot-1](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/screenshot-1.png)
![screenshot-2](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/screenshot-2.png)
![screenshot-3](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/screenshot-3.png)
![screenshot-4](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/screenshot-4.png)
![screenshot-5](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/screenshot-5.png)
![screenshot-6](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/screenshot-6.png)
![screenshot-7](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/screenshot-7.png)
![screenshot-8](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/screenshot-8.png)
![setting-panel](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/setting-panel.png)
## Environment
Platform: Windows、macOS
Engine: Cocos Creator 3.x
## Download & Installation
### Install from Cocos Store
You can find this extension in Cocos Store now, click on *Extension -> Cocos Store* option to open the Cocos Store.
Enter "**Skeleton Viewer**" in the search bar, find it and then install it.
![cocos-store](https://gitee.com/ifaswind/image-storage/raw/master/repositories/ccc-skeleton-viewer/cocos-store.png)
*Skeleton Viewer[http://store.cocos.com/app/detail/3008](http://store.cocos.com/app/detail/3008)*
### Download from git repository
Click [here](https://gitee.com/ifaswind/ccc-skeleton-viewer/releases) or go to the release panel, download the latest version package of this extension.
And then unzip the package:
- Windows: Unzip to `C:\Users\${your username}\.CocosCreator\packages\`
- macOS: Unzip to `~/.CocosCreator/packages/`
For example, on my computer, the full path of `package.json` file should be like:
- Windows: `C:\Users\Shaun\.CocosCreator\packages\ccc-skeleton-viewer\package.json`
- macOS: `/Users/shaun/.CocosCreator/packages/ccc-skeleton-viewer/package.json`
## Usage
## View
Click on *Extension -> Skeleton Viewer -> View* option to open the view panel.
*To be added...*
### Settings
Click on *Extension -> Skeleton Viewer -> Settings* option to open the setting panel.
In the setting panel, you can choose a shortcut key(for opening the view panel quickly) in preset list, or customize one by yourself.
One thing you should know, not every keys/keys-combinations can be used, because some keys/keys-combinations have been used by the system or Cocos Creator.
*Accelerator reference: [https://www.electronjs.org/docs/api/accelerator](https://www.electronjs.org/docs/api/accelerator)*
🥳 Enjoy!
## Change log
[Releases](https://gitee.com/ifaswind/ccc-skeleton-viewer/releases)
## Dependencies
- [cocos-creator](https://github.com/cocos-creator)
- [electron](https://github.com/electron/electron)
- [vue](https://github.com/vuejs/vue)
- [node-fetch](https://github.com/node-fetch/node-fetch)
- [spine-runtimes](https://github.com/EsotericSoftware/spine-runtimes)
## License
This project is licensed under the [MIT license](https://opensource.org/licenses/MIT).