From cf7588c288f3d5dfd4c34f7cf6d933f679637456 Mon Sep 17 00:00:00 2001 From: ww-rm Date: Mon, 24 Mar 2025 14:41:25 +0800 Subject: [PATCH] update readme --- README.en.md | 90 ++++++++++++++++++++++++++++++++-------------------- README.md | 86 +++++++++++++++++++++++++++---------------------- 2 files changed, 104 insertions(+), 72 deletions(-) diff --git a/README.en.md b/README.en.md index 7b623b7..d9dc12c 100644 --- a/README.en.md +++ b/README.en.md @@ -4,7 +4,7 @@ [中文](README.md) | [English](README.en.md) -A simple and user-friendly Spine file viewer and exporter. +A simple and user-friendly tool for viewing and exporting Spine files. ![previewer](img/preview.webp) @@ -12,59 +12,81 @@ A simple and user-friendly Spine file viewer and exporter. ## Installation -Download the zip package from the [Releases](https://github.com/ww-rm/SpineViewer/releases) page. +Go to the [Release](https://github.com/ww-rm/SpineViewer/releases) page to download the compressed package. -The application requires the [.NET Desktop Runtime 8.0.x](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). +The software requires the dependency framework [.NET Desktop Runtime 8.0.x](https://dotnet.microsoft.com/zh-cn/download/dotnet/8.0). -Alternatively, you can download the zip package with the `SelfContained` suffix, which can run independently. +You can also download the package with the `SelfContained` suffix, which can run independently. -## Features +## Version Support -- Supports viewing Spine files of different versions: - - [x] `v2.1.x` - - [x] `v3.6.x` - - [x] `v3.7.x` - - [x] `v3.8.x` - - [x] `v4.0.x` - - [x] `v4.1.x` - - [x] `v4.2.x` - - [ ] `v4.3.x` -- Supports animation preview for multi-skeleton files -- Allows independent parameter settings for each skeleton -- Supports exporting animation as PNG frame sequences -- Provides export settings such as zoom and rotation -- More features coming soon... +| 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` | | | | ## Usage ### Importing Skeletons -Use the **File** menu to select **Open** or **Batch Open** to import skeleton files. +There are 3 ways to import skeleton files: -### Adjusting Skeletons +- **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. -Select one or more items in the **Model List** to display adjustable parameters in the **Model Parameters** panel. +- **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. -Right-clicking in the **Model List** allows you to add, delete, or adjust list items. You can also drag items with the left mouse button to rearrange them. +- **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. -### Adjusting the View +### Adjusting Preview Content -Mouse operations supported in the **Preview** window: +The model list supports right-click menus and various shortcut keys, and you can select multiple models to adjust their parameters in bulk. -- Left-click to drag the skeleton -- Right-click to drag the view -- Scroll wheel to zoom in/out +In addition to the parameter panel, the preview area supports several mouse actions: -Additionally, you can adjust export and preview parameters through the **View Parameters** panel. +- **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. -In the **Functions** menu, you can reset and synchronize the animation time for all skeletons. +In the function menu, you can reset and synchronize the animation time for all skeletons. -### Exporting Animations +### Exporting Preview Content -Select **Export** from the **File** menu to export all loaded skeleton animations as PNG frame sequences, based on the current preview settings. +Both preview images and videos can be exported. -You can view the full duration of each animation in the **Model Parameters** of each skeleton. +- **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. + +### Format & Version Conversion + +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. + +Currently under development, it only supports converting `3.8.x` binary format to text format. --- -*If you find this project helpful, please give it a :star: and share it with others! :)* +*If you like this project, please give it a :star: and share it with more people! :)* diff --git a/README.md b/README.md index 45c69bc..e0b9e16 100644 --- a/README.md +++ b/README.md @@ -18,62 +18,72 @@ 也可以下载带有 `SelfContained` 后缀的压缩包, 可以独立运行. -## 功能支持 +## 版本支持 -| 版本 | 查看&导出 | 格式转换 | -| :---: | :---: | :---: | -| `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` | | | - -- 支持文件拖放/复制到剪贴板打开 -- 支持自动检测版本 -- 支持列表缩略图预览 -- 支持多骨骼文件动画预览 -- 支持每个骨骼独立参数设置 -- 支持动画PNG帧序列导出 -- 支持缩放旋转等导出画面设置 -- 支持对独立的骨骼文件进行格式转换 -- Coming soon... +| 版本 | 查看&导出 | 格式转换 | 版本转换 | +| :---: | :---: | :---: | :---: | +| `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` | | | | ## 使用方法 ### 骨骼导入 -**文件**菜单可以选择**打开**或者**批量打开**进行骨骼文件导入. +有 3 种模式导入骨骼文件: -或者直接把要打开的骨骼文件拖进列表, 这种方式只支持 `.json` 和 `.skel` 后缀的文件, 其他的会被忽略. +- 拖放/粘贴需要导入的骨骼文件/目录到模型列表 -### 骨骼调整 + 这种方式会自动查找传入的文件列表以及目录内的子级文件列表, 虽然方便但是依赖模型文件结构, 限制最多. -在**模型列表**中选择一项或多项, 将会在**模型参数**面板显示可供调节的参数. + - 仅支持自动发现标准的 `*.json`/`*.skel`/`.atlas` 后缀文件. + - 骨骼文件和 atlas 文件需要是同名. + - 需要保证骨骼文件里的版本字符串不是魔改过的. +- 从文件菜单里批量打开骨骼文件 -**模型列表**右键菜单可以对列表项进行增删调整, 也可以使用鼠标左键拖动调整顺序. + 这种方式提供一定程度的文件自由度, 文件选择框里同样支持拖放/粘贴, 但是多一些额外选项. -### 画面调整 + - 文件名限制条件与上面类似, 但是可以通过面板的选择文件按钮选择非标准后缀的骨骼文件. + - 可以设置固定加载版本, 便于应对魔改过的版本号. +- 选择单个模型打开 -**预览画面**支持的鼠标操作: + 这种方式自由度最高, 允许选择任意的骨骼文件和 atlas 文件, 可以没有文件名限制, 并且也可以设置加载版本. -- 左键可以对骨骼进行拖动 -- 右键对画面进行拖动 -- 滚轮进行画面缩放 +### 预览内容调整 -除此之外, 也可以通过**画面参数**面板调节导出和预览时的画面参数. +模型列表支持右键菜单以及部分快捷键, 并且可以多选进行模型参数的批量调整. -在**功能**菜单中, 可以重置同步所有骨骼动画时间. +预览画面除了使用面板进行参数设置外, 支持部分鼠标动作: -### 动画导出 +- 左键可以选择和拖拽模型, 按下 `Ctrl` 键可以实现多选, 与左侧列表选择是联动的. +- 右键对整体画面进行拖动. +- 滚轮进行画面缩放. +- 预览画面支持仅渲染选中, 在该模式下, 画面仅显示被选中的模型, 并且只能通过左侧列表改变选中状态. -**文件**菜单中选择**导出**可以将目前加载的所有骨骼动画按照预览时的画面进行PNG帧序列导出. +在功能菜单中, 可以重置同步所有骨骼动画时间. -可以在每个骨骼的**模型参数**中查看动画完整时长. +### 预览内容导出 + +支持预览图和视频的导出. + +预览图导出的内容是模型的默认状态画面, 每个模型一张单独的预览图. + +视频(TODO: 目前仅支持帧序列导出), 可以在每个骨骼的模型参数中查看动画完整时长. + +当预览画面处于仅渲染选中状态时, 导出的内容仅包含被选中的模型, 也就是在画面中显示的内容. + +### 格式与版本转换 + +可以通过工具菜单进行骨骼文件换, 允许二进制和文本格式之间的转换, 以及不同版本间的转换. + +目前处于施工中, 仅支持转换 `3.8.x` 二进制到文本格式. ---