From FreeCAD Documentation
Revision as of 14:05, 29 August 2014 by Yorik (talk | contribs) (Marked this version for translation)
Jump to navigation Jump to search

This page attempts to answer the most common questions asked on the FreeCAD forums. If you have a problem or question regarding FreeCAD, check below first. Then, if you cannot find an answer for your specific question, head to the FreeCAD forum!



What is the easiest way to install FreeCAD on my system?

If you are on Windows or Mac OS, the simplest way is to head to the Download page, where you'll find several ready-to-install packages. If you are on Debian, Fedora or Ubuntu and some other distributions, FreeCAD is already included in the standard software repositories and you can simply install it with the software manager. On Ubuntu, the FreeCAD team also maintains its own PPA repositories. For further details about installation, refer to the Installing page.

What are the prerequisites for running FreeCAD?

In contrast to most 3D CAD software, FreeCAD can run smoothly on the most modest computers - it's been known to run on Pentium IV and Intel Core2 Solo CPUs. If your computer is running a current operating system, chances are FreeCAD will run. The only prerequisite is that your graphics card or chipset must support OpenGL, preferably no older than v2.0. In case of problems, refer to the Troubleshooting section of this FAQ.


FreeCAD's underlying geometric modeling kernel (which is a third-party library called Open CASCADE Technology, or OCC for short) does not support multithreading at this time.

For Mac users

Only the MacIntel architecture is supported. There are no builds available for the PowerPC architecture.

What if I want to compile FreeCAD myself?

The source code of FreeCAD is always available in the project source code repository. Compiling FreeCAD yourself allows you to use the most recent features being developed, but requires a bit of computer knowledge, although the procedure is fairly simple. Access to the source code is explained here, and we have detailed instructions for compiling on Windows, Linux and Mac OSX.

FreeCAD tells me some module or application is missing

FreeCAD depends on a lot of things to offer all its functionality. All the main required components are usually bundled within your FreeCAD installation or provided by your package manager, so normally you have nothing to worry about. If you installed FreeCAD from unofficial sources, however, or compiled FreeCAD yourself, some piece might be missing, which is not critical to FreeCAD itself, but might cause some functionality to be unavailable. Some specific file formats such as Collada or DWG also require extra components, which cannot be bundled into FreeCAD, and must be installed by yourself separately.

All those components and the appropriate way to install them are listed on the Extra python modules page.


FreeCAD doesn't start at all

There might be a lot of reasons for that, the most likely is that some library is missing. Try starting FreeCAD from a terminal (type freecad at a terminal prompt) to see if some error message appears. Also, read the rest of this FAQ as it can give you more clues to detect the cause of the problem. If nothing helps, tell about it on the forum, there will surely be someone who can help.

On some older Windows XP systems you may get an error message like this: The application can't start, because the side-by-side configuration is wrong. The reinstallation of the application may solve the problem. The reason for this problem is that on your system either the CRT runtime libraries are missing or the version installed is too old because FreeCAD was linked against a newer version. In this case you have to install the Microsoft Visual C++ Redistributable Package which you'll find at Microsoft. See also the corresponding forum message.

FreeCAD starts normally, but not all icons are displayed, some of them are replaced by a black 'X'

Some parts of FreeCAD depend on an external Python module called Pivy. On Windows, pivy is included in the FreeCAD installation. On Debian/Ubuntu systems, the python-pivy package is part of standard software repositories. On other systems, at the moment, you might have to compile pivy yourself. Note that although some tools are not available without pivy, the rest of FreeCAD works normally.

I have display problems, the 3D view doesn't behave correctly, there is garbage when I move/rotate the view, etc...

FreeCAD depends on OpenGL for displaying 3D contents, and therefore requires a working OpenGL environment. On some systems, OpenGL is not activated by default, and you might need to install or upgrade your graphics drivers. This problems happens most often on Linux systems or on virtual systems. If you are on a linux-based system, try the following steps:

  • verify that your computer has a 3D-capable graphic board
  • type glxinfo in a terminal window, and check in the output that Direct Rendering is set to "yes", and that the OpenGL vendor/renderer/version matches your graphic card.
  • install other OpenGl-based software ([Blender] for example) and check if it runs and displays correctly.

