0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme for vcpkg.

Browse source
This commit is contained in:
Pentarctagon 2020-05-15 14:06:57 -05:00
parent a6a3d4686a
commit 62d0ad4907
No known key found for this signature in database
GPG key ID: 29E48D667D52CCF3
1 changed files with 7 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
projectfiles/VC16/README.md
View file

@ -1,59 +1,7 @@
# Compiling Wesnoth on Windows using Visual Studio
The current minimum Visual Studio version required for compiling Wesnoth is Visual Studio 2013 (VC12).
Compilation is also supported with Visual Studio 2015 (VC14) and later versions. However, since we keep
the project files in the Git repository targeted at the minimum version, it is recommended you duplicate
the `wesnoth/projectfiles/VC12` directory and rename it after the Visual Studio version with which you
wish to build.
## Prerequisites
We maintain a handy [GitHub repository](https://github.com/aquileia/external) with all the external
libraries (see [INSTALL.md](https://github.com/wesnoth/wesnoth/blob/master/INSTALL.md)) Wesnoth requires.
It has various branches corresponding to the Visual Studio version you are building with. Be sure to use
the libraries from the appropriate branch!
## What to do
1. Clone or download a snapshot of the aforementioned dependency repository. If you do the latter, be sure
you've downloaded the snapshot for the correct branch, **not** `master`! Either way, it should be
cloned/unpacked into the same directory as Wesnoth. If you have Wesnoth cloned in `Documents/wesnoth`, for
example, the dependency pack should be at `Documents/external`. Note that `external` is the name of the
resulting directory by default. **DO NOT RENAME IT!**
2. If you cloned the repository, switch to the the version-appropriate branch now.
3. Return to `wesnoth/projectfiles` and duplicate the VC12 folder if applicable, as mentioned above.
4. Open `projectfiles/VCXX/wesnoth.sln` in Visual Studio. At this point, it may prompt you to re-target the
projectfiles for your current VS and Windows versions. Do so; the build will likely fail if you do not.
5. **Optional:** by default, Wesnoth's WML unit tests are run after each build. This can be quite annoying
and/or time-consuming if you build regularly. They can be disabled by heading to the `wesnoth` projectfile's
properties, under `Build Events → Post-Build Event`. Delete the value in the "Command Line" field.
6. That's it! You can now go ahead and start the build (`Build → Build Solution`).
7. **Important!** After building, copy all the files from `external/dll` into the same directory (`wesnoth/`
by default) as the newly built executable . The game will not start if you fail to do this.
## Manually updating the external dependencies
We do our best to keep the build dependency repository up-to-date with the latest versions of the libraries
within, as well as synced with any build requirement changes. If you want to build with a different version
of a certain library, however, you can fetch the relevant files at the links below:
* **Boost:** http://www.boost.org/users/download. Do note that you will need to build the necessary Boost
libraries yourself. See the [instructions](https://github.com/aquileia/external/blob/master/README.md#updating-boost-libraries)
in the dependency repository for details.
* **SDL 2:** https://www.libsdl.org/download-2.0.php. You'll want the "Visual C++ 32/64-bit" Development
Libraries.
* **SDL_Image:** https://www.libsdl.org/projects/SDL_image. Again, you'll want the "Visual C++ 32/64-bit"
Development Libraries.
* **SDL_Mixer:** https://www.libsdl.org/projects/SDL_mixer. Again, you'll want the "Visual C++ 32/64-bit"
Development Libraries.
The other libraries require complicated compilation procedures too in-depth to document here.
# Building with VS2019
* Install [vcpkg](https://github.com/Microsoft/vcpkg).
* Make vcpkg available to Visual Studio with `vcpkg integrate install` (may require admin rights).
* Use vcpkg to install all dependencies:
```vcpkg install sdl2:x64-windows sdl2-image:x64-windows sdl2-mixer:x64-windows sdl2-ttf:x64-windows bzip2:x64-windows zlib:x64-windows pango:x64-windows cairo:x64-windows fontconfig:x64-windows libvorbis:x64-windows libogg:x64-windows boost-filesystem:x64-windows boost-iostreams:x64-windows boost-locale:x64-windows boost-random:x64-windows boost-regex:x64-windows boost-asio:x64-windows boost-program-options:x64-windows boost-system:x64-windows boost-thread:x64-windows boost-bimap:x64-windows boost-multi-array:x64-windows boost-ptr-container:x64-windows boost-logic:x64-windows boost-format:x64-windows```
* The above dependencies were taken from [the travis-ci script](https://github.com/wesnoth/wesnoth/blob/master/utils/travis/steps/script.sh).
* Given the above will be compiling both the release and, as available, the debug versions of all those libraries and their dependencies, this may take an hour or more. The travis-ci script works around this somewhat by aliasing `make` to `make -j4` in order to force four threads to be used rather than just one thread.