README.md 5.6 KB
Newer Older
J
Jonathan Thomas 已提交
1 2 3
OpenShot Video Editor is an award-winning free and open-source video editor 
for Linux, Mac, and Windows, and is dedicated to delivering high quality 
video editing and animation solutions to the world.
4

5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
## Features

* Cross-platform (Linux, Mac, and Windows)
* Support for many video, audio, and image formats (based on FFmpeg)
* Powerful curve-based Key frame animations
* Desktop integration (drag and drop support)
* Unlimited tracks / layers
* Clip resizing, scaling, trimming, snapping, rotation, and cutting
* Video transitions with real-time previews
* Compositing, image overlays, watermarks
* Title templates, title creation, sub-titles
* 2D animation support (image sequences)
* 3D animated titles (and effects)
* SVG friendly, to create and include vector titles and credits
* Scrolling motion picture credits
* Advanced Timeline (including Drag & drop, scrolling, panning, zooming, and snapping)
* Frame accuracy (step through each frame of video)
* Time-mapping and speed changes on clips (slow/fast, forward/backward, etc...)
* Audio mixing and editing
* Digital video effects, including brightness, gamma, hue, greyscale, chroma key, and many more!
25
* Experimental hardware encoding and decoding (VA-API, NVDEC, D3D9, D3D11, VTB)
26 27
* Import & Export widely supported formats (EDL, XML)
* Render videos in many codecs and formats (based on FFmpeg)
28

J
Jonathan Thomas 已提交
29
## Getting Started
30

J
Jonathan Thomas 已提交
31 32 33 34
The quickest way to get started using OpenShot is to download one of 
our pre-built installers. On our download page, click the **Daily Builds** 
button to view the latest, experimental builds, which are created for each 
new commit to this repo.
35

J
Jonathan Thomas 已提交
36
https://www.openshot.org/download/
37

J
Jonathan Thomas 已提交
38
## Tutorial
39

J
Jonathan Thomas 已提交
40
Watch the official [step-by-step video tutorial](https://www.youtube.com/watch?list=PLymupH2aoNQNezYzv2lhSwvoyZgLp1Q0T&v=1k-ISfd-YBE), or read the official [user-guide](https://www.openshot.org/user-guide/):
41

J
Jonathan Thomas 已提交
42
## Developers
43

J
Jonathan Thomas 已提交
44 45 46 47
Are you interested in becoming more involved in the development of 
OpenShot? Build exciting new features, fix bugs, make friends, and become a hero! 
Please read the [step-by-step](https://github.com/OpenShot/openshot-qt/wiki/Become-a-Developer) 
instructions for getting source code, configuring dependencies, and building OpenShot.
48

J
Jonathan Thomas 已提交
49
## Documentation
50

J
Jonathan Thomas 已提交
51
Beautiful HTML documentation can be generated using Sphinx.
52

53
```sh
J
Jonathan Thomas 已提交
54 55 56
cd doc
make html
```
57

58 59
The documentation for the most recent release can be viewed online at [openshot.org/user-guide](https://www.openshot.org/user-guide/).

J
Jonathan Thomas 已提交
60
## Report a bug
61

J
Jonathan Thomas 已提交
62 63 64
Please report bugs using the official [Report a Bug](https://www.openshot.org/issues/new/) 
feature on our website. This walks you through the bug reporting process, and helps 
to create a high-quality bug report for the OpenShot community.
65

J
Jonathan Thomas 已提交
66
Or you can report a new issue directly on GitHub:
67

J
Jonathan Thomas 已提交
68
https://github.com/OpenShot/openshot-qt/issues
69

J
Jonathan Thomas 已提交
70
## Translations
71

J
Jonathan Thomas 已提交
72 73
Translating OpenShot into other languages is very easy! Please read the [step-by-step](https://github.com/OpenShot/openshot-qt/wiki/Become-a-Translator) instructions or login to LaunchPad and get started.
All you need is a web browser.
74

75 76
* Application Translations: https://translations.launchpad.net/openshot/2.0/+translations
* Website Translations: https://translations.launchpad.net/openshot/website/+pots/django
77

J
Jonathan Thomas 已提交
78
## Dependencies
79

J
Jonathan Thomas 已提交
80 81
Although installers are much easier to use, if you must build from 
source, here are some tips: 
82

J
Jonathan Thomas 已提交
83 84 85
OpenShot is programmed in Python (version 3+), and thus does not need
to be compiled to run. However, be sure you have the following 
dependencies in order to run OpenShot successfully: 
86

J
Jonathan Thomas 已提交
87 88 89 90 91 92
*  Python 3.0+ (http://www.python.org)
*  PyQt5 (http://www.riverbankcomputing.co.uk/software/pyqt/download5)
*  libopenshot: OpenShot Library (https://github.com/OpenShot/libopenshot)
*  libopenshot-audio: OpenShot Audio Library (https://github.com/OpenShot/libopenshot-audio)
*  FFmpeg or Libav (http://www.ffmpeg.org/ or http://libav.org/)
*  GCC build tools (or MinGW on Windows)
F
Frank Dana 已提交
93

J
Jonathan Thomas 已提交
94
## Launch
F
Frank Dana 已提交
95

96 97
To run OpenShot from the command line with an installed `libopenshot`,
use the following syntax:
J
Jonathan Thomas 已提交
98 99
(be sure the change the path to match the install or repo location 
of openshot-qt)
100

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
```sh
cd [openshot-qt folder]
python3 src/launch.py
```
    
To run with a version of `libopenshot` built from source but not installed,
set `PYTHONPATH` to the location of the compiled Python bindings. e.g.:

```sh
cd [libopenshot folder]
mkdir build; cd build; cmake [options] ..; make
    
cd [openshot-qt folder]
PYTHONPATH=[libopenshot folder]/build/src/bindings/python \
python3 src/launch.py
```
117

D
Dylan Coakley 已提交
118
## Websites
119

J
Jonathan Thomas 已提交
120
- https://www.openshot.org/  (Official website and blog)
D
DylanC 已提交
121
- https://github.com/OpenShot/openshot-qt (source code and issue tracker)
J
Jonathan Thomas 已提交
122 123 124
- https://github.com/OpenShot/libopenshot-audio (source code for audio library)
- https://github.com/OpenShot/libopenshot (source code for video library)
- https://launchpad.net/openshot/
125

J
Jonathan Thomas 已提交
126
## Copyright
127

F
FeRD (Frank Dana) 已提交
128
Copyright (c) 2008-2021 OpenShot Studios, LLC. This file is part of
J
Jonathan Thomas 已提交
129 130 131
OpenShot Video Editor (https://www.openshot.org), an open-source project
dedicated to delivering high quality video editing and animation solutions
to the world.
132

J
Jonathan Thomas 已提交
133 134 135 136
OpenShot Video Editor is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
D
DylanC 已提交
137

J
Jonathan Thomas 已提交
138 139 140 141
OpenShot Video Editor is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
D
DylanC 已提交
142

J
Jonathan Thomas 已提交
143 144
You should have received a copy of the GNU General Public License
along with OpenShot Library.  If not, see <http://www.gnu.org/licenses/>.