diff --git a/Images/Demo.webp b/Images/Demo.webp new file mode 100644 index 0000000..04d9d84 Binary files /dev/null and b/Images/Demo.webp differ diff --git a/Images/DisplayImage.PNG b/Images/DisplayImage.PNG index 204e4d6..011b2bd 100644 Binary files a/Images/DisplayImage.PNG and b/Images/DisplayImage.PNG differ diff --git a/README.md b/README.md index f64de29..d37df15 100644 --- a/README.md +++ b/README.md @@ -5,33 +5,38 @@ DMC Image Converter is a tool used to create cross stitch patterns from images. --- ![Converter Screenshot](./Images/DisplayImage.PNG) ### Current Features -- Load an image and have it converted into a pattern for cross stitching with DMC floss. +- Save and load converted images. - Automatic selection of best DMC threads to use, as well as user specified. -- Resize a loaded image to a set width. -- Display grid showing DMC values, representing the converted pixels of the loaded image. -- Grid Marking to track your stitching progress. -- Select between different colour matching algorithms. Each gives a slightly different result. With the closeest current algorithm being [CIE2000](https://en.wikipedia.org/wiki/Color_difference#CIELAB_%CE%94E*). Although the closest mathematically, you may want to play around with what the other versions produce. +- Image resizing +- Display grid showing DMC values (representing the converted pixels of the loaded image). +- Grid Marking to track stitching progress. +- Different colour matching algorithms. Each gives a slightly different result. With the closeest current algorithm being [CIE2000](https://en.wikipedia.org/wiki/Color_difference#CIELAB_%CE%94E*). Although the closest mathematically, you may want to play around with what the other versions produce. - [Dithering](https://en.wikipedia.org/wiki/Dither) (reduces colour banding caused by a reduced colour palette) - Basic PDF export (still in development) -- Save and load a conversion, along with marked stitches. +- Save and load previous conversions and stitch markers. +--- +### How To Use +![](./Images/Demo.webp) +- Load an image into the program by clicking the "Load Image" button. +- Controll the size of your cross stich pattern by setting the width, with the "Width" controll box. +- Select from the list of DMC values which colours you would like to use with your pattern. +- Or, select how many different threads you would like to use and the program will find the best suitable DMC colours. +- Check the dithering box if you would like the image to be dithered. +- Setting the value next to the dithering check box controlls how much dithering you want to be applied (1.0 is standard) +- Pressing the "Convert" button will start the image conversion and will result in the pattern being displayed on a large grid. +- You can right click any grid cell to mark it red when you have stitched it. +- Right clicking a second time will unmark a grid cell. +- The save button will save any current conversion +- The load button will allow you to load a converion (The name of saves default to the converted iamge's name) +- Progress is saved automatically if grid cells are marked. +- Re-launching the program and clicking "Load Last" will open the last session. --- ### Currently Working On -- Auto Save -- Load/save feature. Allowing the user to make a conversion, save it, and then re-load it the next time the launch the program. Without having to convert it again. +- PDF export - Ability to draw your own pattern, or edit a conversion, using any DMC colour the user wants to (paint). - Figuring out the best way to save the conversion to either an image or pdf, for use away from the program. - Re-arranging the ui and improving the overall look. --- -### How To Use -- Load an image into the application by clicking the Load Image button. -- Controll the size of your cross stich pattern by setting the width, with the width controll box. -- Select from the list of DMC values, which floss' you would like to use with your pattern. -- Or, select how many different threads you would like to use and the program will find the best suitable DMC colours. -- Check the dithering box if you would like the image to be dithered. Setting the value next to the check box controlls how much dithering you want to be applied (1.0 is standard) -- Pressing the convert button will start the image conversion and will result in the pattern being displayed on a large grid. -- You can right click any grid cell to mark it red when you have stitched it (currently can't unmark). -- Using the Save and Load buttons, you can save a pattern for loading if you need to close the program. ---- ### About colour matching The auto match colour feature gives the ability to generate a palette of DMC thread colours using the colours that make up the original image. @@ -39,7 +44,7 @@ When using this you must trial different values of "colour uniqueness". This val This was implemented upon realising that the first implementation only selected the top x amount of common colours. Which was an issue, as it severely reduced how varied the shades of colours in the palette were. For example, if converting an image of a large green field with a small amout of red flowers. The auto matched colours would include mostly greens, as this is the shade of colour that dominates the image. The palette would likely not have a shade of red, and the flowers would match to the closest possible colour (probably a shade of green). -The following figures show how the colour uniqueness of the auto matched thread colours effects the outcome of a conversion. +The following figures show how the colour uniqueness of the auto matched colours effect the outcome of a conversion. 
Uniqueness of 1                                                 Uniqueness of 5
@@ -56,13 +61,10 @@ You also have to be cautious of setting the value too high. As doing so can resu --- ### Features I Would Like To Add -- MultiThreading. Currently the program 'freezes' when a converion is taking place. -- Save and load previous conversions. As well as saving and loading of marked grid cells, to keep a users stitching progress. - Bigger floss selection. Such as brands of floss other than DMC. - Ability to see what the floss colours look like next to the selection panel. - Track how long a user has been stitching a pattern, and estimate a completion date. - Display what coloured floss is actually in the converted image, as the entire palette may not be used. Just because a colour has been selected, certain colours may never be matched to pixels in the users image. - Track each colour floss and the amount required. With a display showing how many stitches of that colour are left to stitch in the image. -- Ability to save a converted iamage pattern to pdf in order to print it out. -- Update button that links to this project's repo, so users can get the latest version. (Could store version number in code and check against current release version number. Then alert if users exe is not the latest) +- Update button that links to this project's repo, so users can get the latest version. - Option to paint your own pattern using a palette selector and drawing(clicking) directly on the grid.