Skip to content
starturtle edited this page Sep 26, 2020 · 1 revision

Installation

The stixelator uses CMake. Usually, just downloading the source code and trying to generate project files for this should be enough. The program is tested for use with MSVC.

Dependencies

  • OpenCV for shell mode
  • Qt5 for GUI mode
  • optional: CEGUI for a currently not implemented alternative UI. Note that CMake will warn you about this, but the project will build nonetheless if all other requirements are met.

MSVC Build

The startup project to build with MSVC must be one-bit. Note that it's CMake that generates the moc files for the QML components, so if you pull new versions with new QML files, be sure to re-run CMake.

Shell Mode

TODO

UI Mode

The default for the binary is to startup in GUI mode and run a Qt window in dark mode.

Input Files

You can choose PNG and JPEG files from your PC. The output may be scaled down significantly.

Workpiece and Yarn Properties

Usually, the desired result size is well known. Therefore, the program requires desired resulting workpiece width and height in cm. The core defining parameter for knitting workpieces is the yarn. Therefore, you may choose from 2-4 colors (choose those that come closest to your yarn) you wish to use for your workpiece. Each combination of knitter and yarn results in a very individual gauge. For the best estimates possible, please do a 10cm by 10cm test piece to determine your gauge with the desired yarn, and enter the numbers of rows and stitches per row that this test workpiece has into the text input fields.

Helper

In particular when you have rather solid areas of one color in your pattern, or if you want to make corrections later, you may want to draw helper lines onto your output image. Whether or not you wish to can be chosen using the checkbox at the top. If you want helper lines, you can choose colors for minor and major helper lines as well as the interval at which major helper lines should appear (default: every 5th line is in a contrast color to help you count).

Output File

When you choose "File -> Save As...", you can determine where the program should store the outcome of your stixelation process. The output will match the file ending you give, which can either be PNG or JPEG.

Clone this wiki locally