BuildingOnLinux.wiki
author Wuzzy
Thu, 07 Apr 2016 19:39:40 +0100
changeset 860 a7ddaecf54f3
parent 798 30c5f1ebd552
child 878 d0a0d8167895
permissions -rw-r--r--
LuaAPI: Put onGameInit variables into neat table
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
494
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
     1
#summary Instructions for building the development version of Hedgewars on GNU/Linux (slight Debian focus)
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
     2
#labels Phase-Implementation,Phase-Deploy,Phase-Support
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
     3
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
     4
= Building on GNU/Linux =
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
     5
== Introduction ==
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
     6
494
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
     7
This page contains both generic and copy-and-paste instructions for a Hedgewars development build.
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
     8
494
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
     9
It has a partial focus on Debian, but this guide attempts to include generic information as well.
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    10
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 686
diff changeset
    11
Also, see https://hedgewars.org/download.html if you are just looking to play latest stable—there’s a good chance it exists for your distribution.
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    12
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    13
== Prerequisites ==
656
70434b3f51a3 minor fixes
sheepluva
parents: 592
diff changeset
    14
The first section contains dependency lists, the second section contain copy-and-paste instructions for Debian and derivatives (Ubuntu, Linux Mint, etc.).
494
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
    15
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
    16
=== Required packages ===
547
6539bd4b663b Bump version numbers.
almikes@aol.com
parents: 536
diff changeset
    17
For a full list see [Dependencies Dependencies].
494
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
    18
509
283791011d7c Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 497
diff changeset
    19
In most Linux distributions, you should find readily available packages.
494
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
    20
656
70434b3f51a3 minor fixes
sheepluva
parents: 592
diff changeset
    21
Please note that for libraries, you also need their development headers. Some distributions (most notably Debian and its derivatives) provide separate packages for the headers.
494
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
    22
509
283791011d7c Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 497
diff changeset
    23
=== Resolving dependencies under Debian and Debian-based systems (e.g. Mint, Ubuntu) ===
494
37952cd70b0d Add generic dependency list for non-Debian users.
almikes@aol.com
parents: 493
diff changeset
    24
These line contain `apt-get` lines you can simply paste into your shell and execute. Please remember to copy the _entire_ `apt-get` lines!
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    25
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    26
{{{
396
d5cb883a1875 g++ wasn't pulled in by the other deps
kyberneticist@gmail.com
parents: 395
diff changeset
    27
sudo apt-get install mercurial cmake g++ qt4-qmake libqt4-dev libsdl1.2-dev libsdl-net1.2-dev libsdl-mixer1.2-dev libsdl-image1.2-dev libsdl-ttf2.0-dev liblua5.1-dev fpc libphysfs-dev fonts-dejavu-core ttf-wqy-zenhei
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    28
}}}
247
kyberneticist@gmail.com
parents: 241
diff changeset
    29
If you want PNG screenshots, add:
kyberneticist@gmail.com
parents: 241
diff changeset
    30
{{{
kyberneticist@gmail.com
parents: 241
diff changeset
    31
sudo apt-get install libpng12-dev
kyberneticist@gmail.com
parents: 241
diff changeset
    32
}}}
kyberneticist@gmail.com
parents: 241
diff changeset
    33
If you want video recording, add:
kyberneticist@gmail.com
parents: 241
diff changeset
    34
{{{
265
b0f68d7fe64e dev version of glut
kyberneticist@gmail.com
parents: 263
diff changeset
    35
sudo apt-get install libavcodec-dev libavformat-dev freeglut3-dev
247
kyberneticist@gmail.com
parents: 241
diff changeset
    36
}}}
kyberneticist@gmail.com
parents: 241
diff changeset
    37
If you want to try building the server as well (requires at least libghc base 4.3 now) try these too:
154
030bb9b4470b Added server build deps
kyberneticist@gmail.com
parents: 131
diff changeset
    38
{{{
387
1fc2f41b3f88 new server dependencies
kyberneticist@gmail.com
parents: 386
diff changeset
    39
sudo apt-get install ghc libghc-binary-dev libghc-bytestring-show-dev libghc-dataenc-dev libghc-deepseq-dev libghc-hslogger-dev libghc-mtl-dev libghc-network-dev libghc-parsec3-dev libghc-utf8-string-dev libghc-vector-dev libghc-random-dev libghc-zlib-dev libghc-sha-dev libghc-entropy-dev
154
030bb9b4470b Added server build deps
kyberneticist@gmail.com
parents: 131
diff changeset
    40
}}}
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    41
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    42
== Fetching the source code ==
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    43
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    44
Below you find instructions for downloading the Hedgewars source code from the development repository.
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    45
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 686
diff changeset
    46