FreeCAD crashes on startup

A crash might indicate a more serious bug, or some problem in your configuration. Most startup crashes occur because of one of the two following reasons:

OpenGL drivers are not installed, or not working properly

This is a very common cause of problem. The symptoms are simply that FreeCAD crashes at startup, or whenever you open a 3D view (for example by creating a new document). Try to find out what your graphic chip is, then find out if it supports OpenGL (most recent chips do), then find the correct driver and install it. A good way to doublecheck if OpenGL is available is to try to run another OpenGL application such as blender.

And as a general tip to get some more information about crashes with FreeCAD you can start it with the program parameter --write-log. This will create the file FreeCAD.log in $HOME/.FreeCAD on Linux and Mac OS X or %APPDATA\FreeCAD% on Windows systems.

In some rare cases you may have a graphic driver installed that doesn't fit to your graphic card. We had a case where the user's laptop had an Intel on-board graphic but some ATI drivers were installed. [1] After removing the files and re-installing the correct driver FreeCAD started to work.

Some library, needed by FreeCAD, is not present on your system, or wasn't found by FreeCAD

There can be two declinations to this problem: either some library is simply missing, therefore FreeCAD will refuse to start, or the library is there, but it is an older version than the one FreeCAD expects, so a crash will occur when FreeCAD will try to use a missing feature from that library. A common example is when you have Qt3 and Qt4 installed on your system, FreeCAD might detect Qt4 but if your Qt installation is not properly configured, some pieces of Qt3 might still be used, provoking crashes.

Please review the installing procedure, make sure you installed all the required libraries (on most linux systems this is done automatically), and check what is the minimum version number for each of the components.

If everything seems correct, describe the problem on the forum or submit a bug. If you are on a linux system, it is easy to do a debug backtrace, which provides very useful information about the crash to the developers:

  • in a terminal, type: gdb freecad (assuming package gdb is installed)
  • inside gdb, type run
  • after the crash, type bt to get the backtrace, that you can include in your bug report.

FreeCAD freezes after startup

When starting FreeCAD the GUI appears almost immediately but the GUI is frozen and the cpu is about 99%. This can happen on the KDE desktop when using the Oxygen theme. That's a bug in the Oxygen theme and choosing another theme should fix this issue.

FreeCAD crashes on creating a new document or opening a file

If FreeCAD crashes when it creates a new 3D view, try launching FreeCAD from a terminal. If a message error appears when the crash occurs, mentioning "Assertion Failed" and a component name beginning with "So" (SoBase, SoFieldContainer, etc...), the chances are very high, especially if you are on linux, that FreeCAD tries to use two different versions of the coin library, which causes the crash. To verify if that is indeed the problem, try the following:

  • Locate the FreeCAD executable (usually in /usr/lib/FreeCAD/bin)
  • Run the command 'ldd FreeCAD' from a terminal
  • Note down the version of the libCoin.so library that FreeCAD is using (for example libCoin.so.60)
  • Locate the libSoQt.so library (usually in /usr/lib)
  • run 'ldd libSoQt.so' and check if it links to the same coin version as FreeCAD

If there is any difference, either FreeCAD or SoQt must be recompiled (better to recompile the one that uses the oldest Coin version). The normal behavior is to try to contact the persons responsible for packaging either SoQt or FreeCAD and kindly ask them to consider recompiling. If you want to undertake that step for yourself, and it is not possible to recompile SoQt because it breaks other applications on your system, you can force FreeCAD to compile with the required Coin version with ./configure --with-coin=DIR. But you have to make sure that the correct devel package to this Coin version is installed.

FreeCAD crashes after Edit -> Alignment

A segmentation fault happens at vbo_save_playback_vertex_list(). This means that the implementation of VBO of the graphic driver is bad. In order to avoid to cache OpenGL calls you can try to set the environment variable IV_SEPARATOR_MAX_CACHES=0 and restart FreeCAD.

I have trouble running FreeCAD on Mac OSX

