You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/how_to_build_win.md
+44-47Lines changed: 44 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,78 +1,75 @@
1
+
1
2
# Building on Windows
2
3
3
-
This software can be built using Visual Studio 2015 and Qt 5.9
4
+
This software can be built using Visual Studio 2015 or above and Qt 5.9 (later Qt versions still not working correctly.)
4
5
5
6
## Required Software
6
7
7
-
### Visual Studio Express 2015 for Windows Desktop
8
+
### Visual Studio Express 2015 or higher for Windows Desktop
8
9
-https://www.visualstudio.com/vs/older-downloads/
9
-
- Make sure that the version is "2015" and that the target platform is "for Windows Desktop", not "for Windows".
10
-
- Community and Professional versions of Visual Studio 2015 for Windows Desktop also work.
11
-
- Visual Studio 2017 is currently unsupported.
10
+
- Make sure the target platform is "for Windows Desktop", not "for Windows".
11
+
- Community and Professional versions of Visual Studio for Windows Desktop also work.
12
12
- During the installation, make sure to select all the Visual C++ packages.
13
13
14
14
### CMake
15
15
-https://cmake.org/download/
16
16
- This will be used to create the `MSVC 2015` project file.
17
17
18
-
## Acquiring the Source Code
19
-
- Clone the base repository.
20
-
- Throughout the explanation `$opentoonz` will represent the root for the base repository.
21
-
- Visual Studio cannot recognize UTF-8 without BOM source code properly. Furthermore, since the endline character is represented with only the LF character, one line comments in Japanese will often cause the following line to be treated as a comment by `MSVS` as well.
22
-
- In order to prevent this, please change the following setting in git so that it will preserve the proper endline characters:
23
-
-`git config core.safecrlf true`
24
-
25
-
## Installation of Required Libraries
26
-
Because of the size of these libraries, they are not maintained in the git repository.
27
-
They will have to be installed seperately as follows.
28
-
29
-
### `lib` and `dll`
30
-
-`lib` and `dll` files are tracked by [Git Large File Storage](https://git-lfs.github.com/).
31
-
- Execute `git lfs pull` after `git clone` by using the `lfs` client.
32
-
33
18
### Qt
34
19
-https://www.qt.io/download-open-source/
35
20
- Qt is a cross-platform GUI framework.
36
-
- Install Qt 5.9 (64-bit version, tested up to 5.9.4) with the [Qt Online Installer for Windows](http://download.qt.io/official_releases/online_installers/qt-unified-windows-x86-online.exe).
21
+
- Install Qt 5.9 (64-bit version, tested up to 5.9.9) with the [Qt Online Installer for Windows](http://download.qt.io/official_releases/online_installers/qt-unified-windows-x86-online.exe).
37
22
38
23
### boost
39
24
- Boost 1.55.0 or later is required (tested up to 1.61.0).
- Note: You can also perform these next commands with Github for Desktop client.
32
+
- Clone the base repository.
33
+
- Throughout the explanation `$opentoonz` will represent the root for the base repository.
44
34
35
+
### lib and dll
45
36
46
-
## Building
37
+
-`lib` and `dll` files are tracked by [Git Large File Storage](https://git-lfs.github.com/).
38
+
- Note: git-lfs is also installed with Github Desktop.
39
+
- Visual Studio cannot recognize UTF-8 without BOM source code properly. Furthermore, since the endline character is represented with only the LF character, one line comments in Japanese will often cause the following line to be treated as a comment by `MSVS` as well.
40
+
- In order to prevent this, please change the following setting in git so that it will preserve the proper endline characters:
41
+
-`git config core.safecrlf true`
42
+
- Execute `git lfs pull` after `git clone` by using the lfs client.
47
43
48
44
### Using CMake to Create a Visual Studio Project
49
-
1. Launch CMake
50
-
2. In `Where is the source code`, navigate to `$opentoonz/toonz/sources`
51
-
3. In `Where to build the binaries`, navigate to `$opentoonz/toonz/build`
52
-
- Or to wherever you usually build to.
53
-
- If the build directory is in the git repository, be sure to add the directory to .gitignore
54
-
- If the build directory is different from the one above, be sure to change to the specified directory where appropriate below.
55
-
4.Click on Configure and select Visual Studio 14 2015 Win64.
56
-
5.If Qt was installed to a directory other than the default, and the error `Specify QT_PATH properly` appears, navigate to the `QT_DIR` install folder and specify the path to `msvc2015_64`. Rerun Configure.
57
-
-If red lines appear in the bottom box, you can safely ignore them.
58
-
6.Click Generate
59
-
-Should the CMakeLists.txt file change, such as during automatic build cleanup, there is no need to rerun CMake.
45
+
- Launch CMake
46
+
- In `Where is the source code`, navigate to `$opentoonz/toonz/sources`
47
+
- In `Where to build the binaries`, navigate to `$opentoonz/toonz/build`
48
+
- Or to wherever you usually build to.
49
+
- If the build directory is in the git repository, be sure to add the directory to .gitignore
50
+
- If the build directory is different from the one above, be sure to change to the specified directory where appropriate below.
51
+
-Click on Configure and select the version of Visual Studio you are using.
52
+
-If Qt was installed to a directory other than the default, and the error Specify QT_PATH properly appears, navigate to the `QT_DIR` install folder and specify the path to `msvc2015_64`. Rerun Configure.
53
+
-If red lines appear in the bottom box, you can safely ignore them.
54
+
-Click Generate
55
+
-Should the CMakeLists.txt file change, such as during automatic build cleanup, there is no need to rerun CMake.
60
56
61
57
## Setting Up Libraries
62
58
Rename the following files:
63
-
-`$opentoonz/thirdparty/LibJPEG/jpeg-9/jconfig.vc` to `$opentoonz/thirdparty/LibJPEG/jpeg-9/jconfig.h`
64
-
-`$opentoonz/thirdparty/tiff-4.0.3/libtiff/tif_config.vc.h` to `$opentoonz/thirdparty/tiff-4.0.3/libtiff/tif_config.h`
65
-
-`$opentoonz/thirdparty/tiff-4.0.3/libtiff/tiffconf.vc.h` to `$opentoonz/thirdparty/tiff-4.0.3/libtiff/tiffconf.h`
66
-
-`$opentoonz/thirdparty/libpng-1.6.21/scripts/pnglibconf.h.prebuilt` to `$opentoonz/thirdparty/libpng-1.6.21/pnglibconf.h`
67
-
- Note that the destination is a different folder for the last file.
59
+
-`$opentoonz/thirdparty/LibJPEG/jpeg-9/jconfig.vc` to `$opentoonz/thirdparty/LibJPEG/jpeg-9/jconfig.h`
60
+
-`$opentoonz/thirdparty/tiff-4.0.3/libtiff/tif_config.vc.h` to `$opentoonz/thirdparty/tiff-4.0.3/libtiff/tif_config.h`
61
+
-`$opentoonz/thirdparty/tiff-4.0.3/libtiff/tiffconf.vc.h to $opentoonz/thirdparty/tiff-4.0.3/libtiff/tiffconf.h`
62
+
-`$opentoonz/thirdparty/libpng-1.6.21/scripts/pnglibconf.h.prebuilt to $opentoonz/thirdparty/libpng-1.6.21/pnglibconf.h`
63
+
- Note that the destination is a different folder for the last file.
68
64
69
65
## Building
70
-
1. Open `$opentoonz/toonz/build/OpenToonz.sln` and change to `Debug` or `Release` in the top bar.
71
-
2. The output will be in the corresponding folder in `$opentoonz/toonz/build/`
66
+
- Open `$opentoonz/toonz/build/OpenToonz.sln` and change to `Debug` or `Release` in the top bar.
67
+
- Compile the build.
68
+
- The output will be in the corresponding folder in `$opentoonz/toonz/build/`
72
69
73
70
## Building with extended stop motion support for webcams and Canon DSLR cameras.
74
-
You will need three additional libraries.
75
-
-[OpenCV](https://opencv.org/) (v4.1.0 and later)
71
+
You will need three additional libraries.
72
+
-[OpenCV](https://opencv.org/) (v4.1.0 and later)
76
73
-[libjpeg-turbo](https://www.libjpeg-turbo.org/)
77
74
- The Canon SDK. This requires applying for the Canon developer program and downloading the SDK.
78
75
@@ -88,10 +85,10 @@ To run the program with stop motion support, you will need to copy the .dll file
88
85
89
86
## Running the Program
90
87
### Setting Up the Program's Path
91
-
1. Copy the entire contents of `$opentoonz/toonz/build/Release` to an appropriate folder.
88
+
1. Copy the entire contents of $opentoonz/toonz/build/Release to an appropriate folder.
92
89
93
-
2. Open a Command Prompt and navigate to `QT_DIR/msvc2015_64/bin`. Run the Qt program `windeployqt.exe` with the path for `OpenToonz.exe` as an argument.
94
-
- The necessary Qt library files should be in the same folder as `OpenToonz.exe`
90
+
2. Open a Command Prompt and navigate to `QT_DIR/msvc2015_64/bin`. Run the Qt program `windeployqt.exe` with the path for `OpenToonz.exe` as an argument. (Another way to do this is navigate to the exe that was created in your Release folder and drag and drop the Opentoonz.exe on top of the windeployqt.exe This will automatically generate the QT files and folders you will need.)
91
+
- The necessary Qt library files should be in the same folder as `OpenToonz.exe`
Copyright (c) 2016 - 2020, the respective contributors.
18
+
All rights reserved.
19
+
20
+
Each contributor holds copyright over their respective contributions.
21
+
The project versioning (Git) records all such contribution source information.
22
+
23
+
24
+
LICENSE
25
+
26
+
BSD 3-Clause "New" or "Revised" License
27
+
28
+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
29
+
30
+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
31
+
32
+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
33
+
34
+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
35
+
36
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0 commit comments