Difference between revisions of "Documentation/Tools/SCS Blender Tools/Installation"

From SCS Modding Wiki
Jump to navigation Jump to search
(Blender/Tools compatibility)
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
SCS Blender Tools v2.0 introduces easier download & installation!
+
{{Note|<br>Blender Version [https://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.78 2.78] is compatible with Blender Tools V1.11<br>Blender Version [https://wiki.blender.org/index.php/Dev:Ref/Release_Notes/2.79 2.79] is compatible with Blender Tools V1.10 only(!)}}
 +
<!-- https://forum.scssoft.com/viewtopic.php?f=162&t=245065&hilit=invalid&start=170#p844784 -->
  
{{Note|For legacy SCS Blender Tools versions (< 2.0), please refer to old installation page: [[Special:PermanentLink/4074|here]].}}
+
Before installation make sure you have downloaded SCS Blender Tools from the [[Documentation/Tools/SCS Blender Tools/Download|Download]] page or via cloning the [https://github.com/SCSSoftware/BlenderTools GIT repository].
  
=== 1. Download SCS Blender Tools add-on ===
+
=== 1. Copying Files ===
  
Before installation download latest add-on: [https://github.com/SCSSoftware/BlenderTools/releases/latest/download/scs_blender_tools_addon.zip scs_blender_tools_addon.zip]
+
All the files needed for tools installation are contained in a single folder named &quot;addon/io_scs_tools&quot;. This folder must be placed in a location, where Blender can find it and read it as an Addon. It is possible to use an installation method, where you can just point Blender to the Addon location (e.g. if you want to run the tools right from GIT repository).
  
{{Note|Above link provides latest version, legacy versions and sample data can be found on [[Documentation/Tools/SCS Blender Tools/Download|Download]] page.}}
+
You can use one the following installation possibilities:
  
=== 2. Install... ===
+
# '''LOCAL INSTALLATION (recommended):''' Place the folder &quot;addon/io_scs_tools&quot; to your installation of Blender to the location &quot;/<Blender_installation>/<version_number>/scripts/addons/&quot;. The Addon will be used only by this particular installation of Blender.
 +
# '''GLOBAL INSTALLATION:''' Place the folder &quot;addon/io_scs_tools&quot; in your profile to the location &quot;/<user_profile>/blender/<version_number>/scripts/addons/&quot; (under Windows that would be <tt>%USERPROFILE%\AppData\Roaming\Blender Foundation\Blender\<version>\scripts\addons</tt>). Addon will be used by any Blender installation of specified version.
 +
# '''INSTALLATION TO THE USER DIRECTORY:''' In &quot;User Preferences&quot; within &quot;File&quot; section is the &quot;Scripts&quot; item where you can set the path to any Addon location. This way, for example, you can use any Addon directly from data repository and your tools will always be of the current version in all of your Blender installations. It is necessary for the Addon folder to be placed inside a folder named &quot;addons_contrib&quot; and Blender needs to be directed to its parent folder. Therefore the resulting path to the folder Addons should look like &quot;/<folder>/addons_contrib/io_scs_tools&quot;, but the path under Scripts will be only &quot;/<folder>&quot;.
 +
#: [[File:Blender_custom_location_for_Scripts.png]]
 +
# '''INSTALL FROM FILE:''' Tools can also be installed using the &quot;Install from File...&quot; button, which you can find in &quot;User Preferences&quot; in the &quot;Addons&quot; section on the bottom bar.
  
Run Blender, access it's preferences (''Edit -> Preferences'') and switch to ''Add-ons'' tab. Then use {{Blender_Button| Install...}} button and search for '''scs_blender_tools_addon.zip''' you downloaded in step one.
+
=== 2. Addon Activation ===
  
=== 3. Add-on Activation ===
+
Now it is necessary to activate the &quot;SCS Blender Tools&quot; Addon. This can be easily done in the &quot;User Preferences&quot; in the &quot;Addons&quot; section. In the upper left part of the window click on &quot;Testing&quot; button and in the main window, look for the &quot;Import-Export: SCS Tools&quot;. You can use search feature to locate the item. Now activate the checkbox on the right side of SCS Tools entry. If the item is missing in your list, press F8 to reload Addons.
  
Now it is necessary to activate the SCS Blender Tools add-on. While still on ''Add-ons'' preferences tab, search for add-on by typing 'SCS' into search bar and look for "Import-Export: SCS Tools". Now activate the checkbox on the left side of SCS Tools entry.
+
[[File:Blender_enable_SCS_Tools_Addon.png]]
 
 
If the item is missing in your list, try to pressing F8 to reload add-ons.
 
 
 
[[File:Blender_enable_SCS_Tools_Addon_2_8.png]]
 

Revision as of 20:11, 7 June 2018

Note:
Blender Version 2.78 is compatible with Blender Tools V1.11
Blender Version 2.79 is compatible with Blender Tools V1.10 only(!)

Before installation make sure you have downloaded SCS Blender Tools from the Download page or via cloning the GIT repository.

1. Copying Files

All the files needed for tools installation are contained in a single folder named "addon/io_scs_tools". This folder must be placed in a location, where Blender can find it and read it as an Addon. It is possible to use an installation method, where you can just point Blender to the Addon location (e.g. if you want to run the tools right from GIT repository).

You can use one the following installation possibilities:

  1. LOCAL INSTALLATION (recommended): Place the folder "addon/io_scs_tools" to your installation of Blender to the location "/<Blender_installation>/<version_number>/scripts/addons/". The Addon will be used only by this particular installation of Blender.
  2. GLOBAL INSTALLATION: Place the folder "addon/io_scs_tools" in your profile to the location "/<user_profile>/blender/<version_number>/scripts/addons/" (under Windows that would be %USERPROFILE%\AppData\Roaming\Blender Foundation\Blender\<version>\scripts\addons). Addon will be used by any Blender installation of specified version.
  3. INSTALLATION TO THE USER DIRECTORY: In "User Preferences" within "File" section is the "Scripts" item where you can set the path to any Addon location. This way, for example, you can use any Addon directly from data repository and your tools will always be of the current version in all of your Blender installations. It is necessary for the Addon folder to be placed inside a folder named "addons_contrib" and Blender needs to be directed to its parent folder. Therefore the resulting path to the folder Addons should look like "/<folder>/addons_contrib/io_scs_tools", but the path under Scripts will be only "/<folder>".
    Blender custom location for Scripts.png
  4. INSTALL FROM FILE: Tools can also be installed using the "Install from File..." button, which you can find in "User Preferences" in the "Addons" section on the bottom bar.

2. Addon Activation

Now it is necessary to activate the "SCS Blender Tools" Addon. This can be easily done in the "User Preferences" in the "Addons" section. In the upper left part of the window click on "Testing" button and in the main window, look for the "Import-Export: SCS Tools". You can use search feature to locate the item. Now activate the checkbox on the right side of SCS Tools entry. If the item is missing in your list, press F8 to reload Addons.

Blender enable SCS Tools Addon.png