Difference between revisions of "Compiling for Windows on Linux"

From The Powder Toy
Jump to: navigation, search
m (add note about --tool not always being necessary)
(Add outdated notice)
 
(16 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
'''ATTENTION: This guide is outdated as of 2021. Please use this guide for building any recent version of the game: [[Building TPT with Meson]]'''
 +
 
This is for Linux users to cross-compile to Windows 32-bit.  
 
This is for Linux users to cross-compile to Windows 32-bit.  
  
Line 10: Line 12:
  
 
'''Ubuntu Users'''
 
'''Ubuntu Users'''
Copy and paste this into your address bar (Firefox):<br>
+
Run the following in a terminal:<br>
''apt:mingw32,mingw32-binutils,mingw32-runtime"
+
<code>sudo apt-get install mingw-w64</code>
  
If it doesn't work, use the following in a terminal:<br>
+
In older recent versions of Ubuntu, try:<br>
<code>sudo apt-get install mingw32 mingw32-binutils mingw32-runtime</code>
+
<code>sudo apt-get install mingw32 mingw32-binutils mingw32-runtime</code>
  
 
'''Debian Users'''
 
'''Debian Users'''
Line 24: Line 26:
 
<code>su -c 'pacman -S mingw32-{gcc,binutils,runtime}'</code>
 
<code>su -c 'pacman -S mingw32-{gcc,binutils,runtime}'</code>
  
After you have installed these, in there should be /usr/XXXX-mingw32msvc , XXXX may be i486, i586, i686 or amd64, but might as well be something else. Anywhere further in this tutorial i will refer to the folder name as $MINGW , for instance /usr/$MINGW/lib
+
After you have installed these, there should be /usr/XXXX-mingw32msvc , XXXX may be i486, i586, i686 or something else. Anywhere further in this tutorial i will refer to the folder name as $MINGW , for instance /usr/$MINGW/lib  
You might actually set such an environment variable for simplicity.
+
You could actually set such an environment variable for simplicity.
 +
 
 +
You will also need to enable the posix threading model, instead of Windows. Run each of these manually and select the -posix variants:<br/>
 +
<code>sudo update-alternatives --config i686-w64-mingw32-gcc<br/></code>
 +
<code>sudo update-alternatives --config i686-w64-mingw32-g++<br/></code>
 +
<code>sudo update-alternatives --config x86_64-w64-mingw32-gcc<br/></code>
 +
<code>sudo update-alternatives --config x86_64-w64-mingw32-g++</code>
 +
 
 +
You will have to include libgcc_s_sjlj-1.dll with your .exe.
  
 
=  Libraries  =
 
=  Libraries  =
 
Next, Powder Toy needs a couple of libraries. There are three ways to get them:
 
Next, Powder Toy needs a couple of libraries. There are three ways to get them:
* Package repositories. This is usually the easiest way, but not all distributions have MinGW versions of all the required libraries in their package repositories
+
* Package repositories. This is sometimes the easiest way, but not all distributions have MinGW versions of all the required libraries in their package repositories
* Download and extract precompiled libraries. However, this wiki page does not currently have links for all the libraries.
+
* Download and extract precompiled libraries. However, you usually cannot statically compile when using this way
* Compile from source. This can be difficult, but there is a script available to help you. You'll need to use this method if you don't want to distribute DLL files with your executables.  
+
* Compile from source. This would normally be difficult, but there is a script available to help you. You'll need to use this method if you don't want to distribute DLL files with your executables.  
  
 
The libraries needed are:
 
The libraries needed are:
* SDL
+
* SDL2
 
* bzip2
 
* bzip2
* pthread
 
 
* Lua (optional - if you don't want to use it, use --nolua option)
 
* Lua (optional - if you don't want to use it, use --nolua option)
 
* FFTW (optional - if you don't want to use it, use --nofft option)
 
* FFTW (optional - if you don't want to use it, use --nofft option)
 +
* curl (optional - if you don't want to use it, use --nohttp option)
  
== Option 1: Package repositories ==
+
== Compiling Libraries==
When using this method, you will usually need to distribute some DLLs to make your builds work. These are normally located in /usr/$MINGW/lib
+
By compiling all the libraries yourself, the final executable will not need any DLLs to run.
 
 
'''openSUSE users'''
 
 
 
Some of the required libraries can be found here:
 
https://build.opensuse.org/project/show?project=windows%3Amingw%3Awin32
 
 
 
Repository URL for package manager:
 
http://download.opensuse.org/repositories/windows:/mingw:/win32/openSUSE_11.4/
 
 
 
== Option 2: Precompiled ==
 
=== Download ===
 
Download the libraries (this is an incomplete list, update this wiki page if you find links for the other libraries):
 
 
 
* [http://www.libsdl.org/release/SDL-devel-1.2.15-mingw32.tar.gz] from [http://www.libsdl.org/ http://www.libsdl.org/]
 
* [http://sourceforge.net/projects/mingw/files/MinGW/Extension/bzip2/bzip2-1.0.6-4/bzip2-1.0.6-4-mingw32-dev.tar.lzma/download bzip2-1.0.6-4-mingw32-dev.tar.lzma] from [http://sourceforge.net/projects/mingw/files/MinGW/Extension/bzip2/ MinGW on SourceForge].
 
* [ftp://sourceware.org/pub/pthreads-win32/pthreads-w32-2-9-1-release.zip] from [http://sourceware.org/pthreads-win32/]
 
 
 
===  Extract  ===
 
 
 
This needs root.
 
 
 
All of these archives have subdirectories called include/ , lib/ and bin/
 
  
Simply copy all files from include/ into /usr/$MINGW/include/ , then all .a files from lib/ into /usr/$MINGW/lib/ , and all .dll from bin/ into folder where your executable will be.
+
Since figuring out all the right commands to cross compile the libraries can be difficult, here is a script that has all the right commands already: [https://raw.githubusercontent.com/The-Powder-Toy/buildserver-snapshot/master/provisioning-files/cross-libs/cross-libs.sh cross-libs.sh]
  
Only exception is pthreads, it is basically the same, except that in the beginning you have to go into Pre-built.2/ , and both lib/ and bin/ have x64/ and x86/ subfolders, since we're compiling for x86 you obviously need that one.
+
Running the script without arguments provides usage instructions. Start by changing the variables at the start of the script to match your MinGW installation. The default values are:<br />
 +
HOST="i686-w64-mingw32" 
 +
MINGW_BIN_PREFIX="i686-w64-mingw32-" 
 +
MINGW_INSTALL_DIR="/usr/i686-w64-mingw32"
 +
<b>On older versions of Debian/Ubuntu,</b> you might change this to: 
 +
HOST="i586-mingw32msvc"
 +
MINGW_BIN_PREFIX="i586-mingw32msvc-"
 +
MINGW_INSTALL_DIR="/usr/i586-mingw32msvc"
  
== Option 3: Building from source ==
+
Please note, if you installed MingW for <b>older recent versions of Ubuntu</b> as shown in step 1, you <u>MUST</u> change these variables.
This is the method to use if you want to use static linking (so that the executable does not need extra DLL files to run).  
 
  
Since figuring out all the right commands to cross compile the libraries can be difficult, here is a script that has all the right commands already: https://raw.github.com/jacksonmj/The-Powder-Toy/master/utility/powder-cross-libs.sh
+
Now compile and install the libraries as follows (they will automatically be downloaded. Simply open a terminal, and enter the following commands):
  
Running the script without arguments provides usage instructions. Start by changing the variables at the start of the script to match your MinGW installation. Then compile and install the libraries as follows (they will automatically be downloaded):
+
<code>./cross-libs.sh make bzip2 fftw lua regex sdl2 zlib curl</code>
  
<code>./powder-cross-libs.sh make bzip2 fftw lua pthread regex sdl zlib</code>
+
<code>sudo ./cross-libs.sh install bzip2 fftw lua regex sdl2 zlib curl</code>
  
<code>sudo ./powder-cross-libs.sh install bzip2 fftw lua pthread regex sdl zlib</code>
+
If the script doesn't run, you need to allow the file to be run as an executable. To do this, use <code>chmod +x cross-libs.sh</code>
  
 
=  Compile  =
 
=  Compile  =
Some SConscript changes may be needed.
+
It should be as simple as
 +
<code>scons --win</code>
  
It should be as simple as
+
Some SConscript changes may be needed if the name of your cross compiler isn't standard (or just not listed in the SConscript). If it does not detect your cross compiler, try using:
<code>scons --win --tool=$MINGW-</code>
+
<code>scons --win --tool=$MINGW-</code><br />
Notice the dash, if for you $MINGW is i586-mingw32msvc you should pass --tool=i586-mingw32msvc-. The SConscript now auto-detects some cross compilers such as the one used in this guide, so you may be able to just <code>scons --win</code>
+
Notice the dash, if for you $MINGW is i586-mingw32msvc you should pass <code>--tool=i586-mingw32msvc-</code>.
  
 
If you have problems with initial libraries lookup, it is useful to check config.log for obvious failures.
 
If you have problems with initial libraries lookup, it is useful to check config.log for obvious failures.

Latest revision as of 08:58, 3 April 2021

ATTENTION: This guide is outdated as of 2021. Please use this guide for building any recent version of the game: Building TPT with Meson

This is for Linux users to cross-compile to Windows 32-bit.

BEFORE WE START, PLEASE MAKE SURE YOU CAN COMPILE FOR LINUX FIRST!

Packages

First, install the basic packages needed for cross compiling.

Search for the following in your package manager: mingw32 mingw32-binutils mingw32-runtime

Ubuntu Users Run the following in a terminal:
sudo apt-get install mingw-w64

In older recent versions of Ubuntu, try:
sudo apt-get install mingw32 mingw32-binutils mingw32-runtime

Debian Users In a terminal:
su -c "apt-get install mingw32 mingw32-binutils mingw32-runtime"

Arch Users In your Terminal:
su -c 'pacman -S mingw32-{gcc,binutils,runtime}'

After you have installed these, there should be /usr/XXXX-mingw32msvc , XXXX may be i486, i586, i686 or something else. Anywhere further in this tutorial i will refer to the folder name as $MINGW , for instance /usr/$MINGW/lib You could actually set such an environment variable for simplicity.

You will also need to enable the posix threading model, instead of Windows. Run each of these manually and select the -posix variants:
sudo update-alternatives --config i686-w64-mingw32-gcc
sudo update-alternatives --config i686-w64-mingw32-g++
sudo update-alternatives --config x86_64-w64-mingw32-gcc
sudo update-alternatives --config x86_64-w64-mingw32-g++

You will have to include libgcc_s_sjlj-1.dll with your .exe.

Libraries

Next, Powder Toy needs a couple of libraries. There are three ways to get them:

  • Package repositories. This is sometimes the easiest way, but not all distributions have MinGW versions of all the required libraries in their package repositories
  • Download and extract precompiled libraries. However, you usually cannot statically compile when using this way
  • Compile from source. This would normally be difficult, but there is a script available to help you. You'll need to use this method if you don't want to distribute DLL files with your executables.

The libraries needed are:

  • SDL2
  • bzip2
  • Lua (optional - if you don't want to use it, use --nolua option)
  • FFTW (optional - if you don't want to use it, use --nofft option)
  • curl (optional - if you don't want to use it, use --nohttp option)

Compiling Libraries

By compiling all the libraries yourself, the final executable will not need any DLLs to run.

Since figuring out all the right commands to cross compile the libraries can be difficult, here is a script that has all the right commands already: cross-libs.sh

Running the script without arguments provides usage instructions. Start by changing the variables at the start of the script to match your MinGW installation. The default values are:

HOST="i686-w64-mingw32"  
MINGW_BIN_PREFIX="i686-w64-mingw32-"  
MINGW_INSTALL_DIR="/usr/i686-w64-mingw32" 

On older versions of Debian/Ubuntu, you might change this to:

HOST="i586-mingw32msvc"
MINGW_BIN_PREFIX="i586-mingw32msvc-"
MINGW_INSTALL_DIR="/usr/i586-mingw32msvc"

Please note, if you installed MingW for older recent versions of Ubuntu as shown in step 1, you MUST change these variables.

Now compile and install the libraries as follows (they will automatically be downloaded. Simply open a terminal, and enter the following commands):

./cross-libs.sh make bzip2 fftw lua regex sdl2 zlib curl

sudo ./cross-libs.sh install bzip2 fftw lua regex sdl2 zlib curl

If the script doesn't run, you need to allow the file to be run as an executable. To do this, use chmod +x cross-libs.sh

Compile

It should be as simple as scons --win

Some SConscript changes may be needed if the name of your cross compiler isn't standard (or just not listed in the SConscript). If it does not detect your cross compiler, try using: scons --win --tool=$MINGW-
Notice the dash, if for you $MINGW is i586-mingw32msvc you should pass --tool=i586-mingw32msvc-.

If you have problems with initial libraries lookup, it is useful to check config.log for obvious failures.

If when linking it gives you an error like

/usr/lib/gcc/i586-mingw32msvc/4.2.1-sjlj/libstdc++.a(stubs.o):(.text+0x540): multiple definition of `_coshf'

build/src/Misc.o:Misc.cpp:(.text$coshf[_coshf]+0x0): first defined here

do this (under root):

cd /usr/lib/gcc/$MINGW/4.2.1-sjlj/

$MINGW-ar -d libstdc++.a stubs.o

If this tutorial has any obvious (and not very obvious) failures, feel free to edit.