games/vcmi
1
0
Fork 0
mirror of https://github.com/vcmi/vcmi.git synced 2025-08-13 19:54:17 +02:00
Code Issues Releases Activity

Merge pull request #3031 from Alexander-Wilms/ccache-docs

Browse Source 
Mention ccache in developer docs
This commit is contained in:
Nordsoft91
2023-10-10 00:44:39 +02:00
committed by GitHub
parent b6da60b105 9bbd2a58bc
commit c9dc87756b
5 changed files with 35 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/developers/Building_Android.md
View File

@@ -14,7 +14,9 @@ The following instructions apply to **v1.2 and later**. For earlier versions the
- install with `sdkmanager` command line tool - install with `sdkmanager` command line tool
- download from https://developer.android.com/ndk/downloads - download from https://developer.android.com/ndk/downloads
- download with Conan, see [#NDK and Conan](#ndk-and-conan) - download with Conan, see [#NDK and Conan](#ndk-and-conan)
5. (optional) Ninja: download from your package manager or from https://github.com/ninja-build/ninja/releases 5. Optional:
- Ninja: download from your package manager or from https://github.com/ninja-build/ninja/releases
- Ccache: download from your package manager or from https://github.com/ccache/ccache/releases
## Obtaining source code ## Obtaining source code
@@ -60,7 +62,7 @@ Building for Android is a 2-step process. First, native C++ code is compiled to
This is a traditional CMake project, you can build it from command line or some IDE. You're not required to pass any custom options (except Conan toolchain file), defaults are already good. If you wish to use your own CMake presets, inherit them from our `build-with-conan` preset. Example: This is a traditional CMake project, you can build it from command line or some IDE. You're not required to pass any custom options (except Conan toolchain file), defaults are already good. If you wish to use your own CMake presets, inherit them from our `build-with-conan` preset. Example:
``` ```
cmake -S . -B ../build -G Ninja -D CMAKE_BUILD_TYPE=Debug --toolchain ... cmake -S . -B ../build -G Ninja -D CMAKE_BUILD_TYPE=Debug -D CMAKE_COMPILER_LAUNCHER=ccache --toolchain ...
cmake --build ../build cmake --build ../build
``` ```

13
docs/developers/Building_Linux.md
View File

@@ -19,13 +19,15 @@ To compile, the following packages (and their development counterparts) are need
- Boost C++ libraries v1.48+: program-options, filesystem, system, thread, locale - Boost C++ libraries v1.48+: program-options, filesystem, system, thread, locale
- Recommended, if you want to build launcher or map editor: Qt 5, widget and network modules - Recommended, if you want to build launcher or map editor: Qt 5, widget and network modules
- Recommended, FFmpeg libraries, if you want to watch in-game videos: libavformat and libswscale. Their name could be libavformat-devel and libswscale-devel, or ffmpeg-libs-devel or similar names. - Recommended, FFmpeg libraries, if you want to watch in-game videos: libavformat and libswscale. Their name could be libavformat-devel and libswscale-devel, or ffmpeg-libs-devel or similar names.
- Optional, if you want to build scripting modules: LuaJIT - Optional:
- if you want to build scripting modules: LuaJIT
- to speed up recompilation: Ccache
## On Debian-based systems (e.g. Ubuntu) ## On Debian-based systems (e.g. Ubuntu)
For Ubuntu and Debian you need to install this list of packages: For Ubuntu and Debian you need to install this list of packages:
`sudo apt-get install cmake g++ clang libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev zlib1g-dev libavformat-dev libswscale-dev libboost-dev libboost-filesystem-dev libboost-system-dev libboost-thread-dev libboost-program-options-dev libboost-locale-dev qtbase5-dev libtbb-dev libluajit-5.1-dev qttools5-dev ninja-build` `sudo apt-get install cmake g++ clang libsdl2-dev libsdl2-image-dev libsdl2-ttf-dev libsdl2-mixer-dev zlib1g-dev libavformat-dev libswscale-dev libboost-dev libboost-filesystem-dev libboost-system-dev libboost-thread-dev libboost-program-options-dev libboost-locale-dev qtbase5-dev libtbb-dev libluajit-5.1-dev qttools5-dev ninja-build ccache`
Alternatively if you have VCMI installed from repository or PPA you can use: Alternatively if you have VCMI installed from repository or PPA you can use:
@@ -33,7 +35,7 @@ Alternatively if you have VCMI installed from repository or PPA you can use:
## On RPM-based distributions (e.g. Fedora) ## On RPM-based distributions (e.g. Fedora)
`sudo yum install cmake gcc-c++ SDL2-devel SDL2_image-devel SDL2_ttf-devel SDL2_mixer-devel boost boost-devel boost-filesystem boost-system boost-thread boost-program-options boost-locale zlib-devel ffmpeg-devel ffmpeg-libs qt5-qtbase-devel tbb-devel luajit-devel fuzzylite-devel` `sudo yum install cmake gcc-c++ SDL2-devel SDL2_image-devel SDL2_ttf-devel SDL2_mixer-devel boost boost-devel boost-filesystem boost-system boost-thread boost-program-options boost-locale zlib-devel ffmpeg-devel ffmpeg-libs qt5-qtbase-devel tbb-devel luajit-devel fuzzylite-devel ccache`
NOTE: `fuzzylite-devel` package is no longer available in recent version of Fedora, for example Fedora 38. It's not a blocker because VCMI bundles fuzzylite lib in its source code. NOTE: `fuzzylite-devel` package is no longer available in recent version of Fedora, for example Fedora 38. It's not a blocker because VCMI bundles fuzzylite lib in its source code.
@@ -69,10 +71,13 @@ cmake ../vcmi
# Additional options that you may want to use: # Additional options that you may want to use:
## To enable debugging: ## To enable debugging:
`cmake ../vcmi -DCMAKE_BUILD_TYPE=Debug` `cmake ../vcmi -D CMAKE_BUILD_TYPE=Debug`
**Notice**: The ../vcmi/ is not a typo, it will place makefile scripts into the build dir as the build dir is your working dir when calling CMake. **Notice**: The ../vcmi/ is not a typo, it will place makefile scripts into the build dir as the build dir is your working dir when calling CMake.
## To use ccache:
`cmake ../vcmi -D CMAKE_COMPILER_LAUNCHER=ccache`
## Trigger build ## Trigger build
`cmake --build . -- -j2` `cmake --build . -- -j2`

14
docs/developers/Building_Windows.md
View File

@@ -10,7 +10,9 @@ Windows builds can be made in more than one way and with more than one tool. Thi
- Git or git GUI, for example, SourceTree [download link](http://www.sourcetreeapp.com/download) - Git or git GUI, for example, SourceTree [download link](http://www.sourcetreeapp.com/download)
- CMake [download link](https://cmake.org/download/). During install after accepting license agreement make sure to check "Add CMake to the system PATH for all users". - CMake [download link](https://cmake.org/download/). During install after accepting license agreement make sure to check "Add CMake to the system PATH for all users".
- To unpack pre-build Vcpkg: [7-zip](http://www.7-zip.org/download.html) - To unpack pre-build Vcpkg: [7-zip](http://www.7-zip.org/download.html)
- Optionally, to create installer: [NSIS](http://nsis.sourceforge.net/Main_Page) - Optional:
- To create installer: [NSIS](http://nsis.sourceforge.net/Main_Page)
- To speed up recompilation: [CCache](https://github.com/ccache/ccache/releases)
## Choose an installation directory ## Choose an installation directory
@@ -75,6 +77,10 @@ From command line use:
For the list of the packages used you can also consult [vcmi-deps-windows readme](https://github.com/vcmi/vcmi-deps-windows) in case this article gets outdated a bit. For the list of the packages used you can also consult [vcmi-deps-windows readme](https://github.com/vcmi/vcmi-deps-windows) in case this article gets outdated a bit.
# Install CCache
Extract `ccache` to a folder of your choosing, add the folder to the `PATH` environment variable and log out and back in.
# Build VCMI # Build VCMI
#### From GIT GUI #### From GIT GUI
@@ -97,7 +103,11 @@ For the list of the packages used you can also consult [vcmi-deps-windows readme
## Compile VCMI with Visual Studio ## Compile VCMI with Visual Studio
- Open `%VCMI_DIR%/build/VCMI.sln` in Visual Studio - Open `%VCMI_DIR%/build/VCMI.sln` in Visual Studio
- Select `Release` build type in combobox - Select `Release` build type in the combobox
- If you want to use ccache:
- Select `Manage Configurations...` in the combobox
- Specify the following CMake variable: `ENABLE_CCACHE=ON`
- See the [Visual Studio documentation](https://learn.microsoft.com/en-us/cpp/build/customize-cmake-settings?view=msvc-170#cmake-variables-and-cache) for details
- Right click on `BUILD_ALL` project. This `BUILD_ALL` project should be in `CMakePredefinedTargets` tree in Solution Explorer. - Right click on `BUILD_ALL` project. This `BUILD_ALL` project should be in `CMakePredefinedTargets` tree in Solution Explorer.
- VCMI will be built in `%VCMI_DIR%/build/bin` folder! - VCMI will be built in `%VCMI_DIR%/build/bin` folder!

4
docs/developers/Building_iOS.md
View File

@@ -5,6 +5,8 @@
1. **macOS** 1. **macOS**
2. Xcode: <https://developer.apple.com/xcode/> 2. Xcode: <https://developer.apple.com/xcode/>
3. CMake 3.21+: `brew install --cask cmake` or get from <https://cmake.org/download/> 3. CMake 3.21+: `brew install --cask cmake` or get from <https://cmake.org/download/>
4. Optional:
- CCache to speed up recompilation: `brew install ccache`
## Obtaining source code ## Obtaining source code
@@ -41,6 +43,8 @@ cmake --preset ios-device-conan \
By default build directory containing Xcode project will appear at `../build-ios-device-conan`, but you can change it with `-B` option. By default build directory containing Xcode project will appear at `../build-ios-device-conan`, but you can change it with `-B` option.
If you want to speed up the recompilation, add `-D ENABLE_CCACHE=ON`
### Building for device ### Building for device
To be able to build for iOS device, you must also specify codesigning settings. If you don't know your development team ID, open the generated Xcode project, open project settings (click **VCMI** with blue icon on the very top in the left panel with files), select **vcmiclient** target, open **Signing & Capabilities** tab and select yout team. Now you can copy the value from **Build Settings** tab - `DEVELOPMENT_TEAM` variable (paste it in the Filter field on the right) - click the greenish value - Other... - copy. Now you can pass it in `CMAKE_XCODE_ATTRIBUTE_DEVELOPMENT_TEAM` variable when configuring the project to avoid selecting the team manually every time CMake re-generates the project. To be able to build for iOS device, you must also specify codesigning settings. If you don't know your development team ID, open the generated Xcode project, open project settings (click **VCMI** with blue icon on the very top in the left panel with files), select **vcmiclient** target, open **Signing & Capabilities** tab and select yout team. Now you can copy the value from **Build Settings** tab - `DEVELOPMENT_TEAM` variable (paste it in the Filter field on the right) - click the greenish value - Other... - copy. Now you can pass it in `CMAKE_XCODE_ATTRIBUTE_DEVELOPMENT_TEAM` variable when configuring the project to avoid selecting the team manually every time CMake re-generates the project.

7
docs/developers/Building_macOS.md
View File

@@ -7,7 +7,9 @@
- Xcode IDE: <https://developer.apple.com/xcode/> - Xcode IDE: <https://developer.apple.com/xcode/>
- (not tested) other C++ compilers, e.g. gcc/clang from [Homebrew](https://brew.sh/) - (not tested) other C++ compilers, e.g. gcc/clang from [Homebrew](https://brew.sh/)
2. CMake: `brew install --cask cmake` or get from <https://cmake.org/download/> 2. CMake: `brew install --cask cmake` or get from <https://cmake.org/download/>
3. (optional) Ninja: `brew install ninja` or get from <https://github.com/ninja-build/ninja/releases> 4. Optional:
* Ninja: `brew install ninja` or get it from <https://github.com/ninja-build/ninja/releases>
* CCache to speed up recompilation: `brew install ccache`
# Obtaining source code # Obtaining source code
@@ -69,7 +71,8 @@ Note that if you wish to use Qt Creator IDE, you should skip this step and confi
- if you installed Qt 5 from Homebrew, insert:`$(brew --prefix qt@5)` - if you installed Qt 5 from Homebrew, insert:`$(brew --prefix qt@5)`
- if you installed Qt from Online Installer, insert your path to Qt directory, for example: `/Users/kambala/dev/Qt-libs/5.15.2/Clang64` - if you installed Qt from Online Installer, insert your path to Qt directory, for example: `/Users/kambala/dev/Qt-libs/5.15.2/Clang64`
- example for FFmpeg + Qt 5: `-D "CMAKE_PREFIX_PATH=$(brew --prefix ffmpeg@4);$(brew --prefix qt@5)"` - example for FFmpeg + Qt 5: `-D "CMAKE_PREFIX_PATH=$(brew --prefix ffmpeg@4);$(brew --prefix qt@5)"`
8. now press Return 8. If you want to speed up the recompilation, add `-D ENABLE_CCACHE=ON`
9. Now press Return
# Building project # Building project