Difference between revisions of "Compile ECWolf on Windows"
m |
m (→Compiling: Added some notes to help compile in VS on Windows.) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 3: | Line 3: | ||
== Dependencies == | == Dependencies == | ||
− | The following programs | + | The following programs are used by ECWolf. The versions listed below are known to work, however other versions may work. |
− | * [ | + | * [https://cmake.org/ CMake] 3.11 or later (2.8.12 is the minimum but 3.11 or later is recommended) |
− | + | * [https://git-scm.com/ Git] | |
− | * [ | + | * Compiler of your choice. [https://visualstudio.microsoft.com Visual Studio 2017] is recommended, but one can also use Visual Studio 2005 or MinGW-w64 8.1. |
− | |||
− | |||
− | |||
− | [http:// | + | |
+ | In addition to the above, ECWolf comes with a copy of the following which can optionally be compiled separately if you are so inclined. | ||
+ | * [http://www.libsdl.org/ libSDL] 2.0.5 (2.0.6 or later will compile, but there are some issues with the audio overhaul at this time.) | ||
+ | * [http://maniacsvault.net/ecwolf/files/tools/dev/ SDL_mixer for ECWolf] (Standard [https://www.libsdl.org/projects/SDL_mixer/ SDL_mixer] 2.0.1 will work, but features will be disabled.) | ||
+ | * [https://www.libsdl.org/projects/SDL_net/ SDL_net] 2.0.1 | ||
+ | * [http://www.zlib.net/ zlib] 1.2.11 | ||
+ | * [http://bzip.org/ bzip2] 1.0.6 | ||
+ | * [http://ijg.org/ jpeg] 6b | ||
+ | |||
+ | |||
+ | Note that it is also possible to build with vanilla MinGW for legacy OS support, but you will need to use SDL 1.2 (Set FORCE_SDL12 in CMake) and provide SDL and SDL_net yourself. You can use the internal SDL_mixer with both SDL2 and SDL 1.2. | ||
== Retrieving the Source == | == Retrieving the Source == | ||
− | Use | + | Use Git to retrieve the latest version of the source. |
− | + | git clone [https://bitbucket.org/ecwolf/ecwolf https://bitbucket.org/ecwolf/ecwolf.git] --recursive | |
+ | |||
+ | Git will also automatically download SDL, SDL_mixer, and SDL_net sources during this stage. | ||
== Compiling == | == Compiling == | ||
First open the CMake GUI and put the location to the source code in the source code path. (Note that this is not the src directory in the repository but the root.) Then for the directory to build the binary in, create a build directory in the source code directory and use that. Once the two paths are entered click "Configure." | First open the CMake GUI and put the location to the source code in the source code path. (Note that this is not the src directory in the repository but the root.) Then for the directory to build the binary in, create a build directory in the source code directory and use that. Once the two paths are entered click "Configure." | ||
− | Here select the compiler you're going to generate the project for. | + | Here select the compiler you're going to generate the project for. Select the Visual Studio version you're using or MinGW Makefiles if you're using MinGW. Once you've made your selection, click "Finish." |
+ | |||
+ | CMake should be able to configure the project successfully. When it does click "Generate." | ||
+ | |||
+ | For MSVC you will now have a sln file which should build successfully. For MinGW open a command propmt and cd to the build directory and type mingw32-make. | ||
+ | |||
+ | === Building with static runtime === | ||
+ | By default ECWolf will be configured to use dynamically linked C runtimes. If this is undesirable set the following in CMake. | ||
+ | |||
+ | * '''Visual Studio''' | ||
+ | : Change /MD to /MT and /MDd to /MTd in the CMAKE_CXX_FLAGS_* and CMAKE_C_FLAGS_* variables. | ||
+ | * '''MinGW-w64''' | ||
+ | : Set CMAKE_EXE_LINKER_FLAGS to: | ||
+ | : <pre>-static-libgcc -static-libstdc++ -Wl,-Bstatic,--whole-archive -lpthread -Wl,-Bdynamic,--no-whole-archive</pre> | ||
+ | * '''MinGW''' | ||
+ | : Set CMAKE_EXE_LINKER_FLAGS to: | ||
+ | : <pre>-static-libgcc -static-libstdc++</pre> | ||
− | + | === More help with Visual Studio on Windows === | |
− | + | * Set "Configuration Type" to "Release" (not "Debug") | |
+ | * Set "Toolset" to be x86, ie: msvc_x86_x64 (not msvc_x64 or msvc_x64_x64) | ||
+ | * If you get the error "Could NOT find OpusFile" and you have the codecs checked out in the source tree, INTERNAL_SDL_MIXER_CODECS to ON in cmake to force it to use the vendored copy and compile. |
Latest revision as of 04:19, 5 October 2023
This guide will demonstrate how to compile the Mercurial version of ECWolf on Windows.
Dependencies
The following programs are used by ECWolf. The versions listed below are known to work, however other versions may work.
- CMake 3.11 or later (2.8.12 is the minimum but 3.11 or later is recommended)
- Git
- Compiler of your choice. Visual Studio 2017 is recommended, but one can also use Visual Studio 2005 or MinGW-w64 8.1.
In addition to the above, ECWolf comes with a copy of the following which can optionally be compiled separately if you are so inclined.
- libSDL 2.0.5 (2.0.6 or later will compile, but there are some issues with the audio overhaul at this time.)
- SDL_mixer for ECWolf (Standard SDL_mixer 2.0.1 will work, but features will be disabled.)
- SDL_net 2.0.1
- zlib 1.2.11
- bzip2 1.0.6
- jpeg 6b
Note that it is also possible to build with vanilla MinGW for legacy OS support, but you will need to use SDL 1.2 (Set FORCE_SDL12 in CMake) and provide SDL and SDL_net yourself. You can use the internal SDL_mixer with both SDL2 and SDL 1.2.
Retrieving the Source
Use Git to retrieve the latest version of the source.
git clone https://bitbucket.org/ecwolf/ecwolf.git --recursive
Git will also automatically download SDL, SDL_mixer, and SDL_net sources during this stage.
Compiling
First open the CMake GUI and put the location to the source code in the source code path. (Note that this is not the src directory in the repository but the root.) Then for the directory to build the binary in, create a build directory in the source code directory and use that. Once the two paths are entered click "Configure."
Here select the compiler you're going to generate the project for. Select the Visual Studio version you're using or MinGW Makefiles if you're using MinGW. Once you've made your selection, click "Finish."
CMake should be able to configure the project successfully. When it does click "Generate."
For MSVC you will now have a sln file which should build successfully. For MinGW open a command propmt and cd to the build directory and type mingw32-make.
Building with static runtime
By default ECWolf will be configured to use dynamically linked C runtimes. If this is undesirable set the following in CMake.
- Visual Studio
- Change /MD to /MT and /MDd to /MTd in the CMAKE_CXX_FLAGS_* and CMAKE_C_FLAGS_* variables.
- MinGW-w64
- Set CMAKE_EXE_LINKER_FLAGS to:
-static-libgcc -static-libstdc++ -Wl,-Bstatic,--whole-archive -lpthread -Wl,-Bdynamic,--no-whole-archive
- MinGW
- Set CMAKE_EXE_LINKER_FLAGS to:
-static-libgcc -static-libstdc++
More help with Visual Studio on Windows
- Set "Configuration Type" to "Release" (not "Debug")
- Set "Toolset" to be x86, ie: msvc_x86_x64 (not msvc_x64 or msvc_x64_x64)
- If you get the error "Could NOT find OpusFile" and you have the codecs checked out in the source tree, INTERNAL_SDL_MIXER_CODECS to ON in cmake to force it to use the vendored copy and compile.