# Mainsail

Mainsail a lightweight & responsive web interface for [Klipper](https://github.com/KevinOConnor/klipper), the 3D printer firmware. It communicates with [Moonraker (Klipper-API)](https://github.com/arksine/moonraker) from [Arksine](https://github.com/arksine). 

[Getting Started](https://docs.mainsail.xyz/setup)

Mainsail is also available in remote mode on [http://my.mainsail.xyz](http://my.mainsail.xyz). Find out [more](https://docs.mainsail.xyz/setup#mymainsailxyz).

[Documentation](https://docs.mainsail.xyz)  
[Release Notes](https://github.com/meteyou/mainsail/releases)

## Screenshots
![screenshot-dashboard](docs/assets/img/screenshot.png)

## Features 
- Optimized for desktops, tablets and mobile devices
- Supports multiple 3D printers (Printer Farm)
- Localization (i18n)
- File Manager (gcode and config files)
- File Editor (gcode and config files)
- Print History / Stats
- Temperature Presets (with custom gcode)
- Bed Mesh Leveling
- Multi-Webcam support
- Control power devices (relays, TPLink, Tasmota, ..)
- Customizable UI (logos, backgrounds & even custom css)

## Get support & assistance
Do you need help or just want to talk? Join us on [Discord](https://discord.gg/skWTwTD). We have a very active community.  
Have you found a bug? Then we would like you to create an [issue](https://github.com/meteyou/mainsail/issues).

## Support this project
The project is primarily developed and maintained by meteyou. To keep the project going he invests his free time, almost every day. To motivate him (☕🍺😜) there are several ways to support the project.

- [Patreon (recurring)](https://patreon.com/meteyou)
- [Ko-Fi (one-time)](https://ko-fi.com/mainsail)

## Credit, sources and inspiration
* [Kevin O'Connor](https://github.com/KevinOConnor) for the awesome 3D printer firmware [Klipper](https://github.com/KevinOConnor/klipper)
* [Eric Callahan (arksine)](https://github.com/Arksine) for [Moonraker (Klipper API)](https://github.com/Arksine/moonraker). Without Moonraker, Mainsail would not be possible.
* [lixxbox](https://github.com/lixxbox) for the Mainsail logo & Docs
* [Vue.js](https://vuejs.org/): The Progressive JavaScript Framework
* [Vuetify](https://vuetifyjs.com/): Material Design Component Framework for Vue.js

Massive thanks to the whole [Voron Design](http://vorondesign.com/) community. Without them such a project would not be possible.

[Full Credits & Licenseinformation](https://docs.mainsail.xyz/credits)