update build guide #7167
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -146,25 +146,33 @@ cmake --build build -j $(sysctl -n hw.ncpuonline) | |||||
|
|
||||||
| <details><summary>Windows via MinGW</summary> | ||||||
|
|
||||||
| This section is about compiling binary executables for Windows on a Linux system host via [MinGW](https://www.mingw-w64.org/). It's not about compiling for Windows on a Windows host via MinGW. So you first need a Linux system host. If you don't, you can also try WSL (Windows Subsystem for Linux) on Windows. | ||||||
|
|
||||||
| If you have any problems with the build process, please refer to the configuration files in the `.github/workflows` folder. These files are automatically executed by the [GitHub Actions](https://docs.github.com/en/actions) service to automate the build. Under the environment described by these configuration files, the compilation is more likely to succeed. | ||||||
|
|
||||||
| <details><summary>Installing Windows Subsystem for Linux</summary> | ||||||
|
|
||||||
| If you are building on Windows and do not have WSL already setup this will install WSL and Ubuntu by default (Requires Windows 10 2004 or higher or Windows 11) | ||||||
|
|
||||||
| In an Administrator Command Prompt or Powershell | ||||||
|
|
||||||
| ```pwsh | ||||||
| wsl --install | ||||||
| ``` | ||||||
|
|
||||||
| Reboot | ||||||
|
|
||||||
| Wait for Command Prompt to pop up and say installing when complete enter your new Linux password | ||||||
|
|
||||||
| You can launch WSL anytime by typing wsl or ubuntu in a Command Prompt or Powershell or in the Start Menu launch the Ubuntu App | ||||||
|
|
||||||
| For more about WSL, refer to <https://learn.microsoft.com/en-us/windows/wsl/>. | ||||||
|
|
||||||
| ### Setup git and clone DevilutionX | ||||||
|
|
||||||
| In a WSL terminal run these commands to get the source code for DevilutionX | ||||||
|
|
||||||
| ```bash | ||||||
| sudo apt install git | ||||||
| git clone https://github.com/diasurgical/devilutionx | ||||||
| cd devilutionx | ||||||
|
|
@@ -173,22 +181,30 @@ cd devilutionx | |||||
|
|
||||||
| ### Installing dependencies on WSL, Debian and Ubuntu | ||||||
|
|
||||||
| The following compilation process has been tested on `ubuntu-22.04`. Success is not guaranteed on Linux distributions other than Ubuntu 22. | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. @ZhiZe-ZG Ubuntu's version are YY.MM, there is one every 6 month, and a long term every 2 years. 23.10 = October 2023 So that's why the minor version (month) is important to include and not just the major (year). |
||||||
|
|
||||||
| ### 32-bit | ||||||
|
|
||||||
| Download the necessary tools and libraries. | ||||||
|
|
||||||
| ```bash | ||||||
| # Only tested on Ubuntu 22. This won't work on Ubuntu 24 (they are renamed in Ubuntu 24). | ||||||
|
There was a problem hiding this comment.
Suggested change
This is still the command for these on 24.04 |
||||||
| sudo apt-get install cmake gcc-mingw-w64-i686 g++-mingw-w64-i686 pkg-config-mingw-w64-i686 libz-mingw-w64-dev | ||||||
| ``` | ||||||
|
|
||||||
| Download the 32bit MinGW Development Libraries of [SDL2](https://www.libsdl.org/download-2.0.php) and [Libsodium](https://github.com/jedisct1/libsodium/releases) as well as headers for [zlib](https://zlib.net/zlib-1.2.12.tar.gz) and place them in `/usr/i686-w64-mingw32`. This can be done automatically by running `Packaging/windows/mingw-prep.sh`. | ||||||
|
|
||||||
| ### 64-bit | ||||||
|
|
||||||
| Download the necessary tools and libraries. | ||||||
|
|
||||||
| ```bash | ||||||
| # Only tested on Ubuntu 22. This won't work on Ubuntu 24 (they are renamed in Ubuntu 24). | ||||||
|
There was a problem hiding this comment.
Suggested change
This is still the command for these on 24.04 |
||||||
| sudo apt-get install cmake gcc-mingw-w64-x86-64 g++-mingw-w64-x86-64 pkg-config-mingw-w64-x86-64 libz-mingw-w64-dev | ||||||
| ``` | ||||||
|
|
||||||
| Download the 64bit MinGW Development Libraries of [SDL2](https://www.libsdl.org/download-2.0.php) and [Libsodium](https://github.com/jedisct1/libsodium/releases) as well as headers for [zlib](https://zlib.net/zlib-1.2.12.tar.gz) and place them in `/usr/x86_64-w64-mingw32`. This can be done automatically by running `Packaging/windows/mingw-prep64.sh`. | ||||||
|
|
||||||
| ### Compiling | ||||||
|
|
||||||
| ### 32-bit | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.