search

PancakeBot / PancakePainter

Drawing & creation software for your PancakeBot!
http://pancakebot.com
Apache License 2.0
70 stars 40 forks source link

readme

PancakePainter!

The super-simple drawing software for your PancakeBot.

Download/Install [Latest release] - v1.4.0

Check the latest release page for feature notes, known issues, and other details.

PancakePainter

User Documentation

  1. Using the drawing tool:
    • Click and drag to draw pancake lines freehand
    • Click single points to draw polygonal shapes, press right click or ESC/Enter to complete drawing.
  2. Using the selection tool:
    • Click the center or near a line to select it, shift click to add to selection.
    • Alternate selection: Click and drag to create a selection marquee to fully encompass any objects you'd like to select (v1.3.0).
    • Once selected, click and drag the corner handles to scale the object, or the top rotation handle to rotate it.
    • Click and drag points on the line to move them, shift-click to remove, or click an area on the line without any points to add a new point.
    • Click and drag the selected object anywhere else to move it to a new position.
  3. Manual image trace import tool:
    • To import an image to trace by hand, click the image import icon, then select the manual import icon on the left. Select your image (in any standard web format, GIF, JPG, PNG), and it will be placed on the canvas.
    • Once imported, you can move the image around and scale/rotate it as needed.
    • When done, click outside the image, press ESC, or select the drawing tool.
    • To adjust the image position, just click the image import button again. To choose a new image, press the Delete key when in edit mode then click import again.
  4. Automatic image trace import tool (v1.3.0):
    • Click the image import icon and select either of the two automatic trace presets.
    • Within the automatic trace window, adjust the settings to your liking.
    • When complete, select how many copies you want & click the "Place" button.
    • You now should have fills and strokes as if you had drawn them yourself.
  5. Using the fill tool:
    • The fill tool is used to visually fill an area with a specific shade, which will then be used to create a zig-zag fill pattern used by the PancakeBot.
    • Click inside an empty area enclosed on all sides by drawn lines to fill that space. Large or complex fills may take some time.
    • Only drawn lines define what can be filled, not imported images or the drawable boundary.
    • If the algorithm cannot fill what you've drawn, you will be notified with a reason why.
    • If a complex fill ends up with triangles across it or doesn't look right, select and delete it, then adjust the surrounding shapes and try again.
  6. Export your drawing for printing:
    • Your PancakeBot uses a readable text format for input called GCODE to create your pancake art. Unique to each drawing and configuration, they tell your bot how to move and when to extrude batter to make your drawing.
    • To generate the file you need, use the menu "File > Export for printing..." and select a location to save the file. You can then place this on your bot's SD card and print at your leisure.

Official support will eventually be found @ PancakeBot.com

Problems?

Stuck on something? Submit an issue! Click the issues tab and see if someone is covering your question or problem, if not, ask away! Someone will be around to help soon.

Know how to fix a problem? Or want to add a new feature?? Submit a pull request! Just fork the repo using the button on the github homepage, and this will give you your own version of PancakePainter. Make your change in a few commits to a new branch, then click the pull request button at the top! Talk about what changes you made and submit. A maintainer of the project will check your work, possibly ask you to fix a few more things, and then if all is well, your work will be merged into the project. It's that easy, really.

Contributing to the Project

PancakePainter uses Github's Electron application shell as a cross platform wrapper, and to create the application logic everything is written in plain JavaScript. If you know how to mess with websites, HTML, CSS or jQuery, you can bend PancakePainter to your whim! Read on to get your own dev environment setup to start hacking.

Local Run Prerequisites

Node.js (4.x+) & npm

Required for automated builds and node module install. Electron uses Node.js and npm to manage running and packages. See nodejs.org for installation for your operating system. npm is installed along with it. If you already have node installed, you can probably go without upgrading as Electron provides its own node.js implementation built in.

Install PancakePainter run resources

Though the src/index.html may somewhat render in a regular browser, you're going to need to run it inside of Electron before it all works. To get the local code running, be sure to run npm install --force from the repository root, this will give you the third party resources needed to run. The --force is unfortunately required to pass install of Paper.js as a node module, even though we only use it as a clientside library, so we can ignore the errors. See the tracking issue here.

Build Tools

Various node modules require builds and may complain if you don't have the right build tools. These are great to have regardless on any OS you use.

Windows
Mac OSX
Linux

Running from source

ETC.

This open source project has been built with love by TechNinja, made possible though direct support from Storebound, PancakeBot, and Kickstarter Backers like you!

Windows installation GIF made with permission from animation work done by the incredible Orbo.

All code licensed under Apache v2.0