The Mac platform is less easy to support than Windows or Linux, since none of the core developers owns one. The OSX packages are compiled by volunteering FreeCAD users, and they might sometimes not work correctly on your machine, depending on your system. Your best chance is probably to head to the forums, look for Mac OSX-related threads, and discuss your problem there or see if someone else encountered a solution.

I cannot change numeric values in FreeCAD's properties panels

language options

You most likely have bad windows regional settings set-up. Please check if you have same symbol for decimal separator and digit grouping symbol in your regional settings. If you do, adapt your system settings to use the different character for digit grouping symbol and decimal separator. Note that it is not mandatory to have dot as decimal separator. It is mandatory to use different symbols in this two settings.

FreeCAD was running normally, and suddenly it doesn't start anymore

This can also happen if you had an older version of FreeCAD installed, and you upgraded to a newer version. In that process, the configuration files of FreeCAD might have been corrupted for some reason, and now FreeCAD cannot read them anymore, and fails to start. The solution is simply to delete these configuration files, so FreeCAD will recreate them on first run.

  • On Windows: Open the file explorer, and write "%APPDATA%\FreeCAD" as the file path. Once there, delete the files user.cfg and system.cfg
  • On Linux & Mac: Navigate to "/home/USERNAME/.FreeCAD" and delete the files user.cfg and system.cfg

FreeCAD should now start again normally with all its settings reset.

Using FreeCAD

Is FreeCAD really free? Even for commercial use?

FreeCAD is open-source software, and is free not only to use, for yourself or for doing commercial work, but also to distribute, modify, or even use in a closed-source application. To review, you are free to do (almost) anything you want with it. See the Licence page for more details.

How do I rotate the 3D view?

FreeCAD has four different navigation modes available, that can be set in the preferences settings dialog or changed by right-clicking in the 3D view. For full details about the modes, see the Mouse Model page. For the default mode ("CAD Navigation"), the commands are as follows,

{{{Select_name}}} {{{Pan_name}}} {{{Zoom_name}}} {{{Rotate_view_name}}} {{{Rotate_view_alt_name}}}
Hand cursor.png Pan cursor.png Zoom cursor.png Rotate cursor.png Rotate cursor.png
Mouse LMB.svg Mouse MMB hold.svg Mouse MMB rotate.svg Mouse MMB+LMB hold.svg Mouse MMB+RMB hold.svg
{{{Select_text}}} {{{Pan_text}}} {{{Zoom_text}}} {{{Rotate_view_text}}} {{{Rotate_view_alt_text}}}
{{{Ctrl}}}+Mouse RMB.svg {{{Ctrl}}}+{{{Shift}}}+Mouse RMB.svg {{{Shift}}}+Mouse RMB.svg
{{{Pan_mode_text}}} {{{Zoom_mode_text}}} {{{Rotate_view_mode_text}}}

What can I do with FreeCAD? Where do I start?

Head to the Getting started page for a quick description of the tools you can use. There is also a new Tutorials section containing a few resources. The User hub section contains more detailed information about the different workbenches of FreeCAD. Note that since FreeCAD is relatively new, its user interface is still very bare and doesn't feature many tools. But much more advanced functionality is already available to you from python scripting.

Is there documentation for newcomers? How can I learn to use FreeCAD?

There is at the moment still little documentation for beginners, unfortunately, but the Tutorials section contains some pages to help you getting started.

Working with Part geometry

How do I extrude stuff into solids? I don't get the right result

The theory is simple: Lines (or wires), when extruded, form faces. Faces, when extruded, form solids. If you extrude something and the result is not a solid, then the something was not a face. If you have lines and you want to extrude a solid from them, you must first select lines that form a closed perimeter (select several objects by pressing CTRL), join them into a wire (Upgrade tool), then make a face from that wire (Upgrade tool again). There you are, if all went well you can now extrude it to a solid.

Now, there can be many little twists that make you obtain the wrong result. The best way to make sure is to check what's inside the object you are extruding. Objects contents can be easily explored with python. Assuming for example you have an object called "Wire", you could type this into the python console:

 obj = FreeCAD.ActiveDocument.Wire
 shp = obj.Shape
 print shp.Faces
 print shp.Wires
 if shp.Wires:
     for w in shp.Wires:
         print w.isClosed()

