Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
nutti committed Jul 21, 2024
1 parent af956a0 commit 1588873
Showing 1 changed file with 40 additions and 5 deletions.
45 changes: 40 additions & 5 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
Before installing Screencast Keys add-on, check if
[the add-on version](#support-version) supports on the your Blender version.

There are two ways to install Screencast Keys add-on.
There are 3 ways to install Screencast Keys add-on.

* [Blender's Installation Tool]
* [Blender's Installation Tool](#blenders-installation-tool) *(Recommended)*
* [Blender's Installation Tool (from extensions.blender.org)](#blenders-installation-tool-from-extensions-blender-org) *(Recommended)*
* [Blender's Installation Tool (from Disk)](#blenders-installation-tool-from-disk)
* [Manual Install](#manual-install)

## Support Version
Expand All @@ -33,7 +33,17 @@ There are two ways to install Screencast Keys add-on.
|3.1|2.79 - 2.82|
|3.0|2.79 - 2.80|

## Blender's Installation Tool ()
## Blender's Installation Tool (from extensions.blender.org)

*This method works for the stable version whose version is 4.0 or later.*
*If you want to install the older version, follow other processes*

1. Launch Blender and open the preference window by clicking *Edit* >
*Preferences ...*.
2. Click *Get Extensions* in the preference window.
3. Search **Screencast Keys** and click *Install* button.

## Blender's Installation Tool (from Disk)

*This method works for the stable version only. You can't install the unstable*
*version by this method.*
Expand Down Expand Up @@ -66,9 +76,24 @@ There are two ways to install Screencast Keys add-on.

Follow below process.

* **Blender 4.2 or later**

1. Launch Blender and open the preference window by clicking *Edit* >
*Preferences ...*.
2. Click *Add-ons* in the preference window
2. Click *Add-ons* in the preference window.
3. Click down arrow button on the upper-right of window, and click
*Install from Disk...* and select the downloaded .zip file.

or,

1. Launch Blender.
2. Drag and drop the downloaded .zip file to Blender.

* **Before Blender 4.1**

1. Launch Blender and open the preference window by clicking *Edit* >
*Preferences ...*.
2. Click *Add-ons* in the preference window.
3. Click *Install...* and select the downloaded .zip file.

#### 3. Enable add-on
Expand Down Expand Up @@ -119,6 +144,16 @@ Add-on sources are located on the different places depending on the add-on versi
The location of the add-on folder depends on your operating system.
If the folder does not exist in your environment, make it in advance.

* **Blender 4.2 or later**

|OS|Location|
|---|---|
|Windows|`C:\Users\<username>\AppData\Roaming\Blender Foundation\Blender\<blender_version>\extensions\user_default`|
|Mac|`/Users/<username>/Library/Application Support/Blender/<blender_version>/extensions/user_default`|
|Linux|`/home/<username>/.config/blender/<blender_version>/extensions/user_default`|

* **Before Blender 4.1**

|OS|Location|
|---|---|
|Windows|`C:\Users\<username>\AppData\Roaming\Blender Foundation\Blender\<blender_version>\scripts\addons`|
Expand Down

0 comments on commit 1588873

Please sign in to comment.