If you have already downloaded and unpacked the source code version of your choice (e.g. the source tarball from the  [https://hedgewars.org/download.html download page]), just {{{cd}}} to your copy of the Hedgewars source in a terminal and go straight to the building section further below.
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    47
----
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    48
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    49
{{{
263
afcb38bfd761 Revert use of build dir. Nice idea, but breaks pas2c and confused people. Esp people who had done this before. For most people, a purge is adequate if they need to clean up. Heck, that's what unc0rr and I apparently do, or we would have noticed the pas2c thing earlier
kyberneticist@gmail.com
parents: 253
diff changeset
    50
mkdir -p ~/games ~/hg/hedgewars/
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    51
cd ~/hg/hedgewars
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 686
diff changeset
    52
hg clone -v https://hg.hedgewars.org/hedgewars/ trunk
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    53
}}}
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    54
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    55
The initial clone of the repository will take a while, is about 628 MiB or so, due to all the multimedia revisions.
333
5b70b52c17c4 Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 332
diff changeset
    56
After that switch to the trunk folder:
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    57
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    58
{{{
263
afcb38bfd761 Revert use of build dir. Nice idea, but breaks pas2c and confused people. Esp people who had done this before. For most people, a purge is adequate if they need to clean up. Heck, that's what unc0rr and I apparently do, or we would have noticed the pas2c thing earlier
kyberneticist@gmail.com
parents: 253
diff changeset
    59
cd trunk
333
5b70b52c17c4 Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 332
diff changeset
    60
}}}
5b70b52c17c4 Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 332
diff changeset
    61
5b70b52c17c4 Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 332
diff changeset
    62
If you want to build the latest release version (so that you can play with other people online) use this command:
5b70b52c17c4 Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 332
diff changeset
    63
{{{
686
9971f0387cd3 bump version
nemo
parents: 656
diff changeset
    64
hg update 0.9.22
333
5b70b52c17c4 Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 332
diff changeset
    65
}}}
547
6539bd4b663b Bump version numbers.
almikes@aol.com
parents: 536
diff changeset
    66
Note. Do *not* run the command above if you want to play the latest development code (currently 0.9.22-dev).
333
5b70b52c17c4 Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 332
diff changeset
    67
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    68
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    69
== Building process ==
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    70
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    71
Now let’s configure and build!
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    72
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    73
If you want to install Hedgewars *just for your user account* run
333
5b70b52c17c4 Edited wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 332
diff changeset
    74
{{{
263
afcb38bfd761 Revert use of build dir. Nice idea, but breaks pas2c and confused people. Esp people who had done this before. For most people, a purge is adequate if they need to clean up. Heck, that's what unc0rr and I apparently do, or we would have noticed the pas2c thing earlier
kyberneticist@gmail.com
parents: 253
diff changeset
    75
cmake -DCMAKE_BUILD_TYPE="DEBUG" -DCMAKE_INSTALL_PREFIX="$HOME/games" -DDATA_INSTALL_DIR="$HOME/games" -DNOSERVER=1
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    76
make install
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    77
}}}
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    78
If you want to install Hedgewars *system-wide* (not recommended for development builds) then run
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    79
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    80
{{{
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    81
cmake -DCMAKE_BUILD_TYPE="RELEASE" -DNOSERVER=1
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    82
sudo make install
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    83
}}}
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    84
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    85
*Important*: If you decided against png-screenshots or video-recording support, please append `-DNOPNG=1` and/or `-DNOVIDEOREC=1` to the cmake command line respectively!
327
16e3a600d6af me VS. wiki syntax
sheepyluva@gmail.com
parents: 326
diff changeset
    86
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    87
If you want to build the server as well, change `-DNOSERVER=1` to `-DNOSERVER=0`
327
16e3a600d6af me VS. wiki syntax
sheepyluva@gmail.com
parents: 326
diff changeset
    88
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    89
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    90
then wait for the build to complete, then run …
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    91
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    92
{{{
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    93
~/games/bin/hedgewars
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    94
}}}
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
    95
or just {{{hedgewars}}} if you did a system-wide install.
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    96
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    97
You can also create a launcher for it on your desktop or on applications menu if you wish, using the `$HOME/games/bin/hedgewars` path
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
    98
493
300f6d2615ce Copy-editing.
almikes@aol.com
parents: 396
diff changeset
    99
== Build latest development code repository updates ==
395
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
   100
2ea04ea4594d Violated wiki page BuildingOnLinux through web user interface.
sheepyluva@gmail.com
parents: 389
diff changeset
   101
If you have built from your repository clone before and now you want to download more recent updates and rebuild Hedgewars with them, then run
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
   102
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
   103
{{{
263
afcb38bfd761 Revert use of build dir. Nice idea, but breaks pas2c and confused people. Esp people who had done this before. For most people, a purge is adequate if they need to clean up. Heck, that's what unc0rr and I apparently do, or we would have noticed the pas2c thing earlier
kyberneticist@gmail.com
parents: 253
diff changeset
   104
cd ~/hg/hedgewars/trunk
afcb38bfd761 Revert use of build dir. Nice idea, but breaks pas2c and confused people. Esp people who had done this before. For most people, a purge is adequate if they need to clean up. Heck, that's what unc0rr and I apparently do, or we would have noticed the pas2c thing earlier
kyberneticist@gmail.com
parents: 253
diff changeset
   105
hg pull -u
afcb38bfd761 Revert use of build dir. Nice idea, but breaks pas2c and confused people. Esp people who had done this before. For most people, a purge is adequate if they need to clean up. Heck, that's what unc0rr and I apparently do, or we would have noticed the pas2c thing earlier
kyberneticist@gmail.com
parents: 253
diff changeset
   106
cmake .
129
751dee35e4f1 Created wiki page with build instruction for ubuntu
vittorio.giovara@gmail.com
parents:
diff changeset
   107
make install
686
9971f0387cd3 bump version
nemo
parents: 656
diff changeset
   108
}}}