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 e3f9035 commit b5476ce
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ jobs:
run: bash tools/download_blender.sh ${{ matrix.blender_version }} blender-bin

- name: Copy add-on to Blender add-on's directory
run: cp -r src/screencast_keys ~/.config/blender/${{ matrix.blender_version }}/extensions/user_default
run: |
mkdir -p ~/.config/blender/${{ matrix.blender_version }}/extensions/user_default
cp -r src/screencast_keys ~/.config/blender/${{ matrix.blender_version }}/extensions/user_default
- name: Run add-on unittest
run: blender-bin/blender-v${{ matrix.blender_version }}-bin/blender --factory-startup --background -noaudio --python tests/python/run_tests.py
Expand Down
38 changes: 36 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Before installing Screencast Keys add-on, check if

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

* [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 @@ -16,6 +17,7 @@ There are two ways to install Screencast Keys add-on.
|---|---|
|Unstable|4.2 -|
|3.14|2.80 - 4.1|
|3.14|2.80 - 4.1|
|3.13|2.80 - 4.1|
|3.12|2.80 - 4.0|
|3.11|2.80 - 3.6|
Expand All @@ -31,7 +33,14 @@ 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 only. You can't install the unstable*
*version by this method.*
*If you want to install the unstable version, follow
*[Manual Install](#manual-install) process*

## 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 @@ -63,6 +72,21 @@ 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
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
Expand Down Expand Up @@ -115,6 +139,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 b5476ce

Please sign in to comment.