<?xml version='1.0' encoding='utf-8' ?>
<?xml-stylesheet type="text/xsl" href="header_e.xsl" ?>
<body PageTitle="How to register a Blender add-on" PageHeader="Plugins" Created="2011-07-16" Updated="2019-10-29"  FName="scripts-251">
<br/>
<div>
<p>
Many Blender Python scripts are prepared in a special way, which allows them to appear in 
the Blender menus or panels. They are called add-ons. Usually such scripts are created for the wider audience of users. 
Blender comes with a range of registered add-ons, ready to activate. You can still extend your personal subset of these tools by adding a new plugin.
<br/>
It is very easy to incorporate them into your environment. Just:
</p>
<ol type="1">
	<li>download a particular add-on from any Internet source. Usually, it is a single Python (*.py) file, sometimes packed (into *.zip file);</li>
	<li>unpack it, when the plugin is downloaded as a *.zip file;</li>
	<li>place the *.py file in the <b>scripts\addons</b> folder, located in the Blender configuration directory;</li>
</ol>
<p>
<span>The Blender configuration directory is stored in the current user home directory. You can find it typing in the file explorer address bar:</span><br/>
	<li>%AppData%\Blender Foundation\Blender\2.8x</li>
	<br/><span>where "2.8x" means your Blender version.</span>
</p>
<p>For example, for Blender <b>2.80</b>, installed in <b>Windows 10</b>, user named <b>me</b>, the folder where you should place the add-on file is:<br/>  
C:\Users\me\AppData\Roaming\Blender Foundation\Blender\2.80\scripts\addons
</p>
<p>Initially, the <b>scripts\addons</b> directory does not exist. You can create it there.</p>
</div>
<br/>
<div class="subheader">Installing an add-on using Blender commands</div>
<divf>
<p>
If you cannot find your user configuration directories, you still can do the same using Blender commands. 
It may happen that in the future the structure of Blender folders will change. 
Thus this is the safer way:
</p>
<p>
<span>Open the Blender <b>Preferences Window</b> (<b>Edit->Preferences…</b>). 
Select the <b>Add-ons</b> tab there (Fig. 1):</span>
<br/>
<table cellSpacing="0" cellPadding="0pt" align="center">
	<tr align="center" valign="top">
		<td>
				<IMG class="image500"  src="images/scripts/251/image01_e.png" align="center"/>
		</td>
	</tr>
	<tr align="center" valign="top">
		<td><spanl>Fig. 1. The list of currently registered add-ons.</spanl></td>
	</tr>
</table>
</p>
</divf>
<divf>
<p>
<span>Click the <b>Install…</b> button, located on the “header”, at the bottom of the window. 
It will open the file selection area (Fig 2):</span>
<br/>
<table cellSpacing="0" cellPadding="0pt" align="center">
	<tr align="center" valign="top">
		<td>
				<IMG class="image500"  src="images/scripts/251/image02_e.png" align="center"/>
		</td>
	</tr>
	<tr align="center" valign="top">
		<td><spanl>Fig. 2. Selection of the add-on file.</spanl></td>
	</tr>
</table>
</p>
</divf>
<divf>
<p>
<span>Select the *.py file of the add-on. (You can select only one file, here). 
Then click the <b>Install Add-on from File…</b> button. It will bring you back to the <b>Add-ons</b> tab (Fig. 3)</span>
<br/>
<table cellSpacing="0" cellPadding="0pt" align="center">
	<tr align="center" valign="top">
		<td>
				<IMG class="image850"  src="images/scripts/251/image03_e.png" align="center"/>
		</td>
	</tr>
	<tr align="center" valign="top">
		<td><spanl>Fig. 3. New add-on just after registration.</spanl></td>
	</tr>
</table>
</p>
</divf>
<divf/>
<br/>
<div class="subheader">Notes on Blender upgrades</div>
<divf>
<p>
<span>Each Blender version creates its own user configuration subdirectory. 
Just look at the <b>Blender Foundation\Blender</b> folder (Fig. 4):</span>
<br/>
<table cellSpacing="0" cellPadding="0pt" align="center">
	<tr align="center" valign="top">
		<td>
				<IMG class="image640" style="max-width:581px;" src="images/scripts/251/image04_e.png" align="center"/>
		</td>
	</tr>
	<tr align="center" valign="top">
		<td><spanl>Fig. 4. Exemplary content of user configuration folder.</spanl></td>
	</tr>
</table>
</p>
</divf>
<divf>
<p>
<span>Fortunately, you do not have to copy the <b>scripts\addons</b> folder after every Blender upgrade. 
On the first run of new Blender version, it displays an important button on its splash screen (Fig. 5):</span>
<br/>
<table cellSpacing="0" cellPadding="0pt" align="center">
	<tr align="center" valign="top">
		<td>
				<IMG class="image640" style="max-width:588px;" src="images/scripts/251/image05_e.png" align="center"/>
		</td>
	</tr>
	<tr align="center" valign="top">
		<td><spanl>Fig. 5. Splash screen on the first run of new Blender version.</spanl></td>
	</tr>
</table>
</p>
</divf>
<divf>
<p>
Use <b>Copy Previous Settings</b> command to preserve your settings (drawing defaults, add-ons) 
from the previous Blender version. Blender displays it when it finds that the configuration directory for the current version 
does not exists, yet.
</p>
</divf>
</body>
