Dependencies.wiki
author Wuzzy
Fri, 19 Apr 2019 16:07:50 +0100
changeset 1831 365c30b4c669
parent 1690 ddfe686b9c66
child 1892 e9ec12d8d741
permissions -rw-r--r--
LuaGears: Add temporary mistake to test documentation script
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1101
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
     1
#summary List of programs and libraries for building and/or running Hedgewars
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
     2
761
c3cc847195be Dependencies: Fix header levels
Wuzzy
parents: 542
diff changeset
     3
= Dependencies =
1101
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
     4
== Dependencies for fetching latest source code ==
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
     5
If you want to get the source code from the mercurial repository, you'll need these.
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
     6
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
     7
|| *Name* || *Homepage* ||
1104
07b25c5508dd Dependencies: HTTPS
Wuzzy
parents: 1103
diff changeset
     8
|| Mercurial || [https://www.mercurial-scm.org/] ||
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
     9
761
c3cc847195be Dependencies: Fix header levels
Wuzzy
parents: 542
diff changeset
    10
== Build-only dependencies ==
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    11
You need these packages to build Hedgewars, but not afterwards.
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    12
1100
7e1f1bf5b955 Dependencies: Update for current dev
Wuzzy
parents: 972
diff changeset
    13
|| *Name* || *Version* (Latest HW release) || *Version* (Unstable) || *Homepage* ||
1104
07b25c5508dd Dependencies: HTTPS
Wuzzy
parents: 1103
diff changeset
    14
|| CMake || 2.6 || 2.6 || [https://www.cmake.org/] ||
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    15
761
c3cc847195be Dependencies: Fix header levels
Wuzzy
parents: 542
diff changeset
    16
== Core dependencies ==
1101
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
    17
You need these programs and libraries to build and run Hedgewars.
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    18
Note: You will need the development headers of the libraries for building only.
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    19
1100
7e1f1bf5b955 Dependencies: Update for current dev
Wuzzy
parents: 972
diff changeset
    20
|| *Name* || *Version* (Latest HW release) || *Version* (Unstable) || *Homepage* ||
1324
bb87061fc23f Dependencies: update qt version
Wuzzy
parents: 1277
diff changeset
    21
|| Qt || 5.0.0 || 5.0.0 || [https://www.qt.io/] ||
1110
f7bfa40bdbc5 Dependencies: Update versions
Wuzzy
parents: 1104
diff changeset
    22
|| SDL || 2.0 || 2.0 || [https://libsdl.org/] ||
f7bfa40bdbc5 Dependencies: Update versions
Wuzzy
parents: 1104
diff changeset
    23
|| SDL_net || 2.0 || 2.0 || [https://libsdl.org/] ||
f7bfa40bdbc5 Dependencies: Update versions
Wuzzy
parents: 1104
diff changeset
    24
|| SDL_mixer || 2.0 || 2.0 || [https://libsdl.org/] ||
f7bfa40bdbc5 Dependencies: Update versions
Wuzzy
parents: 1104
diff changeset
    25
|| SDL_image || 2.0 || 2.0 || [https://libsdl.org/] ||
1104
07b25c5508dd Dependencies: HTTPS
Wuzzy
parents: 1103
diff changeset
    26
|| SDL_TTF || 2.0 || 2.0 || [https://libsdl.org/] ||
07b25c5508dd Dependencies: HTTPS
Wuzzy
parents: 1103
diff changeset
    27
|| FPC (Free Pascal Compiler) || 2.2.4 || 2.2.4 || [https://freepascal.org/] ||
1690
ddfe686b9c66 physfs was removed from the repo
nemo
parents: 1660
diff changeset
    28
|| PhysFS || 3.0.0 || 3.0.0 || [https://icculus.org/physfs/] ||
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    29
1264
28d3bf0701a5 Dependencies: Update for qt5transition
Wuzzy
parents: 1110
diff changeset
    30
== Recommended dependency ==
28d3bf0701a5 Dependencies: Update for qt5transition
Wuzzy
parents: 1110
diff changeset
    31
This is not strictly required, but recommended:
28d3bf0701a5 Dependencies: Update for qt5transition
Wuzzy
parents: 1110
diff changeset
    32
28d3bf0701a5 Dependencies: Update for qt5transition
Wuzzy
parents: 1110
diff changeset
    33
|| *Name* || *Homepage* ||
28d3bf0701a5 Dependencies: Update for qt5transition
Wuzzy
parents: 1110
diff changeset
    34
|| qtstyleplugins || [https://github.com/qt/qtstyleplugins] ||
28d3bf0701a5 Dependencies: Update for qt5transition
Wuzzy
parents: 1110
diff changeset
    35
761
c3cc847195be Dependencies: Fix header levels
Wuzzy
parents: 542
diff changeset
    36
== Bundled dependencies ==
1101
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
    37
You can build/run Hedgewars using these packages from your system or use those that come with the Hedgewars source:
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    38
1100
7e1f1bf5b955 Dependencies: Update for current dev
Wuzzy
parents: 972
diff changeset
    39
|| *Name* || *Version* (Latest HW release) || *Version* (Unstable) || *Homepage* ||
1104
07b25c5508dd Dependencies: HTTPS
Wuzzy
parents: 1103
diff changeset
    40
|| Lua || 5.1 (exactly) || 5.1 (exactly) || [https://www.lua.org/] ||
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    41
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    42
Bundled Fonts:
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    43
|| *Name* || *Homepage* || *Comment* ||
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    44
|| !DejaVu Sans Bold || [http://dejavu-fonts.org/] || — ||
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    45
|| Zen Hei || [http://wenq.org/] || From the !WenQuanYi project. Font is internally known as “wgy-zenhei” ||
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    46
761
c3cc847195be Dependencies: Fix header levels
Wuzzy
parents: 542
diff changeset
    47
== Optional dependencies ==
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    48
You don’t need to install these packages to build Hedgewars, but if you don’t, some features will be missing.
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    49
1101
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
    50
=== For PNG screenshots ===
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    51
|| *Name* || *Version* || *Homepage* ||
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    52
|| libpng || 1.2 || [http://www.libpng.org/pub/png/libpng.html] ||
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    53
1101
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
    54
=== Video recording ===
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
    55
For the video recorder, you need either FFmpeg _or_ Libav. And FreeGLUT.
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
    56
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    57
|| *Name* || *Version* || *Homepage* ||
1104
07b25c5508dd Dependencies: HTTPS
Wuzzy
parents: 1103
diff changeset
    58
|| FFmpeg || ??? || [https://ffmpeg.org/] ||
1102
20695a9da988 Dependencies: fix link
Wuzzy
parents: 1101
diff changeset
    59
|| Libav || ??? || [https://libav.org/] ||
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    60
|| FreeGLUT || 3.0 || [http://freeglut.sourceforge.net/] ||
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    61
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    62
*Note*: See also VideoRecorder for detailed instructions to build the video recorder.
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    63
1101
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
    64
=== Server ===
172cf3112fde Dependencies: Update optdepends
Wuzzy
parents: 1100
diff changeset
    65
The server is built seperately. If you want to build the server you need a couple of Haskell-related packages. First you need GHC:
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    66
|| *Name* || *Version* || *Homepage* ||
537
9c9c528bd61b It’s “Glasgow Haskell Compiler” not “Gnu Haskell Compiler” :D
almikes@aol.com
parents: 516
diff changeset
    67
|| GHC (Glasgow Haskell Compiler) || 6.10 || [https://www.haskell.org/ghc/] ||
508
b0bc67eefc73 new page
sheepyluva@gmail.com
parents:
diff changeset
    68
1690
ddfe686b9c66 physfs was removed from the repo
nemo
parents: 1660
diff changeset
    69
Then you need a couple of Haskell software. Please refer to [http://hg.hedgewars.org/hedgewars/file/tip/INSTALL.md INSTALL.md] for a list.