diff --git a/src/blenderbim/docs/devs/installation.rst b/src/blenderbim/docs/devs/installation.rst index 9423426c75..cd38b66c3f 100644 --- a/src/blenderbim/docs/devs/installation.rst +++ b/src/blenderbim/docs/devs/installation.rst @@ -253,30 +253,3 @@ Required static assets are: bim/data/gantt/jsgantt.js (from jsgantt-improved) bim/data/gantt/jsgantt.css (from jsgantt-improved) - - -Troubleshooting -------------------------- - -Sometimes other Blender plugins will interfere, and cause bugs with BlenderBIM. - -To troubleshoot, it is suggested to temporarily remove (rename) the folder with -all the plugins. Depending on your OS, it could be located in one of the following locations -:: - - - Windows - - USER: %USERPROFILE%\AppData\Roaming\Blender Foundation\Blender\2.79\ - - SYSTEM: %USERPROFILE%\AppData\Roaming\Blender Foundation\Blender\2.79\ - - macos - - USER: /Users/$USER/Library/Application Support/Blender/2.79/ - - SYSTEM: /Library/Application Support/Blender/2.79/ - - Linux - - USER: $HOME/.config/blender/2.79/ - - SYSTEM: /usr/share/blender/2.79/ - -After renaming the folder try a fresh BlenderBIM reinstall and then test to see if the same -problem exists. Similarly, you can rename individual plugin folder to conduct a trail and error to -determine which plugin, specifically, is causing the problem. - -If the same problem persists, to reenable all your plugins, simply undo the folder name change you did above. -You will also want to delete the newly created folder which contains the version of BlenderBIM you just installed. \ No newline at end of file diff --git a/src/blenderbim/docs/users/installation.rst b/src/blenderbim/docs/users/installation.rst index cc6c7137f8..9f99e358a0 100644 --- a/src/blenderbim/docs/users/installation.rst +++ b/src/blenderbim/docs/users/installation.rst @@ -56,35 +56,52 @@ You can enable add-ons permanently by using ``Save User Settings`` from the Addo If you are a poweruser, you may be interested in the **Unstable installation** to help with testing. :doc:`Read more <../devs/installation>` +.. _where is the add-on installed: + Where is the add-on installed? ------------------------------ +Upon installation, the BlenderBIM Add-on is stored in the +``scripts/addons/blenderbim/`` directory, within your Blender configuration +folder. However, the location of your Blender configuration folder depends on +how you have installed Blender. + If you downloaded Blender as a ``.zip`` file without running an installer, you -will find the BlenderBIM Add-on installed in the following directory, where +will find the Blender configuration folder in the following directory, where ``X.XX`` is the Blender version: :: - /path/to/blender/X.XX/scripts/addons/ + /path/to/blender/X.XX/ -Otherwise, if you installed Blender using an installation package, the add-ons -folder depends on which operating system you use. On Linux: +Otherwise, if you installed Blender using an installation package, the Blender +configuration folder depends on which operating system you use. + +On Linux, if you are installing the add-on as a user: :: - ~/.config/blender/X.XX/scripts/addons/ + ~/.config/blender/X.XX/ -On Mac: +On Linux, if you are deploying the add-on system-wide (this may also depend on +your Linux distribution): +:: + + /usr/share/blender/X.XX/ + +On Mac, if you are installing the add-on as a user: :: /Users/{YOUR_USER}/Library/Application Support/Blender/X.XX/ +On Mac, if you are deploying the add-on system-wide: + +:: + + /Library/Application Support/Blender/X.XX/ + On Windows: :: - C:\Users\{YOUR_USER}\AppData\Roaming\Blender Foundation\X.XX\scripts\addons - -Upon installation, the BlenderBIM Add-on is stored in the ``blenderbim/`` -directory. - + C:\Users\{YOUR_USER}\AppData\Roaming\Blender Foundation\X.XX\ Updating -------- @@ -125,3 +142,18 @@ FAQ Our latest package which uses IfcOpenShell v0.7.0 is built using Ubuntu 20 LTS. If you have an older Ubuntu version, you can either upgrade to 19.10 or above, or you'll need to compile IfcOpenShell yourself. + +3. **Some other error prevents me from installing or doing basic functions with + the add-on. Is it specific to my environment?** + + Sometimes it is helpful to try installing and using the BlenderBIM Add-on on + a "clean environment". A clean environment is defined as a fresh Blender + installation with no other add-ons enabled with factory settings. + + To quickly test in a clean environment, find your Blender configuration + folder based on the `where is the add-on installed`_ section. Rename the + folder from ``X.XX`` to something else like ``X.XX_backup``, then restart + Blender and try follow the installation instructions again. + + If this fixes your issue, consider disabling other add-ons one by one until + you find a conflict as a next step to isolating the issue.