Skip to content

Commit d96a914

Browse files
committed
Improvements to documentation:
- Remove Gap and Remove All Gaps - Max limits on scale x/y and shear x/y - Updated Blender min version to 4.1 and updated doc references - Added Fuse library requirement for AppImage and AppImage launcher instructions - Mentioned High DPI monitor support, and troubleshooting steps and link to our wiki - Described 3 included themes
1 parent 9b75d14 commit d96a914

File tree

9 files changed

+114
-15
lines changed

9 files changed

+114
-15
lines changed

doc/clips.rst

+20-2
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,22 @@ Here is a list of all methods for cutting and/or trimming clips in OpenShot:
8888

8989
Keep in mind that the above cutting methods also have :ref:`keyboard_shortcut_ref`, to save even more time.
9090

91+
Remove Gap
92+
""""""""""
93+
The :guilabel:`Remove Gap` context menu option deletes the gap between two clips on the timeline, shifting all subsequent clips to close the gap.
94+
Right click on a gap between clips to find this option. The option is only available when a gap is detected.
95+
96+
- **Usage Example:** Use this option when you want to quickly eliminate a specific gap between clips caused by trimming or the razor tool.
97+
- **Tip:** If you have many gaps on a single track, you can also right click on the track name, and select :guilabel:`Remove All Gaps`.
98+
99+
Remove All Gaps
100+
"""""""""""""""
101+
The :guilabel:`Remove All Gaps` context menu option removes all gaps between clips on the timeline, shifting all clips to ensure there are no empty spaces.
102+
Right click on a track name to find this option. The option is only available when gaps are detected.
103+
104+
- **Usage Example:** Ideal for tracks that contain back-to-back clips, such as a photo slideshow, where no gaps are desired.
105+
- **Tip:** Review the entire track after using this option to ensure that no clips are unintentionally moved.
106+
91107
.. _clip_presets_ref:
92108

93109
Context Menu
@@ -513,7 +529,8 @@ of the screen, without adding any black bars on the edges. The scale methods are
513529
Scale X and Scale Y
514530
"""""""""""""""""""
515531
The :guilabel:`Scale X` and :guilabel:`Scale Y` properties are key-frame curves that represent horizontal and vertical scaling in percentages,
516-
respectively. The range for these curves is 0 to 1. See :ref:`clip_transform_ref`.
532+
respectively. The range for these curves is 0 to 1. See :ref:`clip_transform_ref`. OpenShot limits the max scale values based
533+
on the file type and the project size, to prevent crashes and performance issues.
517534

