diff --git a/Documentation/Controls.md b/Documentation/Controls.md new file mode 100644 index 0000000..319fb1d --- /dev/null +++ b/Documentation/Controls.md @@ -0,0 +1,78 @@ + +# Controls + +
+ +## Lock  /  Unlock + +Toggles the popup window being locked in place. + +*Allows you to draw through it.* + +
+
+ +## Show  /  Hide + +Toggles the visibility of the popup window. + +
+
+ +## Paste  /  Clear  (  Background  ) + +Takes the image data off of your clipboard
+and makes it the background of the popup. + +Useful if you want to just screenshot / snip
+your sketch's head and position the model
+as a posed reference. + +
+
+ +## Base  /  Custom  (  Model  ) + +Toggle between the fused shadow and
+a custom  `.obj`  file of your choosing. + +
+
+ +## Back  /  Noback + +Toggles the visibility of the back of the model. + +*This is used to avoid having your view blocked by*
+*the back of Midna's model while drawing her face.* + +
+
+ +## Base  /  Line  /  Custom  (  Texture  ) + +Toggles between the following types: + +- Base fused shadow texture + +- Quick line guide + +- Custom texture + +
+
+ +## Save Screenshot + +Takes a screenshot of the popup window,
+including any custom pasted background. + +
+
+ +## Help Please + +Displays a quick rundown of what
+the app does in a popup window. + +
\ No newline at end of file diff --git a/Documentation/Workflow.md b/Documentation/Workflow.md new file mode 100644 index 0000000..b780ec0 --- /dev/null +++ b/Documentation/Workflow.md @@ -0,0 +1,65 @@ + +# Workflow + +
+ +## Models + +The program automatically loads
+content from the models folder: + +`/Models` + +
+ +*In case you want to permanently change your setup to draw
+a different character, you just have to swap out those files.* + +
+
+ +## Saving + +**There's no save functionality.** + +*Unless I need it or a lot of people request it,*
+*I won't sink time into developing the feature.* + +
+
+ +## Positioning + +
+ +1. Place the popup window over your sketch + +
+ +2. Tweak your models: + + - Translation + +   Hold MouseWheel   + + - Rotation + +   Hold RightClick   + + - Size + +   Use MouseWheel   + +
+ + **Slider Range**  **⟷**  `360°` + +
+ +## Recommended + +As the translation slider adjusts the model in 3D space,
+it might mess up your rotation point, so it may be better
+to simply move the popup window itself. + +
\ No newline at end of file diff --git a/README.md b/README.md index c29dbed..c4efb25 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,61 @@ -# MidnaHelmetHelperWPF -Download release: https://github.com/NotBoogie/MidnaHelmetHelperWPF/releases/tag/1 +
-The app auto loads the content in the /Models folder. If you draw something else that isn't Midna a lot, you can probably just swap out those files for yours. There's no save functionality cause I'm not gonna sink time into that (until either I need it or it gets a lot of asks from people I guess) +# Midna Helmet
Helper WPF -Control definitions: +*Tool to streamline the imp ass drawing*
+*process, while avoiding fused shadows.* --LOCK/UNLOCK: Locks the popup window to allow you to draw through it +
+
--SHOW/HIDE: Displays the popup window +[![Button Trailer]][Trailer]    +[![Button Download]][Download] --PASTE/CLEAR BG: Takes the image data off of your clipboard and makes it the background of the popup. Useful if you want to just screenshot/snip your sketch's head and position the model as a posed reference +[![Button Workflow]][Workflow]    +[![Button Controls]][Controls] --BASE/CUSTOM (Model): Toggle between the fused shadow and a custom .obj file of your choosing +
+
--BACK/NOBACK: will show/hide the backs of polygons in the viewer. This is so that when you have the model posed over Midna's face, the back part isn't blocking your sketch + + +
--BASE/LINE/CUSTOM (Texture): Toggle between the base fused shadow texture, a quick line guide version I made, and your own file +
+
--SAVE SCREENSHOT: Saves a screenshot of the popup window, including any custom pasted background +## Todo --HELP PLS: Shows a quick rundown of what the app does in a popup window +
+- Applying custom textures will always align to
+ the upper left coordinates, haven't figured out
+ how to get around this yet. -Basic use: -Position the popup window over your sketch, tweak the model as desired (right click to rotate, mousewheel to zoom in/out, mousewheel click to move the model - note that this affects the actual position of the model in 3d space, so it will mess up your right-click rotation point. I'd recommend just moving the actual window). The sliders in the main window can be used to get those exact tweaks and each one is a 360 degree turn. +
-TODO: Applying custom textures will always align to the upper left coordinates, haven't figured out how to get around this yet -TODO: Figure out a non-shit way to control model position for people with smaller screens +- Figure out a non-shit way to control model
+ position for people with smaller screens. + +
+ + + + +[Download]: https://github.com/NotBoogie/MidnaHelmetHelperWPF/releases +[Trailer]: https://twitter.com/i/status/1450492184965181441 + +[Controls]: Documentation/Controls.md +[Workflow]: Documentation/Workflow.md + + + + +[Button Workflow]: https://img.shields.io/badge/Workflow-4479A1?style=for-the-badge&logoColor=white&logo=MLflow +[Button Controls]: https://img.shields.io/badge/Controls-00B388?style=for-the-badge&logoColor=white&logo=AppleArcade +[Button Download]: https://img.shields.io/badge/Download-0194E2?style=for-the-badge&logoColor=white&logo=DocuSign +[Button Trailer]: https://img.shields.io/badge/Trailer-B5314C?style=for-the-badge&logoColor=white&logo=YouTube diff --git a/Resources/Preview.png b/Resources/Preview.png new file mode 100644 index 0000000..773801b Binary files /dev/null and b/Resources/Preview.png differ