The above code retrieves the shape from an object, shows the faces and wires your object has (if any), and, if there are wires, prints if those wires are closed. If you don't have any face, you won't get a solid. If there is no closed wire, it won't become a face. If you are interested, there is more info about what you can check with python on the part scripting page. If you cannot join several lines into a wire, the most probable cause is that their endpoints don't meet, there must be small gaps between (some of) them. There, I'm afraid, my experience tells me the quickest way would be to redraw a wire on top of them...

My boolean operations fail, or give weird results

The Open CASCADE geometric modeling kernel used in FreeCAD for Part geometry, although probably the best open-source geometry kernel available, has its flaws and limitations. Indeed the boolean operations (fusion, subtraction, intersection) are not its best features, and often give strange results. This is a current limitation we have no way to solve at once, so your best path is to try obtaining the desired result by modeling another way. For example, problems with primitives such as cylinder can often be solved by using an extruded circle instead. Coplanar surfaces between parts can cause trouble, as well as surface tangency. As a general rule, if a shape doesn't work, try remodeling it a different way. In 99% of the cases at the end you will manage to obtain the result you want.

Contributing to FreeCAD

FreeCAD is such a great program! How can I help?

There are a lot of different ways to help, even if you are not a programmer. Here are a couple of things you can do:

  • Give some feedback to the FreeCAD developers: It is always useful to know what people think, what they found good, what they miss, etc. Drop a note on the forum giving your opinion or make a request on our issue tracker!
  • Help with writing documentation: The documentation we have here on this site is sometime very limited. If you discovered something that is not well documented, add your knowledge there!
  • Help others newcomers: Hang around the forum, and help new people to solve basic questions, like how do I install, how do I add a cube, etc...
  • Translate the documentation in your own language
  • Translate FreeCAD in your own language
  • Write Tutorials, or record video tutorials: Tutorials are a very easy way for newcomers to learn a new software. If you did some nice stuff, why not show other people how to do it?
  • Contribute with assets and examples: We still miss good example files in FreeCAD. If you created something good, share it with us!
  • Submit bugs: It is very important to have all the possible bugs fixed. If you find one, report it as clearly as possible, so we can understand exactly what's happening.
  • Try to do some python coding: You never programmed before but you want to try? Python is easy. Read our introduction to Python... But beware, you might get addicted quickly!
  • See the Help FreeCAD page for more details on how to contribute.

How can I get edit permission on the wiki?

See the Work on the documentation page paragraph for more details on how to contribute.

Does FreeCAD participate to the Google Summer of Code?

No. We are too few developers at the moment, and it would take us way too much time to do the admin work and monitor the students, we prefer to spend that time writing code instead.

I want to start translating the wiki in my own language. What do I do?

This wiki is hosting a lot of contents. The most up-to-date and interesting material is gathered in the manual.

See the Translate the documentation page paragraph for more details on how to translate the wiki.

Licensing, copying and reuse

Do I have to pay something to use FreeCAD?

No. FreeCAD is totally free to use, to download, to redistribute, or to modify. It is open-source software, published under the terms of 2 free software licenses (GPL and LGPL), which guarantee you those freedoms, and, even more important, guarantee you that these freedoms will never be taken from you.

Can I reuse any part of the FreeCAD artwork or pieces of the website?

Sure. All the artwork (icons, banners, etc...) of FreeCAD is LGPL, same as the FreeCAD code. Help yourself on the Artwork page. The website is a standard mediawiki site, all graphic elements can freely be reused, and if you are curious about how to tweak the mediawiki software like we did, look for the special Common css and js pages.

Can I reuse pieces of FreeCAD in another application?

Yes, with a few minor considerations because some parts of the code are LGPL while others are GPL, and the fact that the third-parties used by FreeCAD may have other conditions as well. More details on the Licence page.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎suomi • ‎svenska • ‎čeština • ‎русский • ‎中文(中国大陆)‎ • ‎한국어