commit 5869bc2ae1c13fa7b387333faf0f592c14ec2079 Author: Brian Boucheron Date: Thu Jun 7 06:52:17 2018 -0400 initial commit diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md new file mode 100644 index 0000000..5b18278 --- /dev/null +++ b/CODE-OF-CONDUCT.md @@ -0,0 +1,73 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +education, socio-economic status, nationality, personal appearance, race, +religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [brian@boucheron.org](mailto:brian@boucheron.org). All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..bb3eb04 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Contribution Guidelines + +Thank you for your interest in contributing! I am quite open to pull requests and other forms of help. + +I'm still feeling out the guidelines for what is "worthy" of inclusion here. If you're unsure, feel free to open an issue to discuss before putting in the effort of writing things up for a pull request. + +Also, please ensure your pull request adheres to the following guidelines: + +* search previous suggestions before making a new one, as yours may be a duplicate +* enter a meaningful pull request description +* make an individual commit for each suggestion in a pull request +* organizational improvements are always welcome, but are probably best discussed in an issue first +* if your link needs a new category/header, go ahead and make one (be sure to update the _Contents_ section as well) +* keep descriptions short and simple +* check your spelling and grammar + +I am definitely a stickler for consistent formatting and language, so forgive me if I update your contribution before or after merging. + +Thanks again! diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..670154e --- /dev/null +++ b/LICENSE @@ -0,0 +1,116 @@ +CC0 1.0 Universal + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator and +subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later +claims of infringement build upon, modify, incorporate in other works, reuse +and redistribute as freely as possible in any form whatsoever and for any +purposes, including without limitation commercial purposes. These owners may +contribute to the Commons to promote the ideal of a free culture and the +further production of creative, cultural and scientific works, or to gain +reputation or greater distribution for their Work in part through the use and +efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with a +Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or her +Copyright and Related Rights in the Work and the meaning and intended legal +effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not limited +to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, communicate, + and translate a Work; + + ii. moral rights retained by the original author(s) and/or performer(s); + + iii. publicity and privacy rights pertaining to a person's image or likeness + depicted in a Work; + + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + + v. rights protecting the extraction, dissemination, use and reuse of data in + a Work; + + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation thereof, + including any amended or successor version of such directive); and + + vii. other similar, equivalent or corresponding rights throughout the world + based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of +action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time +extensions), (iii) in any current or future medium and for any number of +copies, and (iv) for any purpose whatsoever, including without limitation +commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes +the Waiver for the benefit of each member of the public at large and to the +detriment of Affirmer's heirs and successors, fully intending that such Waiver +shall not be subject to revocation, rescission, cancellation, termination, or +any other legal or equitable action to disrupt the quiet enjoyment of the Work +by the public as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account +Affirmer's express Statement of Purpose. In addition, to the extent the Waiver +is so judged Affirmer hereby grants to each affected person a royalty-free, +non transferable, non sublicensable, non exclusive, irrevocable and +unconditional license to exercise Affirmer's Copyright and Related Rights in +the Work (i) in all territories worldwide, (ii) for the maximum duration +provided by applicable law or treaty (including future time extensions), (iii) +in any current or future medium and for any number of copies, and (iv) for any +purpose whatsoever, including without limitation commercial, advertising or +promotional purposes (the "License"). The License shall be deemed effective as +of the date CC0 was applied by Affirmer to the Work. Should any part of the +License for any reason be judged legally invalid or ineffective under +applicable law, such partial invalidity or ineffectiveness shall not +invalidate the remainder of the License, and in such case Affirmer hereby +affirms that he or she will not (i) exercise any of his or her remaining +Copyright and Related Rights in the Work or (ii) assert any associated claims +and causes of action with respect to the Work, in either case contrary to +Affirmer's express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + + b. Affirmer offers the Work as-is and makes no representations or warranties + of any kind concerning the Work, express, implied, statutory or otherwise, + including without limitation warranties of title, merchantability, fitness + for a particular purpose, non infringement, or the absence of latent or + other defects, accuracy, or the present or absence of errors, whether or not + discoverable, all to the greatest extent permissible under applicable law. + + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without limitation + any person's Copyright and Related Rights in the Work. Further, Affirmer + disclaims responsibility for obtaining any necessary consents, permissions + or other rights required for any use of the Work. + + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to this + CC0 or use of the Work. + +For more information, please see + diff --git a/README.md b/README.md new file mode 100644 index 0000000..93c91bd --- /dev/null +++ b/README.md @@ -0,0 +1,148 @@ +# Awesome Plotters [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) + +A curated list of code and resources for pen plotters and other robots that draw. + +## Contributing + +Contributions are very welcome. Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE-OF-CONDUCT](CODE-OF-CONDUCT.md) for details. + +## Contents + +* [Hardware](#hardware) + * [Plotters](#plotters) + * [Motor Controllers](#motor-controllers) + * [Accessories](#accessories) + * [Pens](#pens) +* [Software](#software) + * [HPGL](#hpgl) + * [G-code](#g-code) + * [Plotter-Specific](#plotter-specific) + * [Vector Creation](#vector-creation) + * [Vector Utilities](#vector-utilities) + * [Fonts](#fonts) +* [Inspiration and Instruction](#inspiration-and-instruction) +* [Community](#community) +* [Other Awesomes](#other-awesomes) + +## Hardware + +### Plotters + +* [AxiDraw](https://shop.evilmadscientist.com/productsmenu/846) – pen plotter from [Evil Mad Scientist](https://www.evilmadscientist.com/), very popular on [#plottertwitter](https://twitter.com/hashtag/plottertwitter) +* [Line-us](https://www.line-us.com/) – a cute little kickstarted robotic drawing arm +* [Makeblock XY Plotter](https://makeblockshop.eu/products/makeblock-xy-plotter) – hackable XY plotter kit (possibly discontinued) +* [Drawing Robot](https://www.thingiverse.com/thing:2349232) – 3d-Printable AxiDraw clone w/ [Arduino CNC Shield](https://blog.protoneer.co.nz/arduino-cnc-shield/) controller running grbl firmware +* [WaterColorBot](https://watercolorbot.com/) – XY art robot and software to plot with watercolor paints +* [EggBot](https://egg-bot.com/) – pen plotter for egg-shaped and spherical objects +* [HP Pen Plotters](http://www.hpmuseum.net/exhibit.php?class=4&cat=24) – vintage desktop and floor-standing pen plotters from the creator of the HPGL standard. Model 7475A is very common and can usually be found on eBay +* [Roland Pen Plotters](https://www.youtube.com/watch?v=6_pwzqPk6Gg) (YouTube) – vintage flatbed HPGL pen plotters. Search eBay for "roland dxy" + +### Motor Controllers + +* [grblShield](https://github.com/synthetos/grblShield) – all the stepper motor control hardware needed to turn an [Arduino](https://www.arduino.cc/) into a G-code-based motion controller using the grbl firmware ([adafruit](https://www.adafruit.com/product/1750)) +* [TinyG](https://github.com/synthetos/TinyG/) – more featureful and robust 6-axis G-code-based motion control hardware ([adafruit](https://www.adafruit.com/product/1749)) +* [Arduino CNC Shield](https://blog.protoneer.co.nz/arduino-cnc-shield/) – grbl-compatible stepper motor control shield for Arduino, similar to the [grblShield](https://github.com/synthetos/grblShield) +* [Raspberry Pi CNC Hat](https://wiki.protoneer.co.nz/Raspberry_Pi_CNC) – Raspberry Pi add-on board w/ stepper controllers and a microcontroller running grbl. Interfaces with the Pi's serial pins + +### Accessories + +* [WiFi232](http://biosrhythm.com/?page_id=1453) – wifi to RS-232 serial via a DB25 plug. Control your serial plotter wirelessly +* [Plotter Cable Pinout](http://sites.music.columbia.edu/cmc/chiplotle/plotter_cable.pdf) (PDF) – schematic for a plotter cable that will work for most HP and Roland plotters. Search eBay or Amazon for `DB9 to DB25 Serial Null Modem Cable` or similar to find them for sale + +### Pens + +* [Sharpie Fine Point Plotter Adapter](https://www.thingiverse.com/thing:229982) – 3d-printed adapter to fit a standard Sharpie in an HP-GL plotter +* [Parametric 3d-Printable Plotter Pen Adapter](https://openjscad.org/#https://gist.githubusercontent.com/beardicus/d668c0f6b96be53d16dc/raw/plotter-pen-adapter.jscad) – adjustable model to print adapters for various pens +* [Plotter Pen STL Models](https://www.thingiverse.com/thing:227985) – accurate STL models of both short and long standard plotter pens +* TODO: pen recommendations + +## Software + +### HPGL + +HPGL is a serial/text-based protocol used by most old pen plotters, and even many new vinyl cutters. + +* [Chiplotle](https://github.com/drepetto/chiplotle) ([web site](http://chiplotle.org/)) – Python library for generating HPGL and interfacing with serial plotters +* [HPGL Reference Guide](http://www.isoplotec.co.jp/HPGL/eHPGL.htm) – HTML-based HPGL Reference +* [HP 7475A Interfacing and Programming Manual](https://archive.org/details/HP7475AInterfacingandProgrammingManual) – scanned PDF manual that contains a full HPGL reference +* [djipco/hpgl](https://github.com/djipco/hpgl) – A Node.js library to communicate with HPGL-compatible plotters and printers +* [hp2xx](https://www.gnu.org/software/hp2xx/) – GNU tool to convert HPGL into other vector and raster formats. Can also be used as a previewing in X11 + +### G-code + +G-code is a text-based standard for controlling CNC machines. Though it was designed for industrial machines, its use in many hobbyist 3d printer firmwares has made it ubiquitous in small-scale DIY projects as well. + +* [grbl](https://github.com/grbl/grbl) – a high-performance G-code interpreting firmware for the Atmega 328 microcontroller and Arduino +* [cncjs](https://github.com/cncjs/cncjs) – a web-based interface controlling CNC machines running grbl, TinyG, or other G-code-based firmware +* [node-gcode](https://github.com/ryansturmer/node-gcode) – Node.js-based G-code interpreter and similator +* [svg2gcode](https://github.com/em/svg2gcode) – Node.js-based command line utility for converting SVG to G-code +* [svg2gcode](https://github.com/vishpat/svg2gcode) – Python-based utility for fast SVG to G-code conversion +* [Universal-G-Code-Sender](https://github.com/winder/Universal-G-Code-Sender) – Java-based grbl-compatible cross-platform G-code sender +* [ChiliPeppr Hardware Fiddle](http://chilipeppr.com/) – modular web-based workspaces to visualize G-code and control hardware + +### Plotter-Specific + +Software that is specific to a particular plotter or controller. + +* [axidraw](https://github.com/evil-mad/axidraw) – official AxiDraw extensions for Inkscape +* [axi](https://github.com/fogleman/axi) – unofficial Python library for the AxiDraw v3 +* [xy](https://github.com/fogleman/xy) – utilities for the Makeblock XY Plotter Robot Kit +* [LaserGRBL](https://github.com/arkypita/LaserGRBL) – laser-optimized Windows GUI for grbl controllers. Could be repurposed for DIY pen plotters that use a solenoid for pen up/down movements +* [Line-us Inkscape Plugin](https://github.com/Line-us/Inkscape-Plugin) – sends drawings to the [Line-us plotter](https://www.line-us.com/) directly from Inkscape +* [Line-us API Examples](https://github.com/Line-us/Line-us-Programming) – example code for the [Line-us](https://www.line-us.com/) plotter's G-code-based API + +### Vector Creation + +Tools to create vector artwork from scratch or by conversion from other formats. + +* [Inkscape](https://inkscape.org/) – popular cross-platform open source vector graphics editor +* [p5.js](https://p5js.org/) – "javascript library that makes coding accessible for artists, designers, educators, and beginners" +* [Paper.js](http://paperjs.org/) – "The Swiss Army Knife of Vector Graphics Scripting" +* [ln](https://github.com/fogleman/ln) – vector-based 3D renderer written in Go +* [autotrace](https://github.com/autotrace/autotrace) – converts bitmap images to vector graphics +* [stipplegen](https://github.com/evil-mad/stipplegen) – creates intereting stippled drawings from bitmap images ([blog post](https://www.evilmadscientist.com/2012/stipplegen2/)) +* [SquiggleDraw](https://github.com/gwygonik/SquiggleDraw/commits/master) – "SquiggleDraw will create a SVG file from an image, using the brightness to change the amplitude of sine waves" +* [svgurt](http://svgurt.com/) – web-based PNG to SVG creative noodler + +### Vector Utilities + +Tools to manipulate and optimize vector-based file formats. + +* [svgsort](https://github.com/inconvergent/svgsort) – path planning for plotting SVG files, reduces time spent moving with the pen up +* [svgo](https://github.com/svg/svgo) – Node.js-based tool for optimizing SVG files + +### Fonts + +Single-line vector fonts or "engraving fonts". + +* [Hershey Vector Font](http://paulbourke.net/dataformats/hershey/) – `.fnt` format of vector fonts from the 60s. Includes a good overview of the original data format of the fonts +* [hershey-fonts](https://github.com/kamalmostafa/hershey-fonts) – C library and original font data for the Hershey fonts +* [OneLineFonts.com](http://www.onelinefonts.com/) – commercial site with some single-line fonts available for purchase + +## Inspiration and Instruction + +Blog posts, articles, tutorials, galleries, videos, et cetera. + +* [An Intro to Pen Plotters](http://www.tobiastoft.com/posts/an-intro-to-pen-plotters) – good info on getting started with old HPGL plotters +* [1980s pen plotters of the future](https://notes.variogr.am/2012/08/12/1980s-pen-plotters-of-the-future/) – another intro to vintage pen plotters +* [On Generative Algorithms](https://inconvergent.net/generative/) – nice 13-part walkthrough of interesting algorithms +* [Roland DG DXY-990](https://hackaday.io/project/12276-roland-dg-dxy-990) – quickstart guide for a Roland flatbed plotter +* [The Cohen-Sutherland Line Clipping Algorithm](https://sighack.com/post/cohen-sutherland-line-clipping-algorithm) – detailed explanation and examples of an interesting algorithm +* [Vera Molnár](https://www.surfacemag.com/articles/vera-molnar-in-thinking-machines-at-moma/) – OG plotter artist +* [The Recode Project](http://recodeproject.com/) – "The ReCode Project is a community-driven effort to preserve computer art by translating it into a modern programming language" +* [Hektor](http://juerglehni.com/works/hektor) – the original cable-based drawbot from 2002 + +## Community + +Where to find other plotter and drawbot friends. + +* [#plottertwitter](https://twitter.com/hashtag/plottertwitter) – Twitter hashtag with lots o' plots +* [PlotterArt Subreddit](https://www.reddit.com/r/PlotterArt/) +* [AxiDraw Subreddit](https://www.reddit.com/r/axidraw/) +* [Generative Art Subreddit](https://www.reddit.com/r/generative/) +* [Chiplotle-discuss](https://lists.columbia.edu/mailman/listinfo/chiplotle-discuss) – fairly inactive mailing list for the Chiplotle HPGL Python library with some general plotter talk + +## Other Awesomes + +* [awesome-generative-art](https://github.com/kosmos/awesome-generative-art) +* [awesome-creative-coding](https://github.com/terkelg/awesome-creative-coding)