518535
- **Usage Example:** Creating a zoom-in effect by animating the Scale X and Scale Y curves simultaneously.
519536
- **Tip:** Scale the image larger than the screen, only revealing a portion of the video. This is a simple way to crop a portion of the video.
@@ -523,7 +540,8 @@ respectively. The range for these curves is 0 to 1. See :ref:`clip_transform_ref
523540
Shear X and Shear Y
524541
"""""""""""""""""""
525542
The :guilabel:`Shear X` and :guilabel:`Shear Y` properties are key-frame curves that represent X and Y shear
526-
angles in degrees, respectively. See :ref:`clip_transform_ref`.
543+
angles in degrees, respectively. See :ref:`clip_transform_ref`. OpenShot limits the max shear values based
544+
on the file type and the project size, to prevent crashes and performance issues.
527545

528546
- **Usage Example:** Adding a dynamic tilt effect to a clip by animating the shear angles.
529547
- **Tip:** Use shear properties for creating slanted or skewed animations.

doc/images/themes.jpg

256 KB
Loading

doc/images/timeline.jpg

63.9 KB
Loading

doc/installation.rst

+32-7
Original file line numberDiff line numberDiff line change
@@ -90,24 +90,49 @@ and creating a launcher for it, see our
9090

9191
.. image:: images/linux-appimage-permissions.jpg
9292

93+
Unable to Launch AppImage?
94+
~~~~~~~~~~~~~~~~~~~~~~~~~~
95+
Please verify that the ``libfuse2`` library is installed, which is required to mount and read an AppImage.
96+
On newer versions of Ubuntu (i.e. 22.04+), ``libfuse2`` is not installed by default. You can install it with
97+
the following command:
98+
99+
.. code-block:: console
100+
101+
sudo apt install libfuse2
102+
103+
Install AppImage Launcher
104+
~~~~~~~~~~~~~~~~~~~~~~~~~
105+
If you plan on using OpenShot often, you will probably want an integrated launcher for our AppImage.
106+
We recommend using AppImageLauncher, which is the officially supported way to launch (and manage) AppImage files on
107+
your Linux desktop. If you are on a Debian-based distro (Ubuntu, Mint, etc...), there is an official
108+
AppImageLauncher PPA:
109+
110+
.. code-block:: console
111+
112+
sudo add-apt-repository ppa:appimagelauncher-team/stable
113+
sudo apt update
114+
sudo apt install appimagelauncher
115+
93116
Linux (PPA)
94117
^^^^^^^^^^^
95118

96119
For Debian-based Linux distributions (Ubuntu, Mint, etc...), we also have a PPA
97120
(Personal Package Archive), which adds our official OpenShot software repository to your package
98121
manager, making it possible to install our latest version, without relying on our AppImages.
99122

100-
.. code-block:: console
123+
Stable PPA (Contains only official releases)
124+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
101125

102-
:caption: Stable PPA (Contains only official releases)
126+
.. code-block:: console
103127
104128
sudo add-apt-repository ppa:openshot.developers/ppa
105129
sudo apt update
106130
sudo apt install openshot-qt python3-openshot
107131
108-
.. code-block:: console
132+
Daily PPA (Highly experimental and unstable, for testers)
133+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109134

110-
:caption: Daily PPA (Highly experimental and unstable, for testers)
135+
.. code-block:: console
111136
112137
sudo add-apt-repository ppa:openshot.developers/libopenshot-daily
113138
sudo apt update
@@ -136,21 +161,21 @@ projects first (\*.osp files). Please see :ref:`preferences_reset_ref` for instr
136161
the previous ``openshot.settings`` file (for a clean install with **default preferences**).
137162

138163
Windows
139-
-------
164+
~~~~~~~
140165

141166
#. Open **Control Panel** from the Start menu
142167
#. Click on **Programs and Features**
143168
#. Select OpenShot Video Editor, then click **Uninstall**
144169

145170
Mac
146-
---
171+
~~~
147172

148173
#. Open **Finder** and go to **Applications**
149174
#. Drag the OpenShot Video Editor icon to the **Trash** in the Dock
150175
#. Right-click **Trash** and choose **Empty Trash**
151176

152177
Ubuntu (Linux)
153-
--------------
178+
~~~~~~~~~~~~~~
154179

155180
#. Open up **Files**
156181
#. Locate the ``*.AppImage`` and delete the file

doc/introduction.rst

+1
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Features
5757
- **JSON project format** (`OpenShot Cloud API <https://www.openshot.org/cloud-api/>`_ compatible)
5858
- **Customizable shortcuts**
5959
- **Translations** (100+ languages)
60+
- **High DPI** monitor support
6061
- **Community support** (`Visit our forum <https://openshot.org/forum/>`_)
6162

6263
Screenshot

doc/main_window.rst

+46-1
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ For example, imagine a 3 track video project
8888
Timeline Toolbar
8989
----------------
9090

91+
.. image:: images/timeline.jpg
92+
9193
.. table::
9294
:widths: 20 73
9395

@@ -124,7 +126,7 @@ Shortcut Action
124126
:kbd:`Ctrl+B` Animated Title
125127
:kbd:`Ctrl+Up` Center on Playhead
126128
:kbd:`Ctrl+P` Choose Profile
127-
:kbd:`Ctrl+Shift+ESC` Clear All Cache
129+
:kbd:`Ctrl+Shift+ESC` Clear All Cache (regenerate video preview)
128130
:kbd:`Ctrl+C` Copy
129131
:kbd:`Delete` Delete Item
130132
:kbd:`Backspace` Delete Item (Alternate 1)
@@ -279,3 +281,46 @@ exit the program. Re-launching OpenShot will restore your custom dock layout aut
279281
If you have accidentally closed or moved a dock and can no longer find it, there are a couple easy solutions.
280282
First, you can use the :guilabel:`View->Views->Simple View` menu option at the top of the screen, to restore the view back to its
281283
default. Or you can use the :guilabel:`View->Views->Docks->...` menu to show or hide specific dock widgets on the main window.
284+
285+
High DPI / 4K Monitors
286+
----------------------
287+
288+
OpenShot Video Editor provides robust support for High DPI (Dots Per Inch) monitors, ensuring that the interface looks
289+
sharp and is easily readable on displays with various DPI settings. This support is particularly beneficial for users
290+
with 4K monitors or other high-resolution displays.
291+
292+
Per Monitor DPI Awareness
293+
^^^^^^^^^^^^^^^^^^^^^^^^^
294+
295+
OpenShot is DPI aware on a per-monitor basis, meaning it can adjust its scaling dynamically depending on the DPI
296+
settings of each connected monitor. This ensures a consistent and high-quality user experience across different displays.
297+
298+
DPI Scaling on Windows
299+
^^^^^^^^^^^^^^^^^^^^^^
300+
301+
On Windows, OpenShot rounds the scaling factor to the nearest whole value to maintain visual integrity. This rounding
302+
helps avoid visual artifacts in the UI rendering and ensures that the interface elements remain crisp and well-aligned.
303+
Due to this rounding, scaling options can sometimes lead to increased font-sizes and a feeling that the UI elements
304+
are a bit too large.
305+
306+
- **125% scaling** rounds to **100%**
307+
- **150% scaling** rounds to **200%**
308+
309+
Workarounds for Fine-Grained Adjustment
310+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
311+
312+
While rounding helps maintain a clean interface, there are workarounds for users who require more precise control
313+
over the scaling. However, these methods are **not recommended** due to potential visual artifacts:
314+
315+
- **QT_SCALE_FACTOR_ROUNDING_POLICY=PassThrough**
316+
317+
- Setting this environment variable can disable rounding and allow more precise scaling.
318+
- **Note:** This may cause visual artifacts, particularly in the timeline, and is not recommended.
319+
320+
- **QT_SCALE_FACTOR=0.75** (or similar value)
321+
322+
- Manually setting the scale factor can provide finer adjustments to the font and UI scaling.
323+
- **Note:** This method can also lead to visual artifacts and make OpenShot harder to use.
324+
325+
For more info on adjusting these environment variables, please visit
326+
https://github.com/OpenShot/openshot-qt/wiki/OpenShot-UI-too-large.

