Skip to content

Commit deca336

Browse files
Update README.md
1 parent bdba8ac commit deca336

1 file changed

Lines changed: 31 additions & 95 deletions

File tree

README.md

Lines changed: 31 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,9 @@ https://github.com/user-attachments/assets/3033fef6-aa30-420f-9a2a-5cb1976780e3
8686
1. From `File->Extension setting`, specify atlas and skeleton extensions.
8787
2. From `File->Open folder`, select a folder containing atlas/skel(s) with specified extensions.
8888

89-
- `Open folder` is to load all the Spine files in the directory render them at the same time.
90-
- Do not try to open folder including Spine files which cannot be managed simultaneously.
89+
- `Open folder` is to load all the Spine files in that folder and render them at the same time.
90+
- Do not try to open folder containing Spine files which cannot be managed simultaneously.
91+
- Of cource it is permitted to open folder containing only one set of Spine files.
9192

9293
<details><summary>Appropriate example</summary>
9394

@@ -123,27 +124,22 @@ spinechar20
123124

124125
- This is to load json:
125126
- which contains atlas at `[5][0][2]`, and skeleton at `[5][0][4]`.
126-
- or that which contains atlas at `[5][0][2]` and at the same time requires binary format skeleton separately.
127+
- or that which contains atlas at `[5][0][2]` and requires binary skeleton separately.
127128
- This may serve as an exmaple to load Spine from memory.
128129

129130
## Mouse functions
130131

131132
| Input | Action |
132133
| ---- | ---- |
133134
| Wheel scroll | Scale up/down. Combinating with `Ctrl` to retain window size. |
134-
| Left pressed + wheel scroll | Speed up/down the animation. |
135-
| Left click | Switch the animation. |
136-
| Left drag | Move view-point. |
137-
| Middle click | Reset scale, animation speed, and view-point to default. |
138-
| Right pressed + wheel scroll | Switch the skin. |
135+
| L-pressed + wheel scroll | Speed up/down the animation. |
136+
| L-click | Switch the animation. |
137+
| L-drag | Move view-point. |
138+
| M-click | Reset scale, animation speed, and view-point to default. |
139+
| R-pressed + wheel scroll | Switch the skin. |
140+
| R-pressed + M-click | Make window borderless. |
141+
| R-pressed + L-click | Start moving borderless window. L-click again to end. |
139142

140-
<details><summary>Tip on transparent window</summary>
141-
142-
1. Check menu item `Window->Through-seen` to make window transparent.
143-
2. `Right pressed + middle click` to make window borderless.
144-
3. `Right pressed + left click` to move borderless window.
145-
146-
</details>
147143

148144
## Keyboard functions
149145

@@ -156,54 +152,27 @@ spinechar20
156152
| <kbd>B</kbd> | Prefer/ignore blned-mode specified by slots. _Default: preferred_. |
157153
| <kbd>R</kbd> | Toggle draw-order between filename asc/descending order. _Default: ascending order_. |
158154

159-
- <kbd>Up</kbd> and <kbd>Down</kbd> key are valid only when the current spine(s) is/are loaded via `Open folder`.
160-
- Manual toggling of PMA is available for Spine version `3.8` and older.
155+
- <kbd>Up</kbd> and <kbd>Down</kbd> key are valid only when files are loaded via `Open folder`.
156+
- `PMA` toggling is permitted only for Spine version `3.8` and older.
161157
- For Spine version `4.0` and later, runtime applies pma property read from atlas file.
158+
- Disable `PMA` if it seems too bright, and enable if darkish.
159+
- Force `normal` blend mode if `multiply` is not well represented.
162160

163-
</details>
164-
<details><summary>Tip on PMA and blend mode</summary>
165-
166-
- Disable `PMA` with <kbd>A</kbd> if it is too bright, and enable if darkish.
167-
- Force `normal` blend mode with <kbd>B</kbd> if `multiply` is not well represented.
168-
169-
</details>
170161

171162
## Context menu functions
172163

173-
- Context menu appears only when file is loaded.
174-
175-
### Export as single image
176-
177-
1. Right click on the window.
178-
2. Select `Snap as PNG` or `Snap as JPG`.
179-
180-
### Export as animation
181-
182-
1. Right click on the window.
183-
2. Select `Export as GIF` or `Export as H264`.
184-
185-
More flexible recording is available by unchecking `Export per anim.` option from `Image->Export setting`.
186-
187-
<details><summary>Note on flexible recording</summary>
188-
189-
| State | Behaviour |
164+
| Menu item | Action |
190165
| ---- | ---- |
191-
| `Export per anim.` checked | Restarts the animation once recording has started, and ends recording as soon as animation has ended. |
192-
| `Export per anim.` unchecked | Recording start and end timing can be choosen by user hand. |
193-
194-
#### Export as multiple images
166+
| Snap as PNG | Save the current screen as `PNG`. |
167+
| Snap as JPG | Save the current screen as `JPG`. |
168+
| Export as GIF | Restart the current animation and export as `GIF`. |
169+
| Export as H264 | Restart the current animation and export as `MP4`. |
195170

