https://github.com/mainsail-crew/mainsail
Mainsail is the popular web interface for managing and controlling 3D printers with Klipper.
https://github.com/mainsail-crew/mainsail
3d-printing hacktoberfest interface klipper mainsail moonraker responsive vorondesign
Last synced: 6 months ago
JSON representation
Mainsail is the popular web interface for managing and controlling 3D printers with Klipper.
- Host: GitHub
- URL: https://github.com/mainsail-crew/mainsail
- Owner: mainsail-crew
- License: gpl-3.0
- Created: 2020-02-16T11:00:27.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2025-05-02T06:13:39.000Z (about 1 year ago)
- Last Synced: 2025-05-12T01:07:31.608Z (about 1 year ago)
- Topics: 3d-printing, hacktoberfest, interface, klipper, mainsail, moonraker, responsive, vorondesign
- Language: Vue
- Homepage: https://docs.mainsail.xyz
- Size: 25.4 MB
- Stars: 1,874
- Watchers: 50
- Forks: 428
- Open Issues: 110
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-foss-manufacturing - Mainsail - 3.0 | (Machine Control Interfaces & Hosts / Laser Cutter Firmware)
README
Makes Klipper more accessible by adding a lightweight, responsive web user interface, centred around an intuitive and consistent design philosophy.
## Getting Started
Visit [docs.mainsail.xyz/setup](https://docs.mainsail.xyz/setup) to get started with Mainsail.
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
Visit [docs.mainsail.xyz](https://docs.mainsail.xyz) to view the full documentation.
You can find the latest release notes [here](https://github.com/mainsail-crew/mainsail/releases).
## Screenshots
## Features
- **Responsive Web Interface:** _Optimized for desktops, tablets and mobile devices_
- **Printer Farm:** _Supports multiple 3D printers_
- **[Localization](https://docs.mainsail.xyz/features/localization):** _Choose between 12 different languages_
- **File Manager:** _Delete, rename and upload your G-Code and config files_
- **File Editor:** _Edit G-Code and config files with syntax highlighting in your browser_
- **[Print History](https://docs.mainsail.xyz/features/history):** _See your previous prints and their status_
- **[Statistics](https://docs.mainsail.xyz/features/history):** _View how much time your printer has been in use and the number of jobs that have succeeded or failed_
- **Job Queue:** _Queue multiple jobs and add them directly from your slicer_
- **[Temperature Presets](https://docs.mainsail.xyz/features/presets):** _Manage different temperature presets for easy preheating_
- **[Bed Mesh Visualisation](https://docs.mainsail.xyz/features/bedmesh):** _View your bed using a 3D mesh graph_
- **G-Code Viewer:** _View a 3D render of your print and follow the progress_
- **Multi-Webcam Support:** _View your print from different angles with multiple webcams_
- **Timelapse Integration:** _Automatically record a timelapse of your print using [moonraker-timelapse](https://github.com/mainsail-crew/moonraker-timelapse)_
- **Power Control:** _Control power devices such as relays, TP-Link and Tasmota devices, and more_
- **Powerful Macro-Management:** _Manage your macros on a micro level_
- **[Configurable Dashboard](https://docs.mainsail.xyz/features/dashboard-organisation):** _Create your own personal dashboard_
- **[Theming Support](https://docs.mainsail.xyz/features/theming):** _Customizable user interface including logos, backgrounds, and custom CSS_
- **[Additional Sensors](https://docs.mainsail.xyz/quicktips/additional-sensors):** _Add extra sensors to the temperature graph_
- **Exclude Objects:** _Exclude parts of your print (not officially supported by Klipper yet)_
## Help and Support
Do you need help or just want to talk? Join our active community on [Discord](https://discord.gg/skWTwTD)!
Did you find a bug or did you thought of a feature?
Please create an [Issue](https://github.com/mainsail-crew/mainsail/issues) in GitHub and let us know.
## Official Sponsors
**BIGTREETECH** is the official mainboard partner of Mainsail. BIGTREETECH is committed to developing innovative and competitive products to better serve the 3D printing community.
## 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:
[](https://www.patreon.com/meteyou)
[](https://ko-fi.com/mainsail)
## Contributing
Contributions to Mainsail are always welcome!
- 📥 Pull requests and 🌟 Stars are always welcome.
- Read our [contributing guidelines](CONTRIBUTING.md) to get started,
or find us on [Discord](https://discord.gg/mainsail), we will take the time to guide you.
Looking for a first issue to tackle?
- We tag issues with [](https://github.com/mainsail-crew/mainsail/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) when we think they are well suited for people who are new to the codebase or OSS in general.
- [Talk to us](https://discord.gg/mainsail), we'll find something that suits your skills and learning interest.
## 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 & License information](https://docs.mainsail.xyz/credits)
