CreatBotMainsail/README.md
2022-02-05 17:28:58 +01:00

62 lines
4.4 KiB
Markdown

<p align="center">
<img src="https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/logo.png" alt="Sublime's custom image"/>
</p>
# Mainsail
[![downloads](https://img.shields.io/github/downloads/mainsail-crew/mainsail/total?style=flat-square)](https://github.com/mainsail-crew/mainsail/releases) [![localizations](https://shields-staging.herokuapp.com/github/directory-file-count/mainsail-crew/mainsail/src%2Flocales?label=localizations&extension=json&type=file&style=flat-square)](https://docs.mainsail.xyz/development/localization) [![stars](https://img.shields.io/github/stars/meteyou/mainsail?style=flat-square)](https://github.com/mainsail-crew/mainsail/stargazers) [![forks](https://img.shields.io/github/forks/meteyou/mainsail?style=flat-square)](https://github.com/mainsail-crew/mainsail/network/members)
[![license](https://img.shields.io/github/license/meteyou/mainsail?style=flat-square)](https://github.com/mainsail-crew/mainsail/blob/develop/LICENSE) [![last-commit](https://img.shields.io/github/last-commit/meteyou/mainsail?style=flat-square)](https://github.com/mainsail-crew/mainsail/commits/) ![size](https://img.shields.io/github/repo-size/meteyou/mainsail?style=flat-square)
[![discord](https://img.shields.io/discord/758059413700345988?color=%235865F2&label=discord&logo=discord&logoColor=white&style=flat-square)](https://discord.gg/skWTwTD) [![patreons](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dmeteyou%26type%3Dpatrons&style=flat-square)](https://www.patreon.com/meteyou)
Mainsail makes Klipper more accessible by adding a lightweight, responsive web user interface, centred around an intuitive and consistent design philosophy.
[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/mainsail-crew/mainsail/releases)
## Screenshots
![screenshot-dashboard](https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/screenshot.png)
![Features](https://raw.githubusercontent.com/mainsail-crew/docs/master/assets/img/features.png)
## Features
- Responsive web interface, 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 and Statistics
- Job Queue
- Temperature Presets (with custom gcode)
- Bed Mesh visualisation
- G-Code Viewer
- Multi-Webcam support
- Timelapse integration
- Control power devices such as relays, TPLink and Tasmota devices, and more
- Powerful Macro-Management
- Configurable dashboard
- Customizable user interface including logos, backgrounds, and custom CSS
- Exclude objects (not yet officially supported by Klipper)
## Help and Support
Do you need help or just want to talk? Join our active community on [Discord](https://discord.gg/skWTwTD).
Have you found a bug? Please create an [Issue](https://github.com/mainsail-crew/mainsail/issues) in GitHub and let us know.
## Support Mainsail
Mainsail 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 him:
[![patreon](https://img.shields.io/badge/patreon-participate-yellow.svg?style=flat-square)](https://www.patreon.com/meteyou)
[![kofi](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=flat-square)](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)