Skip to content

Commit

Permalink
Update: Documents for Version 4.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
nutti committed Oct 5, 2024
1 parent 9ca5fe4 commit 2b507cb
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 9 deletions.
19 changes: 18 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,24 @@

# Change Log

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

<!-- markdownlint-disable-next-line MD013 -->
## [Version 4.1.0](https://github.com/nutti/Screencast-Keys/compare/v4.0.0...v4.1.0) - 2024.10.5

### Notice

We found a way to coexist with the old Blender specific code.
From this version, this add-on supports Blender 2.8 to 4.1 again which drops
at Version 4.0.

### Other Updates

* Fix bugs

### Contributors

* [**@Andrej730**](https://github.com/Andrej730)

<!-- markdownlint-disable-next-line MD013 -->
## [Version 4.0.1](https://github.com/nutti/Screencast-Keys/compare/v4.0.0...v4.0.1) - 2024.9.29
Expand Down
4 changes: 2 additions & 2 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ 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
* Blender 4.2 or later

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

* Before Version 3.14
* Blender 4.1 or before

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
15 changes: 9 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ There are 3 ways to install Screencast Keys add-on.

|Version|Supported Blender Version|
|---|---|
|Unstable|4.2 -|
|4.0|4.2 -|
|Unstable|2.80 -|
|4.1|2.80 -|
|4.0|4.2 - 4.2|
|3.14|2.80 - 4.1|
|3.13|2.80 - 4.1|
|3.12|2.80 - 4.0|
Expand All @@ -36,7 +37,7 @@ There are 3 ways to install Screencast Keys add-on.

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

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

<!-- markdownlint-disable-next-line MD013 -->
Expand All @@ -60,6 +61,7 @@ You can install this add-on from there.

|Version|Download URL|
|---|---|
|4.1|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v4.1.0)|
|4.0|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v4.0.1)|
|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)|
Expand Down Expand Up @@ -94,7 +96,7 @@ or,
1. Launch Blender.
2. Drag and drop the downloaded .zip file to Blender.

##### Before Blender 4.1
##### Blender 4.1 or before

1. Launch Blender and open the preference window by clicking *Edit* >
*Preferences ...*.
Expand All @@ -114,6 +116,7 @@ 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)|
|4.1|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v4.1.0)|
|4.0|[Download](https://github.com/nutti/Screencast-Keys/releases/tag/v4.0.1)|
|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)|
Expand Down Expand Up @@ -141,7 +144,7 @@ Add-on sources are located on the different places depending on the add-on versi
|Version|Sources|
|---|---|
|unstable|src/screencast_keys|
|3.1 - 4.0|screencast_keys|
|3.1 - 4.1|screencast_keys|
|3.0|screencastkeys|

#### 3. Copy add-on sources into your add-on folder
Expand All @@ -157,7 +160,7 @@ If the folder does not exist in your environment, make it in advance.
|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
##### Blender 4.1 or before

|OS|Location|
|---|---|
Expand Down
11 changes: 11 additions & 0 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,17 @@ 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 option is available for Blender 4.1 or before. For Blender 4.2 or*
*later, all events can be collected without this option.*

*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 2b507cb

Please sign in to comment.