Difference between revisions of "Compiling ScummVM/Visual Studio"

Jump to navigation Jump to search

Compiling ScummVM/Visual Studio (view source)

Revision as of 17:47, 5 April 2020

368 bytes added ,  17:47, 5 April 2020
no edit summary
(Add section for compiling without the console window)
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Compiling ScummVM with Visual Studio under Windows ==
== Compiling ScummVM with Visual Studio under Windows ==


Compiling ScummVM with Visual Studio is not an awfully hard task. It is however slightly more complicated than using MinGW. We guide you through the steps to make ScummVM compile with Visual Studio on this page.
Compiling ScummVM with Visual Studio is not an awfully hard task. It is however slightly more complicated than using [[Compiling ScummVM/MinGW|MinGW]]. We guide you through the steps to make ScummVM compile with Visual Studio on this page.


== Things needed ==
== Things needed ==
Visual Studio 2008-2019


=== Visual Studio ===
=== Visual Studio ===
There exists a free Community version of Visual Studio 2015 [https://www.visualstudio.com/en-US/products/visual-studio-express-vs here] that can be used.
There exists a free Community version of Visual Studio [https://visualstudio.microsoft.com/vs/ here] that can be used.
Professional Visual Studio 2015 versions are working fine too.
Professional Visual Studio versions are working fine too.


We do support older versions of Visual Studio too. However, on this page we focus on building ScummVM with Visual Studio 2015. Building ScummVM with older Visual Studio versions can require additional work not described on this page.
When installing Visual Studio 2017 or later, make sure to select the "Desktop Development with C++" workload.
 
We do support older versions of Visual Studio too. However, on this page we focus on building ScummVM with latest Visual Studio. Building ScummVM with older Visual Studio 2008 can require additional work not described on this page.


=== Needed Libraries ===
=== Needed Libraries ===
ScummVM relies on third-party libraries to implement certain functionality. Some of these libraries are required, like for example SDL, others are optional, like for example libtheora. We supply a set of prebuilt libraries for Visual Studio 2015. These have been build on Windows 8.1 using the Visual Studio 2015 Community Edition. The libraries can be found [http://www.scummvm.org/frs/build/scummvm_libs_2015.zip here].
ScummVM relies on third-party libraries to implement certain functionality. Some of these libraries are required, like for example SDL, others are optional, like for example libtheora. We supply a set of prebuilt libraries for Visual Studio 2015 and later. These have been build on Windows 8.1 using the Visual Studio 2015 Community Edition. The libraries can be found [http://www.scummvm.org/frs/build/scummvm_libs_2015.zip here].


=== Installing Libraries ===
=== Installing Libraries ===
Line 18: Line 21:
To make it work you have to follow these steps:
To make it work you have to follow these steps:
* Unzip the library zip to a directory of your choice. For example, you can unzip them into "C:\Users\YourUsername\Documents\scummvm_libs_2015".
* Unzip the library zip to a directory of your choice. For example, you can unzip them into "C:\Users\YourUsername\Documents\scummvm_libs_2015".
* Go to Control Panel -> Environment Variables and set up a new variable "SCUMMVM_LIBS" with a value of the path you extracted the zip in. It is important that you do point the variable to the folder containing the "bin", "include", and "lib" directories.
* Go to Start Menu > Control Panel > System > Advanced Settings > Environment Variables and add a new variable "SCUMMVM_LIBS" with a value of the path you extracted the zip in. It is important that you do point the variable to the folder containing the "bin", "include", and "lib" directories.


=== Manually Building Libraries ===
=== Manually Building Libraries ===
Line 27: Line 30:
=== Building create_project ===
=== Building create_project ===


ScummVM uses a configure/Make based build system. We feature a tool to generate Visual Studio project files from this build system. The first steep you need to take is building this tool called "create_project".
ScummVM uses a configure/Make based build system. We have a tool to generate Visual Studio project files from this build system. The first steep you need to take is building this tool called "create_project".


First, open the solution file "devtools\create_project\msvc14\create_project.sln". Then simply build the solution. The project file should automatically assure that the resulting "create_project.exe" is copied to "dists\msvc14". If not, you will have to copy it yourself.
First, open the solution file "devtools\create_project\msvc\create_project.sln". Then simply build the solution. The project file should automatically assure that the resulting "create_project.exe" is copied to "dists\msvc". If not, you will have to copy it yourself.


=== Generating the Project Files ===
=== Generating the Project Files ===


Simply run the batch script "dists/msvc14/create_msvc14.bat". It will guide you through configuring ScummVM.
Simply run the batch script "dists/msvc/create_msvc.bat". It will guide you through configuring ScummVM.


'''IMPORTANT''': You will have to re-generate the project files whenever new source files have been added to or removed from the configure/Make based build system. When you add new files to ScummVM, you will ''have'' to add them to the respective "module.mk" file to assure ScummVM still builds fine with the configure/Make based build system.
'''IMPORTANT''': You will have to re-generate the project files whenever new source files have been added to or removed from the configure/Make based build system. When you add new files to ScummVM, you will ''have'' to add them to the respective "module.mk" file to assure ScummVM still builds fine with the configure/Make based build system.
Line 41: Line 44:
If you followed all the steps, you are now ready to compile ScummVM with Visual Studio. Congratulations!
If you followed all the steps, you are now ready to compile ScummVM with Visual Studio. Congratulations!


Simply open the generated solution file in "dists\msvc14\scummvm.sln". Now you can ask it to build the desired configuration. By default it will build a debug configuration which is ideal to hack on ScummVM.
Simply open the generated solution file in "dists\msvc\scummvm.sln". Now you can ask it to build the desired configuration. By default it will build a debug configuration which is ideal to hack on ScummVM.
 
'''IMPORTANT''': You'll need to copy the matching SDL2.dll file to a location Windows picks up to run the resulting binary. The easiest way to do this is to place the SDL2.dll file in the directory where scummvm.exe is (dists\msvc\Debug). There are multiple SDL2.dll files to choose from, depending on your build configuration. Simply pick the right one from the prebuilt libraries. For example, if you build a Win32 Debug configuration, you will need to use "libs/x86/Debug/SDL2.dll".


'''IMPORTANT''': You'll need to copy the matching SDL.dll file to a location Windows picks up to run the resulting binary. The easiest way to do this is to place the SDL.dll file in the directory where scummvm.exe is. There are multiple SDL.dll files to choose from, depending on your build configuration. Simply pick the right one from the prebuilt libraries. For example, if you build a Win32 Debug configuration, you will need to use "libs/x86/Debug/SDL.dll".
NOTE: Several people have had errors about structure packing under Visual Studio 2019. In such cases, you need to update [http://libsdl.org/download-2.0.php SDL2] with the latest version.


== Compiling without Console/Status Window ==
== Compiling without Console/Status Window ==
SupSuper
78

edits

Retrieved from "https://wiki.scummvm.org/index.php?title=Special:MobileDiff/23417...26956"

Navigation menu