From faa60f0ea1c4e0a8d00bc69828ba298c3ba5d3ff Mon Sep 17 00:00:00 2001 From: ww-rm Date: Wed, 26 Mar 2025 13:37:12 +0800 Subject: [PATCH] update readme --- README.en.md | 113 +++++++++++++++++++++++++++------------------------ README.md | 51 ++++++++++++----------- 2 files changed, 88 insertions(+), 76 deletions(-) diff --git a/README.en.md b/README.en.md index d9dc12c..6d3b36d 100644 --- a/README.en.md +++ b/README.en.md @@ -1,10 +1,14 @@ +Below is the translated English version of your README: + +--- + # [SpineViewer](https://github.com/ww-rm/SpineViewer) [![Build and Release](https://github.com/ww-rm/SpineViewer/actions/workflows/dotnet-desktop.yml/badge.svg)](https://github.com/ww-rm/SpineViewer/actions/workflows/dotnet-desktop.yml) [中文](README.md) | [English](README.en.md) -A simple and user-friendly tool for viewing and exporting Spine files. +A *WYSIWYG* Spine file viewer and exporter. ![previewer](img/preview.webp) @@ -12,81 +16,86 @@ A simple and user-friendly tool for viewing and exporting Spine files. ## Installation -Go to the [Release](https://github.com/ww-rm/SpineViewer/releases) page to download the compressed package. +Go 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). -You can also download the package with the `SelfContained` suffix, which can run independently. +You can also download the zip package with the `SelfContained` suffix, which can run independently. -## Version Support +## Supported Export Formats -| Version | View & Export | Format Conversion | Version Conversion | -| :-------: | :--------------------: | :--------------------: | :----------------: | -| `2.1.x` | :white_check_mark: | | | -| `3.1.x` | | | | -| `3.4.x` | | | | -| `3.5.x` | | | | -| `3.6.x` | :white_check_mark: | | | -| `3.7.x` | :white_check_mark: | | | -| `3.8.x` | :white_check_mark: | :white_check_mark: | | -| `4.1.x` | :white_check_mark: | | | -| `4.2.x` | :white_check_mark: | | | -| `4.3.x` | | | | +- [x] Single Frame Image +- [x] Frame Sequence +- [x] Animated GIF +- [ ] MKV +- [ ] MP4 +- [ ] MOV +- [ ] WebM + +More formats are under development :rocket::rocket::rocket: + +## Supported Spine Versions + +| Version | View & Export | Format Conversion | Version Conversion | +| :-------: | :-----------: | :---------------: | :----------------: | +| `2.1.x` | :white_check_mark: | | | +| `3.1.x` | | | | +| `3.4.x` | | | | +| `3.5.x` | | | | +| `3.6.x` | :white_check_mark: | | | +| `3.7.x` | :white_check_mark: | | | +| `3.8.x` | :white_check_mark: | :white_check_mark: | | +| `4.1.x` | :white_check_mark: | | | +| `4.2.x` | :white_check_mark: | | | +| `4.3.x` | | | | + +More versions are under development :rocket::rocket::rocket: ## Usage ### Importing Skeletons -There are 3 ways to import skeleton files: +There are three ways to import skeleton files: -- **Drag & Drop/Paste:** - Drag and drop or paste the skeleton file/directory into the model list. - This method automatically searches through the provided files and subdirectories. Although convenient, it relies on the file structure and has its limitations. - - - Only standard files with `*.json`, `*.skel`, or `.atlas` extensions are automatically detected. - - The skeleton file and atlas file must have the same name. - - The version string in the skeleton file must not be modified. - -- **Batch Open from the File Menu:** - This method offers more file flexibility. You can drag and drop or paste files into the file selection dialog, and additional options are available. - - - The filename restrictions are similar to the above, but you can use the panel’s file selection button to choose skeleton files with non-standard extensions. - - You can set a fixed load version to handle cases where the version number has been modified. - -- **Open a Single Model:** - This method offers the highest degree of freedom, allowing you to select any skeleton file and atlas file without filename restrictions. You can also set the load version. +- Drag and drop or paste the skeleton file/directory into the model list. +- Open skeleton files in batch from the File menu. +- Select a single model to open from the File menu. ### Adjusting Preview Content -The model list supports right-click menus and various shortcut keys, and you can select multiple models to adjust their parameters in bulk. +The model list supports right-click menus and several hotkeys, and multiple models can be selected for batch adjustments of model parameters. -In addition to the parameter panel, the preview area supports several mouse actions: +In addition to using the control panel for parameter settings, the preview window supports the following mouse actions: -- **Left-click:** Select and drag models. Holding down the `Ctrl` key enables multi-selection, which syncs with the model list. -- **Right-click:** Drag the overall canvas. -- **Scroll wheel:** Zoom the view. -- **Selective Rendering:** The preview area supports a mode to render only the selected models. In this mode, only the selected models are displayed, and selection changes must be made through the model list. +- 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. +- 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. -In the function menu, you can reset and synchronize the animation time for all skeletons. +The buttons below the preview window allow you to adjust the timeline, effectively serving as a simple player. ### Exporting Preview Content -Both preview images and videos can be exported. +Export follows the "What You See Is What You Get" principle—what you see in the live preview is exactly what gets exported. -- **Preview Image:** - The exported preview image shows the model in its default state, with one image per model. - -- **Video (TODO: Currently only supports frame sequence export):** - The complete animation duration for each skeleton can be viewed in the model parameters. - -When the preview area is set to render only the selected models, the exported content will include only the models that are displayed. +There are a few key parameters for exporting: -### Format & Version Conversion +- 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. -You can use the tools menu to convert skeleton files. This feature supports conversion between binary and text formats, as well as between different versions. +### More Information -Currently under development, it only supports converting `3.8.x` binary format to text format. +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). + +## Acknowledgements + +- [spine-runtimes](https://github.com/EsotericSoftware/spine-runtimes) +- [SFML.Net](https://github.com/SFML/SFML.Net) +- [FFMpegCore](https://github.com/rosenbjerg/FFMpegCore) --- -*If you like this project, please give it a :star: and share it with more people! :)* +*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) \ No newline at end of file diff --git a/README.md b/README.md index adffad6..9867299 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [中文](README.md) | [English](README.en.md) -一个简单好用的 Spine 文件查看&导出程序. +*所见即所得* 的 Spine 文件查看&导出程序. ![previewer](img/preview.webp) @@ -18,7 +18,19 @@ 也可以下载带有 `SelfContained` 后缀的压缩包, 可以独立运行. -## 版本支持 +## 导出格式支持 + +- [x] 单帧画面 +- [x] 帧序列 +- [x] GIF 动图 +- [ ] MKV +- [ ] MP4 +- [ ] MOV +- [ ] WebM + +更多格式正在施工 :rocket::rocket::rocket: + +## Spine 版本支持 | 版本 | 查看&导出 | 格式转换 | 版本转换 | | :---: | :---: | :---: | :---: | @@ -33,6 +45,8 @@ | `4.2.x` | :white_check_mark: | | | | `4.3.x` | | | | +更多版本正在施工 :rocket::rocket::rocket: + ## 使用方法 ### 骨骼导入 @@ -40,21 +54,8 @@ 有 3 种模式导入骨骼文件: - 拖放/粘贴需要导入的骨骼文件/目录到模型列表 - - 这种方式会自动查找传入的文件列表以及目录内的子级文件列表, 虽然方便但是依赖模型文件结构, 限制最多. - - - 仅支持自动发现标准的 `*.json`/`*.skel`/`.atlas` 后缀文件. - - 骨骼文件和 atlas 文件需要是同名. - - 需要保证骨骼文件里的版本字符串不是魔改过的. - 从文件菜单里批量打开骨骼文件 - - 这种方式提供一定程度的文件自由度, 文件选择框里同样支持拖放/粘贴, 但是多一些额外选项. - - - 文件名限制条件与上面类似, 但是可以通过面板的选择文件按钮选择非标准后缀的骨骼文件. - - 可以设置固定加载版本, 便于应对魔改过的版本号. -- 选择单个模型打开 - - 这种方式自由度最高, 允许选择任意的骨骼文件和 atlas 文件, 可以没有文件名限制, 并且也可以设置加载版本. +- 从文件菜单选择单个模型打开 ### 预览内容调整 @@ -65,9 +66,9 @@ - 左键可以选择和拖拽模型, 按下 `Ctrl` 键可以实现多选, 与左侧列表选择是联动的. - 右键对整体画面进行拖动. - 滚轮进行画面缩放. -- 预览画面支持仅渲染选中, 在该模式下, 画面仅显示被选中的模型, 并且只能通过左侧列表改变选中状态. +- 仅渲染选中模式, 在该模式下, 预览画面仅包含被选中的模型, 并且只能通过左侧列表改变选中状态. -在功能菜单中, 可以重置同步所有骨骼动画时间. +预览画面下方按钮支持对画面时间进行调整, 可以当作一个简易的播放器. ### 预览内容导出 @@ -79,16 +80,18 @@ - 输出文件夹. 这个参数某些时候可选, 当不提供时, 则将输出产物输出到每个模型各自的模型文件夹, 否则输出产物全部输出到提供的输出文件夹. - 导出单个. 默认是每个模型独立导出, 即对模型列表进行批量操作, 如果选择仅导出单个, 那么被导出的所有模型将在同一个画面上被渲染, 输出产物只有一份. -支持单帧画面以及不同格式的视频导出. +### 更多 -视频(TODO: 目前仅支持帧序列导出), 可以在每个骨骼的模型参数中查看动画完整时长. +更为详细的使用方法和说明见 [Wiki](https://github.com/ww-rm/SpineViewer/wiki), 有使用上的问题或者 BUG 可以提个 [Issue](https://github.com/ww-rm/SpineViewer/issues). -### 格式与版本转换 +## Acknowledgements -可以通过工具菜单进行骨骼文件转换, 允许二进制和文本格式之间的转换, 以及不同版本间的转换. - -目前处于施工中, 仅支持转换 `3.8.x` 二进制到文本格式. +- [spine-runtimes](https://github.com/EsotericSoftware/spine-runtimes) +- [SFML.Net](https://github.com/SFML/SFML.Net) +- [FFMpegCore](https://github.com/rosenbjerg/FFMpegCore) --- *如果你觉得这个项目不错请给个 :star:, 并分享给更多人知道! :)* + +[![Stargazers over time](https://starchart.cc/ww-rm/SpineViewer.svg?variant=adaptive)](https://starchart.cc/ww-rm/SpineViewer)