196-
1. Right click on the window.
197-
2. Select `Start image recording`.
198-
3. Right click again and select `Save as GIF` or `Save as PNGs`.
199-
200-
#### Export as video
201-
202-
1. Right click on the window.
203-
2. Select `Start video recording`.
204-
3. Right click again and select `End recording`.
205-
206-
</details>
171+
- Context menu appears only when Spine is loaded.
172+
- By unchecking `Export per anim.` option from `Tool->Export setting`, export behaviour changes as follows:
173+
- The start and end timing of recording is delegated to user.
174+
- It is allowed to zoom or switch animation while recording.
175+
- It is allowed to export as multiple PNGs.
207176

208177
<details><summary>Note on filename</summary>
209178

@@ -214,7 +183,7 @@ More flexible recording is available by unchecking `Export per anim.` option fro
214183
- `H264` file will be named like `fp.mp4` where `fp` is animation name.
215184

216185
</details>
217-
186+
218187
## External libraries
219188

220189
- [DxLib](https://dxlib.xsrv.jp/)
@@ -228,48 +197,15 @@ Visual Studio is required.
228197
- Command prompt will start up.
229198
3. Type `start devenv .` in the command prompt.
230199
- `Visual Studio` will start up and configure CMake.
231-
4. Wait for the CMake configuration to be finished.
232-
5. Configuration having done, open `DxLibSpineViewer.sln` with Visual Studio.
200+
4. Wait for the CMake configuration to be done.
201+
5. Open `DxLibSpineViewer.sln`.
233202
6. Select `Build Solution` on menu item.
234-
7. Build having succeeded, delete `out` and `.vs` folders in `shared-src/deps`.
203+
- Build having succeeded, delete `out` and `.vs` folders in `shared-src/deps`.
235204

236205
The `CMakeLists.txt` modifies some of the external sources as well as obtains them.
237206
- For spine-c `3.5`, renames some of the functions which lack `sp` prefix in `extension.c` and `extension.h` so as to be consistent with those of `3.6` and later.
238207
- For spine-c `2.1`, supplies binary skeleton reader which is lacking in official `2.1.25` runtime, and overwrites some of the files with those from [here](https://github.com/BithreenGirlen/spine-c-2.1.27).
239208

240-
<details><summary>deps directory will be as follows:</summary>
241-
242-
<pre>
243-
...
244-
├ DxLibSpineC
245-
│ └ ...
246-
├ DxLibSpineCpp
247-
│ └ ...
248-
├ projects
249-
│ └ ...
250-
├ shared-src
251-
│ ├ deps
252-
│ │ ├ dxlib // static libraries and headers of DxLib for VC
253-
│ │ │ └ ...
254-
│ │ ├ spine-c-x.x // Spine C generic runtime for version x.x
255-
│ │ │ ├ include
256-
│ │ │ │ └ ...
257-
│ │ │ └ src
258-
│ │ │ └ ...
259-
│ │ ├ ...
260-
│ │ ├ spine-cpp-x.x // Spine C++ generic runtime for version x.x
261-
│ │ │ ├ include
262-
│ │ │ │ └ ...
263-
│ │ │ └ src
264-
│ │ │ └ ...
265-
│ │ └ ...
266-
│ └ ...
267-
├ DxLibSpineViewer.sln
268-
└ ...
269-
</pre>
270-
271-
</details>
272-
273209
## Spine runtime for DxLib
274210

275211
- For minimal integration, only `dxlib_spine.cpp/h` or `dxlib_spine_c.cpp` are suffice.
@@ -282,7 +218,7 @@ The `CMakeLists.txt` modifies some of the external sources as well as obtains th
282218

283219
| File | Functionality |
284220
| --- | --- |
285-
| dxlib_spine.cpp/h | Load texture and render skeleton based on DxLib's API |
286-
| dxlib_spine_player.cpp/h | Adjust Spine scaling and translation based on DxLib's matrices. |
221+
| dxlib_spine.cpp/h | Load texture and render skeleton based on API of DxLib. |
222+
| dxlib_spine_player.cpp/h | Adjust scale and translation using matrix of DxLib. |
287223
| spine_loader.cpp/h | Load atlas or skeleton file. |
288224
| spine_player.cpp/h | Manage Spine resources and manipulation. |

0 commit comments

Comments
 (0)