update

Home.md

@@ -1 +1,92 @@
-Welcome to the SpineViewer wiki!
+# [SpineViewer](https://github.com/ww-rm/SpineViewer)
+
+## 骨骼导入
+
+有 3 种模式导入骨骼文件.
+
+### 拖放/粘贴需要导入的骨骼文件/目录到模型列表
+
+这种方式会自动查找传入的文件列表以及目录内的子级文件列表, 虽然方便但是依赖模型文件结构, 限制最多.
+
+- 骨骼文件需要和 atlas 文件在一起.
+- 仅支持自动发现标准的 `*.json`/`*.skel`/`.atlas` 后缀文件.
+- 骨骼文件和 atlas 文件需要是同名.
+- 需要保证骨骼文件里的版本字符串不是魔改过的.
+
+如果你有大量的标准后缀名的模型文件, 并且骨骼文件内部也是官方标准格式, 例如没有魔改二进制结构, 或者魔改版本字符串, 请用该模式导入, 最省事, CV 一下就能全部导进去.
+
+### 从文件菜单里批量打开骨骼文件
+
+这种方式提供一定程度的文件自由度, 文件选择框里同样支持拖放/粘贴, 但是多一些额外选项.
+
+- 文件名限制条件与上面类似, 但是可以通过面板的选择文件按钮选择非标准后缀的骨骼文件.
+- 可以设置固定加载版本, 便于应对魔改过的版本号.
+
+如果你需要批量导入, 但是版本字符串被魔改过, 则可以用这种方式指定版本字符串; 或者你的骨骼文件不是标准的 `*.json/*.skel`, 但是 atlas 文件是标准的 `*.atlas`, 也可以用这种方式导入.
+
+### 选择单个模型打开
+
+这种方式自由度最高, 允许选择任意的骨骼文件和 atlas 文件, 可以没有文件名限制, 并且也可以设置加载版本.
+
+如果你只是想简单查看一下某个没有规范文件名的单个骨骼, 则可以用这种方式手动选骨骼文件和 atlas 文件.
+
+### 注意事项
+
+无论哪一种导入方式, png 文件都必须和 atlas 文件在一起 (同个目录下), 并且 png 文件名必须和 atlas 文件里的文件名一致, 否则无法加载.
+
+## 模型列表
+
+无论是预览还是导出, 都与模型列表的顺序有关, 因此提供了右键菜单和部分快捷键可以帮助调整模型在列表里的位置, 同时也可以很方便的对模型列表进行管理.
+
+预览画面和导出时的渲染顺序按照列表的逆序进行, 也就是越靠前的模型最后渲染, 也就是处于渲染的最上层.
+
+除此之外, 提供复制简单预览图的功能, 预览图是模型初始状态的画面.
+
+还可以切换模型列表的视图, 查看不同尺寸列表项.
+
+## 预览内容调整
+
+预览画面除了使用面板进行参数设置外, 支持部分鼠标动作:
+
+- 左键可以选择和拖拽模型, 按下 `Ctrl` 键可以实现多选, 与左侧列表选择是联动的.
+- 右键对整体画面进行拖动.
+- 滚轮进行画面缩放.
+- 预览画面支持仅渲染选中, 在该模式下, 画面仅显示被选中的模型, 并且只能通过左侧列表改变选中状态.
+
+预览画面的内容完全就是导出时的内容, *所见即所得*.
+
+当然, 不包括骨骼的调试内容和坐标轴之类的纯预览内容. :D
+
+## 预览内容导出
+
+导出遵循 *所见即所得* 原则, 即实时预览的画面就是你导出的画面.
+
+导出有以下几个关键参数:
+
+- 仅渲染选中. 这个参数不仅影响预览模式, 也影响导出, 如果仅渲染选中, 那么在导出时只有被选中的模型会被考虑, 忽略其他模型.
+- 输出文件夹. 这个参数某些时候可选, 当不提供时, 则将输出产物输出到每个模型各自的模型文件夹, 否则输出产物全部输出到提供的输出文件夹.
+- 导出单个. 默认是每个模型独立导出, 即对模型列表进行批量操作, 如果选择仅导出单个, 那么被导出的所有模型将在同一个画面上被渲染, 输出产物只有一份.
+
+支持单帧画面以及不同格式的动图或者视频导出, 部分格式还在施工中.
+
+导出单帧画面时, 建议先将预览画面暂停在某一帧, 这样可以导出固定的一帧画面.
+
+在导出帧序列以及动图视频类型时, 如果导出时长小于 0, 则按各自的动画时长进行导出, 否则按填写的值导出统一的时长, 至少会导出一帧.
+
+### 批量导出单个模型
+
+如果你需要批量对列表内模型进行导出, 那么仅渲染选中应当为 `False`, 同时在导出时导出单个也是 `False`, 这样每个模型的产物都是独立的, 各自在画面中进行渲染.
+
+输出文件夹是可选项, 如果你需要把所有模型的输出产物集中到一起, 就填有效的输出目录; 如果你需要将输出产物导出到模型各自的文件夹里, 就留空, 比如给每个模型生成一个单帧预览图.
+
+### 导出合并模型
+
+如果你的某些模型是由多个骨骼组合而成 (例如某舰B一个船有7个独立的骨骼), 那么在导出时, 请勾选导出单个, 这样会把需要导出的骨骼在同一个画面上渲染导出.
+
+你也可以在这个基础上, 勾选仅渲染选中, 这样当你的列表里有多个骨骼组的时候, 可以选择某一组进行合并导出.
+
+## 格式与版本转换
+
+可以通过工具菜单进行骨骼文件转换, 允许二进制和文本格式之间的转换, 以及不同版本间的转换.
+
+目前处于施工中, 仅支持转换 `3.8.x` 二进制到文本格式.