Skip to content

Latest commit

 

History

History
92 lines (65 loc) · 6.55 KB

README.md

File metadata and controls

92 lines (65 loc) · 6.55 KB

Slic3r Build Status Build status Build StatusCoverity Status

We have automated builds for Windows (64-bit) and OSX (>= 10.7). Get a fresh build now and stay up-to-date with the development!

The MacOS X build server is kindly sponsored by:

So, what's this Slic3r?

Slic3r is mainly a toolpath generator for 3D printers: it reads 3D models (STL, OBJ, AMF, 3MF) and it converts them into G-code instructions for 3D printers. But it does much more than that, see the features list below.

Slic3r was born in 2011 within the RepRap community and thanks to its high configurability became the swiss-army knife for 3D printing. It served as a platform for experimenting several new ideas that later became technology standards, such as multiple extruders, brim, variable-height layers, per-object settings, modifiers, post-processing scripts, G-code macros and more. Despite being based on volunteer efforts, Slic3r is still pushing the boundaries of 3D printing.

Slic3r is:

  • Open: it is totally open source and it's independent from any commercial company or printer manufacturer. We want to keep 3D printing open and free.
  • Compatible: it supports all the known G-code dialects (Marlin, Repetier, Mach3, LinuxCNC, Machinekit, Smoothie, Makerware, Sailfish).
  • Advanced: many configuration options allow for fine-tuning and full control. While novice users often need just few options, Slic3r is mostly used by advanced users.
  • Community-driven: new features or issues are discussed in the GitHub repository. Join our collaborative effort and help improve it!
  • Robust: the codebase includes more than 1,000 unit and regression tests, collected in 6 years of development.
  • Modular: the core of Slic3r is libslic3r, a C++ library that provides a granular API and reusable components.
  • Embeddable: a complete and powerful command line interface allows to use Slic3r from the shell or to integrate it in server-side applications.
  • Powerful: see the list below!

See the project homepage at slic3r.org for more information.

Features

(Most of these are also available in the command line interface.)

  • G-code generation for FFF/FDM printers;
  • conversion between STL, OBJ, AMF, 3MF and POV formats;
  • auto-repair of non-manifold meshes (and ability to re-export them);
  • SVG export of slices;
  • built-in USB/serial host controller, supporting multiple simultaneous printers each one with a spool queue;
  • OctoPrint integration (send to printer);
  • built-in projector and host for DLP printers;
  • tool for cutting meshes in multiple solid parts with visual preview (also in batch using a grid);
  • tool for extruding 2.5D TIN meshes.

What language is it written in?

The core parts of Slic3r are written in C++11, with multithreading. The graphical interface is in the process of being ported to C++14.

How to install?

You can download a precompiled package from slic3r.org (releases) or from dl.slicr3r.org (automated builds).

If you want to compile the source yourself follow the instructions on one of these wiki pages:

Can I help?

Sure! You can do the following to find things that are available to help with:

Directory structure

  • package/: the scripts used for packaging the executables
  • src/: the C++ source of the slic3r executable the and CMake definition file for compiling it
  • src/GUI: The C++ GUI.
  • src/test: New test suite for libslic3r and the GUI. Implemented with Catch2
  • t/: the test suite (deprecated)
  • utils/: various useful scripts
  • xs/src/libslic3r/: C++ sources for libslic3r
  • xs/t/: test suite for libslic3r (deprecated)
  • xs/xsp/: bindings for calling libslic3r from Perl (XS) (deprecated)

Acknowledgements

The main author of Slic3r is Alessandro Ranellucci (@alranel, Sound in IRC, @alranel on Twitter), who started the project in 2011.

Joseph Lenox (@lordofhyphens, LoH in IRC, @LenoxPlay on Twitter) is the current co-maintainer.

Contributions by Henrik Brix Andersen, Vojtech Bubnik, Nicolas Dandrimont, Mark Hindess, Petr Ledvina, Y. Sapir, Mike Sheldrake, Kliment Yanev and numerous others. Original manual by Gary Hodgson. Slic3r logo designed by Corey Daniels, Silk Icon Set designed by Mark James, stl and gcode file icons designed by Akira Yasuda.

How can I invoke Slic3r using the command line?

The command line is documented in the relevant manual page.