Skip to content

Commit baef443

Browse files
committed
Update README
Update "Help" text
1 parent fa667f3 commit baef443

File tree

2 files changed

+54
-9
lines changed

2 files changed

+54
-9
lines changed

README.md

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,27 +17,60 @@ Arne's original bend code was used as base and has been modified and improved to
1717
- GUI
1818
- Loading/saving files.
1919
- Adjusting joint position.
20-
- Zoom setting for easy joint adjustment.
20+
- Zoom setting on input image for easy joint adjustment.
2121
- Frames number output setting.
2222
- Background color setting.
2323
- Automatic setting of background color to magenta on save.
24-
- Saving as PNG or Indexed BMP (CC Palette)
24+
- Saving as PNG or Indexed BMP (CC Palette).
25+
- Saving as individual named frames.
2526

2627
## How To
2728

2829
1. Create an input file using the provided template.
29-
2. Load your file in the app.
30+
- **Warning:** The order of limb parts in the input file **is important!**
31+
- Order should be as specified, going left to right:
32+
Upper Arm FG, Lower Arm FG, Upper Arm BG, Lower Arm BG, Upper Leg FG, Lower Leg FG, Upper Leg BG, Lower Leg BG.
33+
- **Double Warning:**
34+
- Arm parts should be facing **right** for correct bending!
35+
- Leg parts should be facing **left** for correct bending!
36+
37+
- See included "test-image.bmp" to understand how your input file should look like.
38+
39+
2. Load your input file using the "**Load**" button.
40+
3041
3. Bent limbs will auto generate with default settings.
42+
3143
4. Adjust joint positions by clicking on the upper joint marker and dragging it around.
32-
- Use **Zoom** setting to enlarge the input image for easier joint adjustment
44+
- ~~Use **Zoom** setting to enlarge the input image for easier joint adjustment~~
45+
- Input image will be automatically zoomed to x4 on first load.
3346
- **Warning:** When zooming the joint markers will reset to original positions. First zoom, then adjust.
47+
3448
5. Use **Frames** setting to set number of bend frames.
3549
- Bend angle will adjust automatically. First/Last frames will always be fully bent/unbent.
50+
3651
6. Decide whether you want to save as Indexed BMP or not - if yes, tick the "**Save as Indexed Bitmap**" checkbox.
37-
7. Hit save
38-
- Background color will automatically be set to magenta (255,0,255) when save is clicked and will revert back to previous color when finished.
39-
8. Slice the saved image into frames and apply palette.
40-
- Manually touch-up the exported frames if needed.
52+
53+
7. Decide whether you want to save as individual named frames or not - if yes, tick the "**Save as Frames**" checkbox.
54+
- Exported frame size is fixed to 24x24px.
55+
- If enabled, a visual aid will be shown around each frame to help the user stay within bounds.
56+
- Pixels outside bounds will be cropped.
57+
- Exported leg frames will be automatically flipped horizontally to face right.
58+
59+
**Note:** "Save as Indexed Bitmap" and "Save as Frames" do not conflict and can be used together to export indexed individual frames.
60+
61+
8. Hit save
62+
- Background color will automatically be set to magenta (255,0,255) when save is clicked and will revert back to previous color when finished.
63+
64+
- **Warning:**
65+
- File extension will be added automatically depending on selected "**Save as Indexed Bitmap**" setting so there is no need to add it manually.
66+
Doing so will resolve in a double extension (for example: "MyFile.png.png").
67+
68+
- **Quadruple Warning:**
69+
70+
- When saving with "**Save as Frames**" enabled, only input the name of the actor these limbs belong to (for example: "Robot").
71+
Limb names and frame numbers will be added automatically.
72+
**Adding the limb name and frame number manually will result in horrible exported file names.**
73+
4174

4275
## Current Issues
4376

assets/help-textbox-content

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,16 @@ When not ticked, output will be saved as a non-indexed PNG.
6363
THE INDEXING PROCESS IS SLOW!
6464
I've done my best to speed it up but it still isn't blazing fast like PNG saving.
6565
When saving indexed, the app may hang and appear unresponsive but in fact it's doing what it's supposed to.
66-
For best results, DO NOT TOUCH ANYTHING until the background color reverts from magenta to whatever it was before!
66+
For best results, DO NOT TOUCH ANYTHING until the background color reverts from magenta to whatever it was before!
67+
68+
69+
SAVE AS FRAMES:
70+
When ticked each frame of the output will be exported as an individual file.
71+
Exported frame size is fixed to 24x24px. A bounding box will be shown around each frame to help user stay within bounds.
72+
Anything outside bounds will be cropped.
73+
74+
Does not conflict with "SAVE AS INDEXED BITMAP" and can be used together to export indexed individual frames.
75+
76+
- Quadruple Warning :
77+
WHEN SAVING, DO NOT MANUALLY ADD LIMB NAME OR FRAME NUMBER TO FILE NAME. THIS IS DONE AUTOMATICALLY.
78+
DOING SO WILL RESULT IS HORRIBLE HORRIBLE EXPORTED FILE NAMES.

0 commit comments

Comments
 (0)