doc/preferences.rst

+13-3
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,21 @@ The General tab of the Preferences window allows you to modify the settings that
4949
Default Theme Humanity:Dark Choose your theme for OpenShot, either Light, Dark or None
5050
Image Length (seconds) 10.00 How long the image displays on the screen when added to the timeline
5151
Volume 75.00 The percentage of the volume of the clip when added to the timeline
52-
Blender Command (path) *<blank>* The path to the binary for Blender (version 2.8+)
52+
Blender Command (path) *<blank>* The path to the binary for Blender (version 4.1+)
5353
Advanced Title Editor (path) *<blank>* The path to the binary for Inkscape
5454
Show Export Dialog when Finished *<checked>* Displays the Export Video windows after the export is finished
5555
================================ ============= ===========
5656

57+
Themes
58+
""""""
59+
OpenShot comes with 3 standard themes, which change the look and feel of the program.
60+
61+
- **Retro:** A light theme that offers a classic and clean appearance. This theme uses light gray and white tones, making it ideal for users who prefer a bright and high-contrast interface. It provides a traditional look that is easy on the eyes, especially in well-lit environments.
62+
- **Humanity Dark:** [Default Theme] A dark theme with dark gray tones, providing a modern and sleek look. This theme is designed for users who prefer working in low-light conditions or who enjoy a more subdued and professional appearance. The dark gray background reduces glare and eye strain, making it suitable for extended editing sessions.
63+
- **Cosmic Dusk:** A bluish theme with a more modern UI design, enhancing the visual aesthetics of the editor. This theme features shades of blue and purple, giving the interface a contemporary and dynamic feel. It combines modern aesthetics with functionality, offering a fresh and visually appealing workspace for video editing.
64+
65+
.. image:: images/themes.jpg
66+
5767
.. _preferences_preview_ref:
5868

5969
Preview
@@ -87,7 +97,7 @@ a specific number of minutes, helping to reduce the risk or impact of data loss
8797
or user error.
8898

8999
Recovery
90-
^^^^^^^^
100+
""""""""
91101

92102
Before each save, a copy of the current project is created in a recovery folder, to further
93103
reduce the risk of data loss. The recovery folder is located at ``~/.openshot_qt/recovery/`` or
@@ -152,7 +162,7 @@ NOTE: On systems with older graphics cards, hardware acceleration may not always
152162
Advices is N(cores-1) or N(Threads-1) ?
153163
Hardware Decoder max width/height Can be found where? Link to HW manufacturers?
154164
Use Blender GPU rendering: Default = on?
155-
(May be default in Blender 2.8? -
165+
(May be default in Blender 4.1? -
156166
May work backfire if system has multiple GPUs and high-end GPU recognizes Blender automatically)
157167
158168
Keyboard

doc/titles.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Installing Blender
105105
The :guilabel:`Animated Title` feature in OpenShot requires the latest version of
106106
Blender (https://www.blender.org/download/) be installed and the OpenShot **Preferences** updated
107107
with the correct path to the Blender executable. See the :ref:`preferences_general_ref` tab
108-
in Preferences. NOTE: The minimum supported version of Blender is 2.8+. Older versions of Blender are
108+
in Preferences. NOTE: The minimum supported version of Blender is 4.1+. Older versions of Blender are
109109
not compatible with OpenShot Video Editor.
110110

111111
For a detailed guide on how to install these dependencies, see

src/classes/info.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
DESKTOP_ID = "org.openshot.OpenShot.desktop"
9999

100100
# Blender minimum version required (a string value)
101-
BLENDER_MIN_VERSION = "2.80"
101+
BLENDER_MIN_VERSION = "4.1"
102102

103103
# Data-model debugging enabler
104104
MODEL_TEST = False

0 commit comments

Comments
 (0)