6.8 KiB
Contact
This document provides contact information for Klipper.
- Community Forum
- Discord Chat
- I have a question about Klipper
- I have a feature request
- Help! It doesn't work!
- I found a bug in the Klipper software
- I am making changes that I'd like to include in Klipper
- Klipper github
Community Forum
There is a Klipper Community Discourse server for discussions on Klipper.
Discord Chat
There is a Discord server dedicated to Klipper at: https://discord.klipper3d.org.
This server is run by a community of Klipper enthusiasts dedicated to discussions on Klipper. It allows users to chat with other users in real-time.
I have a question about Klipper
Many questions we receive are already answered in the Klipper documentation. Please be sure to to read the documentation and follow the directions provided there.
It is also possible to search for similar questions in the Klipper Community Forum.
If you are interested in sharing your knowledge and experience with other Klipper users then you can join the Klipper Community Forum or Klipper Discord Chat. Both are communities where Klipper users can discuss Klipper with other users.
Many questions we receive are general 3d-printing questions that are not specific to Klipper. If you have a general question or are experiencing general printing problems, then you will likely get a better response by asking in a general 3d-printing forum or a forum dedicated to your printer hardware.
I have a feature request
All new features require someone interested and able to implement that feature. If you are interested in helping to implement or test a new feature, you can search for ongoing developments in the Klipper Community Forum. There is also Klipper Discord Chat for discussions between collaborators.
Help! It doesn't work!
Unfortunately, we receive many more requests for help than we could possibly answer. Most problem reports we see are eventually tracked down to:
- Subtle errors in the hardware, or
- Not following all the steps described in the Klipper documentation.
If you are experiencing problems we recommend you carefully read the Klipper documentation and double check that all steps were followed.
If you are experiencing a printing problem, then we recommend carefully inspecting the printer hardware (all joints, wires, screws, etc.) and verify nothing is abnormal. We find most printing problems are not related to the Klipper software. If you do find a problem with the printer hardware then you will likely get a better response by searching in a general 3d-printing forum or in a forum dedicated to your printer hardware.
It is also possible to search for similar issues in the Klipper Community Forum.
If you are interested in sharing your knowledge and experience with other Klipper users then you can join the Klipper Community Forum or Klipper Discord Chat. Both are communities where Klipper users can discuss Klipper with other users.
I found a bug in the Klipper software
Klipper is an open-source project and we appreciate when collaborators diagnose errors in the software.
Problems should be reported in the Klipper Community Forum.
There is important information that will be needed in order to fix a bug. Please follow these steps:
- Make sure you are running unmodified code from https://github.com/Klipper3d/klipper. If the code has been modified or is obtained from another source, then you should reproduce the problem on the unmodified code from https://github.com/Klipper3d/klipper prior to reporting.
- If possible, run an
M112
command immediately after the undesirable event occurs. This causes Klipper to go into a "shutdown state" and it will cause additional debugging information to be written to the log file. - Obtain the Klipper log file from the event. The log file has been
engineered to answer common questions the Klipper developers have
about the software and its environment (software version, hardware
type, configuration, event timing, and hundreds of other
questions).
- The Klipper log file is located in
/tmp/klippy.log
on the Klipper "host" computer (the Raspberry Pi). - An "scp" or "sftp" utility is needed to copy this log file to
your desktop computer. The "scp" utility comes standard with
Linux and MacOS desktops. There are freely available scp
utilities for other desktops (eg, WinSCP). If using a graphical
scp utility that can not directly copy
/tmp/klippy.log
then repeatedly click on..
orparent folder
until you get to the root directory, click on thetmp
folder, and then select theklippy.log
file. - Copy the log file to your desktop so that it can be attached to an issue report.
- Do not modify the log file in any way; do not provide a snippet of the log. Only the full unmodified log file provides the necessary information.
- It is a good idea to compress the log file with zip or gzip.
- The Klipper log file is located in
- Open a new topic on the Klipper Community Forum and provide a clear description of the problem. Other Klipper contributors will need to understand what steps were taken, what the desired outcome was, and what outcome actually occurred. The compressed Klipper log file should be attached to that topic.
I am making changes that I'd like to include in Klipper
Klipper is open-source software and we appreciate new contributions.
New contributions (for both code and documentation) are submitted via Github Pull Requests. See the CONTRIBUTING document for important information.
There are several documents for developers. If you have questions on the code then you can also ask in the Klipper Community Forum or on the Klipper Community Discord.
Klipper github
Klipper github may be used by contributors to share the status of their work to improve Klipper. It is expected that the person opening a github ticket is actively working on the given task and will be the one performing all the work necessary to accomplish it. The Klipper github is not used for requests, nor to report bugs, nor to ask questions. Use the Klipper Community Forum or the Klipper Community Discord instead.