diff options
| author | Elena of Valhalla'' Grandi <valhalla@trueelena.org> | 2013-12-07 23:04:25 +0100 |
|---|---|---|
| committer | Elena of Valhalla'' Grandi <valhalla@trueelena.org> | 2013-12-07 23:04:25 +0100 |
| commit | 4cabcc50c54903b6127d0d5ff6824cd054f3eb24 (patch) | |
| tree | e8b47b1df7d556646e4299c40bc6ba5b74c26d58 | |
| parent | 73109e903648234defa78709623d63a59357c887 (diff) | |
README and license
| -rw-r--r-- | README.rst | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a912ad6 --- /dev/null +++ b/README.rst @@ -0,0 +1,64 @@ +======================== + 3D Printable Piecepack +======================== + +The piecepack_ is a generic set of boardgame parts designed by James Kyle +and released under public domain. Hundreds of games for the piecepack +are available on the internet, both on the official site and +on the `piecepack wiki`_. + +This piecepack is designed for 3D printers and can be printed at home +(or your local fablab) or sent to a 3D printing service. +Currently it includes the basic piecepack (with saucers and suite die), +cards and seasons extensions are planned for the future. + +.. _piecepack: http://www.piecepack.org/ +.. _`piecepack wiki`: http://www.ludism.org/ppwiki/ + +Instructions +------------ + +Building the 3D models +~~~~~~~~~~~~~~~~~~~~~~ + +To generate the .stl files for each piecepack component you need Make +(tested with `GNU Make`_) and OpenSCAD_; one you have installed these +dependencies just run:: + + $ make + +from the root directory of this repository and wait. + +Example settings for Slic3r_ are available in the conf directory: +you can load them in Slic3r, change the settings (expecially those +related to the printer) and re-export them in place. +Then you can use:: + + $ make gcode + +from the root directory of the repository to generate .gcode files +which can be sent to your printer. + +.. _`GNU Make`: https://www.gnu.org/software/make/ +.. _OpenSCAD: http://www.openscad.org/ +.. _Slic3r: http://slic3r.org/ + +Printing +~~~~~~~~ + +The models should be printed in an opaque material: when using PLA +a darkish color may be better than a light one. + +All markings on the pieces are recessed in the surface and should +be painted with appropriate colors. On PLA I've used craft acrylics +with success by applying two layers of primer. + +License +------- + +OpenSCAD code and SVG artwork Copyright 2013 Elena Grandi + +This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 +International License. To view a copy of this license, visit +http://creativecommons.org/licenses/by-sa/4.0/. + |