chizui/SpineViewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
ww-rm
2025-03-31 17:42:44 +08:00
parent 83b8411929
commit 9498e8f334
2 changed files with 59 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
README.en.md
View File

@@ -4,7 +4,7 @@
[中文](README.md) | [English](README.en.md)
A *WYSIWYG* Spine file viewer and exporter.
*A WYSIWYG Spine file viewer and exporter.*
![previewer](img/preview.webp)
@@ -12,28 +12,31 @@ A *WYSIWYG* Spine file viewer and exporter.
## Installation
Go to the [Release](https://github.com/ww-rm/SpineViewer/releases) page to download the zip package.
Head over to the [Release](https://github.com/ww-rm/SpineViewer/releases) page to download the zip package.
The software requires the dependency framework [.NET Desktop Runtime 8.0.x](https://dotnet.microsoft.com/zh-cn/download/dotnet/8.0).
The software requires the dependency framework [.NET Desktop Runtime 8.0.x](https://dotnet.microsoft.com/en-us/download/dotnet/8.0).
You can also download the zip package with the `SelfContained` suffix, which can run independently.
Alternatively, you can download the package with the `SelfContained` suffix, which can run independently.
Exporting video formats such as GIF requires that ffmpeg is installed locally and added to your system’s PATH. You can [click here to go to the FFmpeg-Windows download page](https://ffmpeg.org/download.html#build-windows) or directly download the latest version [ffmpeg-release-full.7z](https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-full.7z).
## Supported Export Formats
- [x] Single Frame Image
- [x] Frame Sequence
- [x] Animated GIF
- [ ] MKV
- [x] MP4
- [ ] MOV
- [ ] WebM
More formats are under development :rocket::rocket::rocket:
| Export Format | Suitable for Scenario |
| :------------: | :------------------------------------------------------------------------------------:|
| Single Frame | Supports generating high-definition model snapshots; you can manually adjust the frame. |
| Frame Sequence | Supports png sequence output with transparency and lossless compression. |
| GIF | Ideal for generating preview animations. |
| MP4 | The most common video format with the best compatibility. |
| WebM | Suitable for browser-based playback and supports transparent backgrounds. |
| MKV | For more experimental use. |
| MOV | For more experimental use. |
| Custom Export | In addition to the above presets, you can provide any FFmpeg parameters to meet complex custom needs. |
## Supported Spine Versions
| Version | View & Export | Format Conversion | Version Conversion |
| :-------: | :-----------: | :---------------: | :----------------: |
| :------: | :-------------------: | :------------------: | :-----------------: |
| `2.1.x` | :white_check_mark: | | |
| `3.1.x` | | | |
| `3.4.x` | | | |
@@ -47,42 +50,42 @@ More formats are under development :rocket::rocket::rocket:
More versions are under development :rocket: :rocket: :rocket:
## Usage
## How to Use
### Importing Skeletons
### Importing Skeleton Files
There are three ways to import skeleton files:
- Drag and drop or paste the skeleton file/directory into the model list.
- Open skeleton files in batch from the File menu.
- Batch open skeleton files from the File menu.
- Select a single model to open from the File menu.
### Adjusting Preview Content
### Adjusting the Preview
The model list supports right-click menus and several hotkeys, and multiple models can be selected for batch adjustments of model parameters.
The model list supports context menus and some shortcuts, and you can multi-select to adjust parameters in bulk.
In addition to using the control panel for parameter settings, the preview window supports the following mouse actions:
In addition to using the panel for parameter settings, the preview screen supports several mouse actions:
- Left-click to select and drag models. Hold the `Ctrl` key to enable multi-selection, which is synchronized with the model list on the left.
- Left-click to select and drag models; hold the `Ctrl` key for multi-selection (which is synchronized with the list on the left).
- Right-click to drag the overall view.
- Use the scroll wheel to zoom in/out.
- "Render selected only" mode, in which the preview only includes selected models and the selection can only be changed via the model list on the left.
- Use the mouse wheel to zoom in and out.
- “Render Selected” mode: in this mode, the preview screen only shows the selected models and the selection state can only be changed from the list on the left.
The buttons below the preview window allow you to adjust the timeline, effectively serving as a simple player.
The buttons below the preview allow you to adjust the timeline, acting as a simple media player.
### Exporting Preview Content
### Exporting the Preview
Export follows the "What You See Is What You Get" principle—what you see in the live preview is exactly what gets exported.
Exporting follows the “What You See Is What You Get” principle – the preview exactly reflects the output.
There are a few key parameters for exporting:
There are several key parameters for export:
- Render Selected Only: This option not only affects the preview mode but also the export; if enabled, only the selected models will be considered, and all other models will be ignored during export.
- Output Folder: This parameter is optional in some cases. If not provided, the output will be saved in each model's own directory. Otherwise, all output files will be saved to the specified folder.
- Single Export: By default, each model is exported individually in batch mode. If "Single Export" is selected, all exported models will be rendered on a single canvas, resulting in only one output file.
- Render Selected Only: This option affects both the preview and export. If enabled, only the selected models will be considered during export while ignoring the others.
- Output Folder: This parameter is optional in some cases. If not provided, the output files will be saved in each model’s own folder; otherwise, all outputs will be saved to the specified folder.
- Single Export: By default, each model is exported separately (i.e., batch operation on the model list). If “Single Export” is selected, all the exported models will be rendered on the same canvas, producing only one output file.
### More Information
For more detailed instructions and usage, please refer to the [Wiki](https://github.com/ww-rm/SpineViewer/wiki). If you encounter any issues or bugs, please open an [Issue](https://github.com/ww-rm/SpineViewer/issues).
For detailed instructions and usage notes, please see the [Wiki](https://github.com/ww-rm/SpineViewer/wiki). If you encounter any issues or bugs, feel free to open an [Issue](https://github.com/ww-rm/SpineViewer/issues).
## Acknowledgements
@@ -92,6 +95,6 @@ For more detailed instructions and usage, please refer to the [Wiki](https://git
---
*If you like this project, please give it a :star: and share it with others! :)*
*If you like this project, please give it a :star: and share it with others!*
[![Stargazers over time](https://starchart.cc/ww-rm/SpineViewer.svg?variant=adaptive)](https://starchart.cc/ww-rm/SpineViewer)

19
README.md
View File

@@ -22,15 +22,16 @@
## 导出格式支持
- [x] 单帧画面
- [x] 帧序列
- [x] GIF 动图
- [ ] MKV
- [x] MP4
- [ ] MOV
- [ ] WebM
更多格式正在施工 :rocket::rocket::rocket:
| 导出格式 | 适用场景 |
| :---: | :---: |
| 单帧画面 | 支持生成高清模型画面图像, 可手动调节需要的一帧. |
| 帧序列 | 支持 png 格式帧序列, 可保留透明通道且无损压缩. |
| GIF | 适合生成预览动图. |
| MP4 | 最常见的视频格式, 兼容性最好. |
| WebM | 适合浏览器在线播放格式, 支持透明背景. |
| MKV | 适合折腾. |
| MOV | 适合折腾. |
| 自定义导出 | 除上述预设方案, 支持提供任意 FFmpeg 参数进行导出, 满足自定义复杂需求. |
## Spine 版本支持