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 6b0bfed commit bfcf095
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 12 deletions.
20 changes: 19 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,25 @@

# Change Log

## [Unreleased](https://github.com/nutti/Screencast-Keys/compare/v3.14.0...master)
## [Unreleased](https://github.com/nutti/Screencast-Keys/compare/v4.0.0...master)

<!-- markdownlint-disable-next-line MD013 -->
## [Version 4.0.0](https://github.com/nutti/Screencast-Keys/compare/v3.14.0...v4.0.0) - 2024.X.XX

### Notice

From this version, Screencast Keys add-on uses the 'MODAL_PRIORITY' option
to remove the dependency of the Blender internal structure.
Also, this add-on is available at [extensions.blender.org](https://extensions.blender.org/add-ons/screencast-keys/).

On the other hand, this add-on only supports Blender 4.2 or later from this
version.
If you continue this add-on on Blender 4.1 or before, use Version 3.14 series.

### Other Updates

* Publish at [extensions.blender.org](https://extensions.blender.org/add-ons/screencast-keys/).
* Remove "Get Event Aggressively" option

<!-- markdownlint-disable-next-line MD013 -->
## [Version 3.14.0](https://github.com/nutti/Screencast-Keys/compare/v3.13...v3.14.0) - 2024.4.21
Expand Down
6 changes: 6 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ add-on.
<!-- markdownlint-disable-next-line MD013 -->
### Failed to get event while the modal operation is running (e.g. G + X, S + Y, ...)

* Version 4.0 or later

This issue is completely fixed and *Get Event Aggressively* option is removed.

* Before Version 3.14

Try to enable the experimental option *Get Event Aggressively*.
This option enables you to get events even if the modal operation is running.

Expand Down
10 changes: 7 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Before installing Screencast Keys add-on, check if

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

* [Blender's Installation Tool]
* [Blender's Installation Tool](#blenders-installation-tool) *(Recommended)*
* [Manual Install](#manual-install)

Expand All @@ -15,6 +16,7 @@ There are two ways to install Screencast Keys add-on.
|Version|Supported Blender Version|
|---|---|
|Unstable|4.2 -|
|4.0|4.2 -|
|3.14|2.80 - 4.1|
|3.13|2.80 - 4.1|
|3.12|2.80 - 4.0|
Expand All @@ -31,7 +33,7 @@ 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 ()

*This method works for the stable version only. You can't install the unstable*
*version by this method.*
Expand All @@ -43,6 +45,7 @@ There are two ways to install Screencast Keys add-on.

|Version|Download URL|
|---|---|
|4.0|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v4.0.0)|
|3.14|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v3.14.0)|
|3.13|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v3.13)|
|3.12|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v3.12)|
Expand Down Expand Up @@ -81,7 +84,8 @@ The name of add-on displayed in Blender is **Screencast Keys**.
|Version|Download URL|
|---|---|
|*unstable*|[Download](https://github.com/nutti/Screencast-Keys/archive/master.zip)|
|3.14|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v3.14)|
|4.0|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v4.0.0)|
|3.14|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v3.14.0)|
|3.13|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v3.13)|
|3.12|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v3.12)|
|3.11|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v3.11)|
Expand All @@ -107,7 +111,7 @@ Add-on sources are located on the different places depending on the add-on versi
|Version|Sources|
|---|---|
|unstable|src/screencast_keys|
|3.1 - 3.14|screencast_keys|
|3.1 - 4.0|screencast_keys|
|3.0|screencastkeys|

#### 3. Copy add-on sources into your add-on folder
Expand Down
8 changes: 0 additions & 8 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,14 +172,6 @@ You can change the display mode from **Mode** option.

![Option (Show Last Operators)](images/tutorial/option_show_last_operators.png)

### Get Event Aggressively

*NOTE: This is an experimental option. If this option is enabled, Blender may*
*be crashed in the specific environment.*

If **Get Event Aggressively** option is enabled, the events raised in the modal
status will also be displayed.

### Auto Save

*NOTE: This is an experimental option. If this option is enabled, Blender may*
Expand Down

0 comments on commit bfcf095

Please sign in to comment.