https://github.com/mainsail-crew/gb-docs
📖 Documentation for Mainsail - including step-by-step installation guides
https://github.com/mainsail-crew/gb-docs
documentation klipper mainsail mainsailos moonraker raspberry-pi
Last synced: about 1 month ago
JSON representation
📖 Documentation for Mainsail - including step-by-step installation guides
- Host: GitHub
- URL: https://github.com/mainsail-crew/gb-docs
- Owner: mainsail-crew
- License: gpl-3.0
- Created: 2022-07-07T13:05:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-27T19:12:28.000Z (4 months ago)
- Last Synced: 2025-04-06T03:33:21.285Z (about 1 month ago)
- Topics: documentation, klipper, mainsail, mainsailos, moonraker, raspberry-pi
- Language: JavaScript
- Homepage: https://docs.mainsail.xyz
- Size: 8.87 MB
- Stars: 1
- Watchers: 3
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
description: >-
A modern and responsive user interface for Klipper. Control and monitor your
printer from everywhere, from any device.
cover: .gitbook/assets/Mainsail_SB.jpg
coverY: 0
---
# Welcome to Mainsail
**Easy to use.** The focus lies on both anticipating what users may need to do and ensuring that the user interface contains elements that are easily accessible, understandable, and user-friendly to make those actions easier.
**Always one step ahead.** We work closely with developers of other projects so that functions can already be implemented early on.
**100% open source.** Anyone can join, anyone can contribute.
## Getting started
{% content-ref url="setup/getting-started/" %}
[getting-started](setup/getting-started/)
{% endcontent-ref %}
## Screenshots
Screenshot Dashboard (Mobile & Desktop)
.png)
Heightmap, G-code viewer, Farm mode
## Features
* **Responsive Web Interface:** _Optimized for desktops, tablets and mobile devices_
* **Printer Farm:** _Supports multiple 3D printers_
* **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:** _See your previous prints and their status_
* **Statistics:** _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:** _Manage different temperature presets for easy preheating_
* **Bed Mesh Visualisation:** _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:** _Create your own personal dashboard_
* **Theming Support:** _Customizable user interface including logos, backgrounds, and custom CSS_
* **Additional Sensors:** _Add extra sensors to the temperature graph_
* **Exclude Objects:** _Exclude parts of your print_
## Help and Support
Do you need help or just want to talk? Join our active community on Discord. Have you found a bug? Please create an Issue in GitHub and let us know.
* [Discord](https://discord.gg/skWTwTD)
* [GitHub Issues](https://github.com/mainsail-crew/mainsail/issues)
## 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://www.patreon.com/meteyou) (recurring)
* [GitHub](https://github.com/sponsors/mainsail-crew) (recurring or one-time)
* [Ko-Fi](https://ko-fi.com/mainsail) (one-time)
{% hint style="info" %}
Please also support all of our maintainers and contributors.
{% endhint %}