Unvanquished - User contributions [en-gb]

Template:Mapping tools compatibility

2025-12-22T20:39:11Z

Cu-kai: change to a better "basic" tick.

Mapping tools compatibility on <code>2025-12-06</code>:

* Tools compatibility, 🏆️🏆️🏆️+ = best support, 🥈️ experienced mappers can do something with it, 🚫 = doesn't work.
* Features compatibility: ✅ = yes, ☑️ = yes (basic), ❌ = no, ❗ = incomplete, ❔ = to be verified, ⬛ = not applicable.
* Mapping against released build: <code>pkg</code>, mapping against sources: <code>src</code>.

{|
|-
! colspan="2" | Tool
! colspan="2" | Mapping against
! colspan="3" | Filesystem
! colspan="2" | Support
! colspan="2" | Q3 map
! colspan="4" | Image formats
! colspan="2" | Model formats
! colspan="3" | Extra maps
|-
! Name
! Kind
! <code>pkg</code>
! <code>src</code>
! PakPath
! DPK
! DPKdir
! Gamepack
! Entities
! brush
! patch
! material
! PNG
! WebP
! CRN
! MD3
! IQM
! deluxe
! mini
|-
! rowspan="2" | NetRadiant 🏆️🏆️🏆️🏆️🏆️
! editor
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ☑️
| ✅
| ✅
| ✅
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ✅
| ✅
| ✅
| ☑️✠
| ☑️✠
| ✅
| ✅
| ✅
| ✅
| ☑️
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
|-
! rowspan="2" | NetRadiant Custom 🏆️🏆️🏆️
! editor
| ✅
| ✅
| ❔
| ☑️✠
| ☑️✠
| ✅
| ✅
| ✅
| ✅
| ☑️
| ✅
| ✅
| ✅
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ✅
| ✅
| ❔
| ☑️✠
| ☑️✠
| ✅
| ✅
| ✅
| ✅
| ☑️
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
|-
! rowspan="2" | GtkRadiant 🥈️
! editor
| ❌
| ☑️
| ❌
| ☑️
| ☑️
| ✅
| ✅
| ✅
| ✅
| ☑️
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ❌
| ❗
| ❌
| ☑️
| ☑️
| ✅
| ✅
| ✅
| ✅
| ☑️
| ✅
| ❌
| ❌
| ✅
| ✅
| ❌
| ❌
|-
! rowspan="1" | DarkRadiant 🥈️
! editor
| ❌
| ☑️
| ❌
| ☑️
| ☑️
| ✅
| ✅
| ✅
| ✅
| ☑️
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|-

! rowspan="1" | TrenchBroom 🚫
! editor
| ❌
| ❌
| ❌
| ☑️
| ❌
| ✅
| ✅
| ✅
| ✅
| ❌
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|}

* ✠ DEPS support is not present.

Template:Mapping tools compatibility

2025-12-06T21:31:22Z

Cu-kai: netradiant-custom now creates minimaps

Mapping tools compatibility on <code>2025-12-06</code>:

* Tools compatibility, 🏆️🏆️🏆️+ = best support, 🥈️ experienced mappers can do something with it, 🚫 = doesn't work.
* Features compatibility: ✅ = yes, 🮱 = yes (basic), ❌ = no, ❗ = incomplete, ❔ = to be verified, ⬛ = not applicable.
* Mapping against released build: <code>pkg</code>, mapping against sources: <code>src</code>.

{|
|-
! colspan="2" | Tool
! colspan="2" | Mapping against
! colspan="3" | Filesystem
! colspan="2" | Support
! colspan="2" | Q3 map
! colspan="4" | Image formats
! colspan="2" | Model formats
! colspan="3" | Extra maps
|-
! Name
! Kind
! <code>pkg</code>
! <code>src</code>
! PakPath
! DPK
! DPKdir
! Gamepack
! Entities
! brush
! patch
! material
! PNG
! WebP
! CRN
! MD3
! IQM
! deluxe
! mini
|-
! rowspan="2" | NetRadiant 🏆️🏆️🏆️🏆️🏆️
! editor
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ✅
| ✅
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ✅
| ✅
| ✅
| 🮱✠
| 🮱✠
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
|-
! rowspan="2" | NetRadiant Custom 🏆️🏆️🏆️
! editor
| ✅
| ✅
| ❔
| 🮱✠
| 🮱✠
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ✅
| ✅
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ✅
| ✅
| ❔
| 🮱✠
| 🮱✠
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
|-
! rowspan="2" | GtkRadiant 🥈️
! editor
| ❌
| 🮱
| ❌
| 🮱
| 🮱
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ❌
| ❗
| ❌
| 🮱
| 🮱
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ❌
| ❌
| ✅
| ✅
| ❌
| ❌
|-
! rowspan="1" | DarkRadiant 🥈️
! editor
| ❌
| 🮱
| ❌
| 🮱
| 🮱
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|-

! rowspan="1" | TrenchBroom 🚫
! editor
| ❌
| ❌
| ❌
| 🮱
| ❌
| ✅
| ✅
| ✅
| ✅
| ❌
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|}

* ✠ DEPS support is not present.

Tools/Level editors

2025-12-06T17:02:08Z

Cu-kai: mention NRC in the "recommended you start" section.

[[Category:Tools]]
[[Category:Mapping]]
Making maps for Unvanquished requires some tools. They are all free.

{{Recommended level editor|page=true}}

See [[Tutorials/Getting started with NetRadiant|Getting started with NetRadiant]] for installing it and getting started.

=Recommended tool load-out=

You need:

* The '''[https://unvanquished.net/download/ Unvanquished game]''' itself, prefer installing the game with the [[Unvanquished launcher]],
* The '''[https://netradiant.gitlab.io NetRadiant level editor]''', it's a level editor based on id Software's GtkRadiant and maintained by the community with a focus on game compatibility,
* The '''Unvanquished editor gamepack''' (provided with NetRadiant),
* The '''Q3Map2 map compiler''' (provided with NetRadiant).

When using another editor than NetRadiant (like GtkRadiant, see below), you may still need a gamepack, and you would still need the Q3Map2 tool tools from NetRadiant: if another Radiant provides Q3Map2 don't use it, use the one from NetRadiant instead.

==Level editors==

'''Brush based''' editors require you to make your maps using [https://en.wikipedia.org/wiki/Constructive_solid_geometry constructive solid geometry] (CSG). Most mapping tutorials for Quake-like games such as Unvanquished follow this method.

'''Polygon based''' editors give a larger focus on 2D shapes making up 3D ones, which ''can'' be more powerful but is more difficult to teach and learn. These editors generally support ''boolean operations'', allowing them to be used like CSG editors, but with more difficulty.

{{Note|header=About DarkRadiant and GtkRadiant|content=It is recommended that you start with [https://netradiant.gitlab.io/ NetRadiant] or [https://garux.github.io/NRC/ NetRadiant Custom].

# It's possible to map for Unvanquished using tools like '''GtkRadiant''' and '''DarkRadiant''', they are good enough but will require you to map and build against the {{Game data}} source repositories.
# Such sources repositories are required to be prepared with {{Tools|Urcheon}} (to generate {{code|.shader}} {{Formats|Material}} files and {{Formats|IQM}} models), this requires much more tools and more knowledge.
# The integration of Unvanquished in ''GtkRadiant'' and ''DarkRadiant'' is less polished so configuring them would assume more prerequisite knowledge from you.

If you find the gap to NetRadiant high, then it's good for you to know the gap to others will be much higher.}}

{{Mapping tools compatibility}}

{{Mapping tools support}}

Template:Mapping tools support

2025-12-06T17:00:34Z

Cu-kai: added a note about the warning triangle

Mapping tools support on <code>2025-12-06</code> (✅ = yes, ❌ = no, ⚠️ = see note)

{| class="wikitable progress"
|-
! colspan="8" | Recommended and supported 🏆️🏆️🏆️🏆️🏆️
|-
! rowspan="2" | Program
! rowspan="2" | Mapping method
! rowspan="2" | Libre
! colspan="3" | Supported Operating Systems
! rowspan="2" | Last stable release
! rowspan="2" | Notes
|-
! macOS
! Windows
! Linux
|-
! [https://netradiant.gitlab.io/ NetRadiant]
| Brushes
| class="done" | ✅
| class="done" | ✅ amd64
| class="done" | ✅ i686 ✅ amd64
| class="done" | ⚠️ amd64
| Current (2022)
| Recommended and supported brush-based editor. It works out of the box with released game assets. You need this editor to contribute to official Unvanquished maps. Here is the [https://netradiant.gitlab.io/page/download/ download page] for many operating systems. Arch Linux users can use the [https://aur.archlinux.org/packages/netradiant-git netradiant-git] PKGBUILD in the AUR. ⚠️ Note that due to GTK2 and gtkglext2 deprecation this no longer builds from source on modern Linux without additional effort/changes. There is an experimental GTK3 port which is presently suffering performance problems.
|-
! [https://github.com/Garux/netradiant-custom/ NetRadiant-custom] (Garux's fork)
| Brushes
| class="done" | ✅
| class="none" | ✅ amd64 ✅ aarch64
| class="done" | ✅ amd64
| class="done" | ✅ amd64 ✅ aarch64
| Current (2025)
| Fork of NetRadiant based on an old branch (diverged in around 2014) but with additional features. Usually the preferred editor by mappers for other ioq3 based games. Actively maintained as of 2025 and is now based on the Qt framework.
|-
! colspan=8 | Working fallback 🥈️
|-
! [http://icculus.org/gtkradiant/ GtkRadiant]
| Brushes
| class="done" | ✅
| class="done" | ✅ source
| class="done" | ✅ i686 ✅ amd64
| class="done" | ✅ source
| 1.6.6 (2018)
| Predecessor of NetRadiant. Brush based. It has basic DPKdir support but no CRN/WebP support. It can be used with assets repositories. It must be used with q3map2 from NetRadiant because the one provided with GtkRadiant does not support all the features. While the map compiler may provide an usable build, it will not get all features and maps will not look the expected way.
|-
! [https://www.darkradiant.net/ DarkRadiant]
| Brushes
| class="done" | ✅
| class="done" | ✅ amd64
| class="done" | ✅ amd64
| class="done" | ✅ i686 
| Current (2022)
| Designed for a Doom 3 mod. Basic dpk/dpkdir support. It must be used with q3map2 from NetRadiant because q3map2 is not shipped with DarkRadiant. Linux users can use the [https://flathub.org/apps/details/net.darkradiant.DarkRadiant flatpak].
|-
! colspan=8 | Incomplete 🚫
|-
! [https://kristianduske.com/trenchbroom/ TrenchBroom]
| Brushes
| class="done" | ✅
| class="done" | ✅ amd64
| class="done" | ✅ i686 ✅ amd64
| class="done" | ✅ amd64
| Current (2022)
| Editor for Quake 1 maps, Quake 3 formats are work in progress. Not a Radiant derivative.
|-
! [http://quark.sourceforge.net/ QuArK]
| Brushes
| class="done" | ✅
| class="none" | ❌
| class="done" | ✅ i686
| class="none" | ❌
| Current (2021)
| An all in one Quake editor, capable of much more than mapping.
|-
! [http://jack.hlfx.ru/en/main.html J.A.C.K.]
| Brushes
| class="none" | ❌
| class="none" | ❌
| class="done" | ✅ i686
| class="done" | ✅ i686 ✅ amd64
| 1.1.1064 (2016)
| Previously named Jackhammer. Designed for Half-Life and some id Tech engines, the map format is different (''map220'') and needs a modified q3map2 to be compiled. Interface seems to share similarities with Radiant or Hammer.
|-
! [https://www.blender.org/ Blender]
| Polygons
| class="done" | ✅
| class="done" | ✅ amd64
| class="done" | ✅ amd64
| class="done" | ✅ amd64
| Current (2022)
| Extremely popular and open-source polygon based modelling tool. See the [http://www.katsbits.com/tutorials/blender/map-basics-tutorial.php katsbits tutorial] for getting it to work with Unvanquished. Don't expect it to be straightforward. Even if you're a Blender guru it's probably less work for you to learn NetRadiant from scratch.
|-
! colspan=8 | Obsolete 🚫
|-
! [http://ingar.intranifty.net/gtkradiant/ NetRadiant] (Ingar's builds)
| Brushes
| class="done" | ✅
| class="done" | ✅ i686
| class="done" | ✅ i686
| class="done" | ✅ i686 ✅ amd64
| 2015
| Mac users need X11 (10.7 users can get this from the [http://xquartz.macosforge.org/landing/ XQuartz project]). Gamepack must be installed by hand.
|-
! [https://web.archive.org/web/20190102160351/http://redsaurus.net:80/blog/?page_id=8 MacRadiant]
| Brushes
| class="done" | ✅
| class="done" | ✅ i686 ✅ ppc
| class="none" | ❌
| class="none" | ❌
| Abandonned (2006)
| Problems have been reported with Snow Leopard and Leopard, though there are workarounds. See the download page for more information.
|-
! [http://www.milkshape3d.com/ Milkshape 3D]
| Brushes
| class="none" | ❌
| class="none" | ❌
| class="done" | ✅ i686 
| class="none" | ❌
| Abandoned (2011)
| Designed originally for Half Life
|-
! [https://www.turbosquid.com/gmax Gmax]
| Polygons
| class="none" | ❌
| class="none" | ❌
| class="done" | ✅ i686 
| class="none" | ❌
| Abandoned (2005)
| Freeware version of polygon-based modelling tool 3ds Max. Used by many games but never updated: small bugs exist. May require a registration bypass to work (easily found) as the registration web-form has disappeared.
|-
|}

Template:Mapping tools support

2025-12-06T16:59:35Z

Cu-kai: netradiant-custom now works for unvanquished. upstream netradiant no longer compiles on modern linux.

Mapping tools support on <code>2025-12-06</code> (✅ = yes, ❌ = no)

{| class="wikitable progress"
|-
! colspan="8" | Recommended and supported 🏆️🏆️🏆️🏆️🏆️
|-
! rowspan="2" | Program
! rowspan="2" | Mapping method
! rowspan="2" | Libre
! colspan="3" | Supported Operating Systems
! rowspan="2" | Last stable release
! rowspan="2" | Notes
|-
! macOS
! Windows
! Linux
|-
! [https://netradiant.gitlab.io/ NetRadiant]
| Brushes
| class="done" | ✅
| class="done" | ✅ amd64
| class="done" | ✅ i686 ✅ amd64
| class="done" | ⚠️ amd64
| Current (2022)
| Recommended and supported brush-based editor. It works out of the box with released game assets. You need this editor to contribute to official Unvanquished maps. Here is the [https://netradiant.gitlab.io/page/download/ download page] for many operating systems. Arch Linux users can use the [https://aur.archlinux.org/packages/netradiant-git netradiant-git] PKGBUILD in the AUR. ⚠️ Note that due to GTK2 and gtkglext2 deprecation this no longer builds from source on modern Linux without additional effort/changes. There is an experimental GTK3 port which is presently suffering performance problems.
|-
! [https://github.com/Garux/netradiant-custom/ NetRadiant-custom] (Garux's fork)
| Brushes
| class="done" | ✅
| class="none" | ✅ amd64 ✅ aarch64
| class="done" | ✅ amd64
| class="done" | ✅ amd64 ✅ aarch64
| Current (2025)
| Fork of NetRadiant based on an old branch (diverged in around 2014) but with additional features. Usually the preferred editor by mappers for other ioq3 based games. Actively maintained as of 2025 and is now based on the Qt framework.
|-
! colspan=8 | Working fallback 🥈️
|-
! [http://icculus.org/gtkradiant/ GtkRadiant]
| Brushes
| class="done" | ✅
| class="done" | ✅ source
| class="done" | ✅ i686 ✅ amd64
| class="done" | ✅ source
| 1.6.6 (2018)
| Predecessor of NetRadiant. Brush based. It has basic DPKdir support but no CRN/WebP support. It can be used with assets repositories. It must be used with q3map2 from NetRadiant because the one provided with GtkRadiant does not support all the features. While the map compiler may provide an usable build, it will not get all features and maps will not look the expected way.
|-
! [https://www.darkradiant.net/ DarkRadiant]
| Brushes
| class="done" | ✅
| class="done" | ✅ amd64
| class="done" | ✅ amd64
| class="done" | ✅ i686 
| Current (2022)
| Designed for a Doom 3 mod. Basic dpk/dpkdir support. It must be used with q3map2 from NetRadiant because q3map2 is not shipped with DarkRadiant. Linux users can use the [https://flathub.org/apps/details/net.darkradiant.DarkRadiant flatpak].
|-
! colspan=8 | Incomplete 🚫
|-
! [https://kristianduske.com/trenchbroom/ TrenchBroom]
| Brushes
| class="done" | ✅
| class="done" | ✅ amd64
| class="done" | ✅ i686 ✅ amd64
| class="done" | ✅ amd64
| Current (2022)
| Editor for Quake 1 maps, Quake 3 formats are work in progress. Not a Radiant derivative.
|-
! [http://quark.sourceforge.net/ QuArK]
| Brushes
| class="done" | ✅
| class="none" | ❌
| class="done" | ✅ i686
| class="none" | ❌
| Current (2021)
| An all in one Quake editor, capable of much more than mapping.
|-
! [http://jack.hlfx.ru/en/main.html J.A.C.K.]
| Brushes
| class="none" | ❌
| class="none" | ❌
| class="done" | ✅ i686
| class="done" | ✅ i686 ✅ amd64
| 1.1.1064 (2016)
| Previously named Jackhammer. Designed for Half-Life and some id Tech engines, the map format is different (''map220'') and needs a modified q3map2 to be compiled. Interface seems to share similarities with Radiant or Hammer.
|-
! [https://www.blender.org/ Blender]
| Polygons
| class="done" | ✅
| class="done" | ✅ amd64
| class="done" | ✅ amd64
| class="done" | ✅ amd64
| Current (2022)
| Extremely popular and open-source polygon based modelling tool. See the [http://www.katsbits.com/tutorials/blender/map-basics-tutorial.php katsbits tutorial] for getting it to work with Unvanquished. Don't expect it to be straightforward. Even if you're a Blender guru it's probably less work for you to learn NetRadiant from scratch.
|-
! colspan=8 | Obsolete 🚫
|-
! [http://ingar.intranifty.net/gtkradiant/ NetRadiant] (Ingar's builds)
| Brushes
| class="done" | ✅
| class="done" | ✅ i686
| class="done" | ✅ i686
| class="done" | ✅ i686 ✅ amd64
| 2015
| Mac users need X11 (10.7 users can get this from the [http://xquartz.macosforge.org/landing/ XQuartz project]). Gamepack must be installed by hand.
|-
! [https://web.archive.org/web/20190102160351/http://redsaurus.net:80/blog/?page_id=8 MacRadiant]
| Brushes
| class="done" | ✅
| class="done" | ✅ i686 ✅ ppc
| class="none" | ❌
| class="none" | ❌
| Abandonned (2006)
| Problems have been reported with Snow Leopard and Leopard, though there are workarounds. See the download page for more information.
|-
! [http://www.milkshape3d.com/ Milkshape 3D]
| Brushes
| class="none" | ❌
| class="none" | ❌
| class="done" | ✅ i686 
| class="none" | ❌
| Abandoned (2011)
| Designed originally for Half Life
|-
! [https://www.turbosquid.com/gmax Gmax]
| Polygons
| class="none" | ❌
| class="none" | ❌
| class="done" | ✅ i686 
| class="none" | ❌
| Abandoned (2005)
| Freeware version of polygon-based modelling tool 3ds Max. Used by many games but never updated: small bugs exist. May require a registration bypass to work (easily found) as the registration web-form has disappeared.
|-
|}

Tools/Level editors

2025-12-06T16:49:44Z

Cu-kai: netradiant-custom is now supported

[[Category:Tools]]
[[Category:Mapping]]
Making maps for Unvanquished requires some tools. They are all free.

{{Recommended level editor|page=true}}

See [[Tutorials/Getting started with NetRadiant|Getting started with NetRadiant]] for installing it and getting started.

=Recommended tool load-out=

You need:

* The '''[https://unvanquished.net/download/ Unvanquished game]''' itself, prefer installing the game with the [[Unvanquished launcher]],
* The '''[https://netradiant.gitlab.io NetRadiant level editor]''', it's a level editor based on id Software's GtkRadiant and maintained by the community with a focus on game compatibility,
* The '''Unvanquished editor gamepack''' (provided with NetRadiant),
* The '''Q3Map2 map compiler''' (provided with NetRadiant).

When using another editor than NetRadiant (like GtkRadiant, see below), you may still need a gamepack, and you would still need the Q3Map2 tool tools from NetRadiant: if another Radiant provides Q3Map2 don't use it, use the one from NetRadiant instead.

==Level editors==

'''Brush based''' editors require you to make your maps using [https://en.wikipedia.org/wiki/Constructive_solid_geometry constructive solid geometry] (CSG). Most mapping tutorials for Quake-like games such as Unvanquished follow this method.

'''Polygon based''' editors give a larger focus on 2D shapes making up 3D ones, which ''can'' be more powerful but is more difficult to teach and learn. These editors generally support ''boolean operations'', allowing them to be used like CSG editors, but with more difficulty.

{{Note|header=About DarkRadiant and GtkRadiant|content=It is recommended that you start with [https://netradiant.gitlab.io/ NetRadiant].

# It's possible to map for Unvanquished using tools like '''GtkRadiant''' and '''DarkRadiant''', they are good enough but will require you to map and build against the {{Game data}} source repositories.
# Such sources repositories are required to be prepared with {{Tools|Urcheon}} (to generate {{code|.shader}} {{Formats|Material}} files and {{Formats|IQM}} models), this requires much more tools and more knowledge.
# The integration of Unvanquished in ''GtkRadiant'' and ''DarkRadiant'' is less polished so configuring them would assume more prerequisite knowledge from you.

If you find the gap to NetRadiant high, then it's good for you to know the gap to others will be much higher.}}

{{Mapping tools compatibility}}

{{Mapping tools support}}

Template:Mapping tools compatibility

2025-12-06T16:49:14Z

Cu-kai: netradiant-custom can now edit and build unvanquished maps.

Mapping tools compatibility on <code>2025-12-06</code>:

* Tools compatibility, 🏆️🏆️🏆️+ = best support, 🥈️ experienced mappers can do something with it, 🚫 = doesn't work.
* Features compatibility: ✅ = yes, 🮱 = yes (basic), ❌ = no, ❗ = incomplete, ❔ = to be verified, ⬛ = not applicable.
* Mapping against released build: <code>pkg</code>, mapping against sources: <code>src</code>.

{|
|-
! colspan="2" | Tool
! colspan="2" | Mapping against
! colspan="3" | Filesystem
! colspan="2" | Support
! colspan="2" | Q3 map
! colspan="4" | Image formats
! colspan="2" | Model formats
! colspan="3" | Extra maps
|-
! Name
! Kind
! <code>pkg</code>
! <code>src</code>
! PakPath
! DPK
! DPKdir
! Gamepack
! Entities
! brush
! patch
! material
! PNG
! WebP
! CRN
! MD3
! IQM
! deluxe
! mini
|-
! rowspan="2" | NetRadiant 🏆️🏆️🏆️🏆️🏆️
! editor
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ✅
| ✅
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ✅
| ✅
| ✅
| 🮱✠
| 🮱✠
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
|-
! rowspan="2" | NetRadiant Custom 🏆️🏆️🏆️
! editor
| ✅
| ✅
| ❔
| 🮱✠
| 🮱✠
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ✅
| ✅
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ✅
| ✅
| ❔
| 🮱✠
| 🮱✠
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ✅
| ✅
| ✅
| ✅
| ✅
| ❗'''λ'''
|-
! rowspan="2" | GtkRadiant 🥈️
! editor
| ❌
| 🮱
| ❌
| 🮱
| 🮱
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|-
! q3map2
| ❌
| ❗
| ❌
| 🮱
| 🮱
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ❌
| ❌
| ✅
| ✅
| ❌
| ❌
|-
! rowspan="1" | DarkRadiant 🥈️
! editor
| ❌
| 🮱
| ❌
| 🮱
| 🮱
| ✅
| ✅
| ✅
| ✅
| 🮱
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|-

! rowspan="1" | TrenchBroom 🚫
! editor
| ❌
| ❌
| ❌
| 🮱
| ❌
| ✅
| ✅
| ✅
| ✅
| ❌
| ✅
| ❌
| ❌
| ✅
| ✅
| ⬛
| ⬛
|}

* ✠ DEPS support is not present.
* '''λ''' Produces a correct graphic, but no .minimap file.

Compiling the source

2024-10-06T11:26:07Z

Cu-kai: Update Gentoo dependencies

==Dependencies==

{{Note|content=In case this happens to become outdated, the up-to-date documentation can be found in the {{SourceFile|parameters=#unvanquished|README.md}} file in source repository.}}

The game requires some dependencies to be built, which are the same on all systems:

* cmake
* python3-yaml
* python3-jinja2
* A C++11 able compiler (those are known to work: clang (>= 3.5), gcc (>= 4.8), visual studio (>= 2019))
* zlib1g
* libgmp
* nettle
* libcurl4-gnutls
* libsdl2
* libglew
* libpng
* libjpeg-turbo8
* libwebp
* libfreetype6
* liblua5.3
* libopenal
* libogg
* libvorbis
* libopusfile

Those are optional:

* libncursesw5

==macOS==

First, you need to [[Getting_the_source|acquire the source code]].

Regardless of what interface you may use to compile the source, you will need [http://www.cmake.org/cmake/resources/software.html CMake] to generate makefiles. You will also need to install [https://developer.apple.com/xcode/ Xcode]. At a minimum, you must install the "Xcode command-line tools" in order to compile anything. You may also install Xcode proper, if you wish to use that IDE.

Once you have the source code and the tools installed, you may actually proceed to compile the source. You have several options:
* '''Compile the source at the command line'''. This is the easiest if you would just like to compile the game to use yourself and you do not intend to work on the code.
* '''Compile the source using an IDE'''. This is preferred if you intend on developing the source.
** Xcode is Apple's flagship IDE.
** [http://qt-project.org/downloads QtCreator] is cross-platform and provides real-time feedback of syntax errors, a Vim mode, as well as other features.
** [http://www.codeblocks.org/ Code::Blocks] is also cross-platform but lacks some of the features of Xcode and QtCreator.

===Dependencies===

Precompiled static libs are provided for all dependencies. CMake downloads them at configure time and extracts to <code>daemon/external_deps/macos-amd64-default_<version>/</code>. These were produced by the <code>external_deps/build.sh</code> script, which you could also use to build them yourself if you want to for some reason.

===Configuring with CMake===

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This should be a different directory.
# Click "Configure". You will be prompted as to which generator you would like to use. If you have Xcode installed, choose that. Wait while the configuration process runs. You may have to set the following:
## If you have selected to generate Xcode project files, make the <code>SDLMAIN_LIBRARY</code> field blank. This option is not available if you have the generator set to Unix makefiles.
# Click "Generate".
# You may now close CMake.

===Compiling===

====With Xcode====

<ol>
<li>Either start Xcode and open the project file (in the build directory you specified) or double-click the project file in Finder.</li>
<li>Open the project file created by CMake, which should be in the build directory you specified.</li>
<li>Change the active target to "ALL_BUILD" and click Product→Build.</li>
</ol>

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type the following commands:
<pre>
$ cd /path/to/Unvanquished-build
$ make
</pre>
If you are on a multi-core or multi-processor machine, you may speed up the process by passing the <code>-j</code> argument followed by the number of available cores to <code>make</code>; e.g., <code>make -j4</code>. Note that doing so makes reading error messages more difficult, as multiple instances of the compiler will print to the screen at once, causing information to appear out of order.
</li>
</ul>

===Testing the build===

====With Xcode 4====

To test the game, select the "client" scheme from the combo box on the toolbar, and click the run button or press {{Hotkey|MacCommand}}{{Hotkey|R}}.

===Bundling the Application===

====With CPack====

CPack is able to create standalone bundles (as well as many other types of installers). However you must generate the files using Unix Makefiles instead of Xcode.

$ cd /path/to/Unvanquished-build
$ cpack -G Bundle

Some warnings will be printed however these can be safely ignored. There should be a file called Unvanquished.dmg in the Unvanquished-build folder.

====Manually====

{{Note|header=Important|content=
Please be aware that these instructions are very much out of date, and may not work. Also note that the dynamic library bundler does '''not''' work as intended and although you will be able to run your build on your machine, it will most likely not work on other machines. It is strongly suggested that you compile the source using Xcode.
}}

You'll find the Mac [http://macdylibbundler.sourceforge.net/ dynamic library bundler] to be quite useful (you must generate the files using Unix Makefiles instead of Xcode):

$ curl -L http://sourceforge.net/projects/macdylibbundler/files/macdylibbundler/0.4.1/dylibbundler0.4.1.zip/download > \
dylibbundler0.4.1.zip
$ unzip dylibbundler0.4.1.zip
$ cd dylibbundler
$ make
$ sudo make install

Once you've done that, you can proceed to create the application bundle. Note that these steps assume that you have downloaded the data files to <code>main/</code> as shown above:

<pre>
$ git=/path/to/Unvanquished-git-repo
$ build=/path/to/Unvanquished-build-dir
$ mkdir -pv Unvanquished.app/Contents/{libs,MacOS,Resources,Frameworks}
$ cp -r $build/main Unvanquished.app/Contents/MacOS
$ sips -s format tiff $git/debian/unvanquished.png --out temp.tiff
$ tiff2icns temp.tiff Unvanquished.app/Contents/Resources/Unvanquished.icns
$ rm temp.tiff
$ cp $build/daemon{,ded}.i386 $build/*.dylib Unvanquished.app/Contents/MacOS
$ cp -r /Library/Frameworks/SDL.framework Unvanquished.app/Contents/Frameworks
$ install_name_tool -id \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/Frameworks/SDL.framework/Versions/A/SDL
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/daemon.i386
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/librendererGLi386.dylib
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/librendererGL3i386.dylib
$ for binary in Unvanquished.app/Contents/MacOS/*.{i386,dylib}; do
dylibbundler -b -x $binary -d $dest/Unvanquished.app/Contents/libs/; done
$ cp /usr/lib/libGLEW.1.7.0.dylib ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ chmod +w ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -id @executable_path/../libs/libGLEW.1.7.0.dylib \
./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -change /usr/lib/libGLEW.1.7.0.dylib \
@executable_path/../libs/libGLEW.1.7.0.dylib \
./Unvanquished.app/Contents/MacOS/daemon.i386
$ cat > Unvanquished.app/Contents/Info.plist <<\EOF
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleName</key>
<string>Unvanquished</string>
<key>CFBundleDisplayName</key>
<string>Unvanquished</string>
<key>CFBundleExecutable</key>
<string>daemon.i386</string>
<key>CFBundleIconFile</key>
<string>Unvanquished.icns</string>
<key>CFBundleIdentifier</key>
<string>net.Unvanquished</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>0.4.0</string>
<key>CFBundleVersion</key>
<string>0.4.0</string>
</dict>
</plist>
EOF
</pre>

The contents of the completed application bundle should look like this:

[[File:Bundle_dir_Mac_OS_X.png]]

'''Note''': If you compiled SDL from source, you will not see a directory titled <code>SDL.framework</code>.

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for Unvanquished.

# Add _NO_DEBUG_HEAP=1 to your environment variables otherwise performance under the debugger [http://www.massimpressionsprojects.com/dev/altdevblog/2011/07/27/the-unexpected-performance-of-debug-builds/ will be terrible]
# Run CMake with the source directory as the base directory of your source code (which should contain the directory <code>src</code>), and the build directory as a subdirectory of the source directory named <code>build</code>.
# Click the Open Project button. Or if you used CMake from the command line, open <code>build/Unvanquished.sln</code> in Visual Studio.
# In Visual Studio, choose your desired build type (default: Debug) from the drop-down menu in the top bar. Debug runs assertions and has complete debug information, but is slower. RelWithDebInfo is fast and still fairly usable with the debugger, but assertions don't run and sometimes you can't see the value of a local variable.
# Use Build → Build Solution to compile the code. Or just press {{Hotkey|F5}} to build and run, but beware: this will not automatically build cgame or sgame! Only engine changes are automatically rebuilt when you run something from Visual Studio.

====Important Notes====

* Due to limitations with CMake, the startup project cannot be specified. This must be set manually to debug the client with Visual Studio:
** Right click on client and select "Set as Startup project".

===MinGW===

It is possible to produce a Windows build of Unvanquished with [[MinGW]], as either a Windows or a Linux user. See [[MinGW#Distributions]] for detailed information about the toolchains available for installation.

====Instructions for native Windows build with MSYS2====

<ol>

<li> Install MSYS2. </li>
<li> Open the ''MSYS2 MinGW 32-bit'' or ''MSYS2 MinGW 64-bit'' terminal, depending on which bitness you want to build. </li>
</li> Install toolchain:
<pre>
# For 32-bit replace x86_64 with i686
pacman -Sy && pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake make
</pre> </li>
<li> Run CMake. If you're building Unvanquished, you may want to use the <code>-DDAEMON_CBSE_PYTHON_PATH=<path></code> option in case you want to use a different Python rather than the one in MSYS2. <pre>
mkdir mybuild && cd mybuild
cmake -G "MSYS Makefiles" somepath/Unvanquished
</pre> </li>
<li> Build:
<pre> make -j4 </pre>

If you would like verbose output (useful to see compiler flags), set the <code>VERBOSE</code> environment variable before running Make.
<pre>
export VERBOSE=1
</pre>

</li>
</ol>

You may find that the game (or some part of the MSYS2 toolchain!) fails to start due to missing DLL dependencies. Two helpful tools are:
<ul>
<li> The strace command in MSYS2, e.g. <code>strace ./daemon</code> </li>
<li> [https://github.com/lucasg/Dependencies Dependencies] (a Windows GUI program) </li>
</ul>

When distributing MinGW binaries, you need to distribute some additional DLLs besides the ones in the build folder. See [[MinGW#Built-in_DLL_dependencies]].

====MSYS2 Clang====
In MSYS2, it is possible to build with Clang, rather than GCC as shown as in the above instructions. However, some of our pre-built libraries are incompatible. You need to use the ones from pacman instead.

<ol>
<li> Create a deps folder with incompatible packages removed. This assumes that the latest version of the prebuilt deps for the mingw package of the appropriate bitness has already been extracted to the <code>windows-${ARCH}-mingw_${VERSION}</code> directory. In this example, we use <code>windows-amd64-mingw_8</code>. <pre>
cd somepath/daemon/external_deps
mkdir msysclang
cp windows-amd64-mingw_8 -R msysclang
find msysclang -depth -name '*freetype*' -o -name '*png*' -o name '*curl*' -o -name '*lua*' | grep -v pnacl | xargs rm -r
</pre> </li>
<li> Install those deps from Pacman: <pre>
# For Daemon
pacman -Sy && pacman -S mingw-w64-clang-x86_64-freetype mingw-w64-clang-x86_64-curl mingw-w64-clang-x86_64-libpng
# For Unvanquished
pacman -Sy && pacman -S mingw-w64-clang-x86_64-freetype mingw-w64-clang-x86_64-lua
</pre> </li>
<li>
Use the deps folder you made when configuring the build: <pre>
CC=clang CXX=clang++ cmake -G "MSYS Makefiles" -DEXTERNAL_DEPS_DIR=somepath/daemon/external_deps/msysclang /c/path/to/source
</pre>
If you see a download progress bar upon invoking CMake, you did the deps stuff wrong.
</li>
</ol>

===QtCreator===

# Install MinGW and follow the above instructions, except select Code::Blocks as the generator.
# Start QtCreator, and select "Open File or Project…" from the File menu.
# Navigate to your source directory and open CMakeLists.txt.
# At the CMake Wizard, select the same build directory you already configured using CMake. (If you did not chose Code::Blocks as the generator, you will have to start over again, as QtCreator requires a Code::Blocks project file in order to compile the source.)
# Ensure that a generator is selected in the combo box, and click "Run CMake". If there is no generator listed, see the [[#Troubleshooting|troubleshooting]] section below.
# Click "Finish" to close the wizard.

You should now be able to compile, run, and debug the code using QtCreator.

====Troubleshooting====

If at the "Run CMake" prompt of the the CMake Wizard, select "Run CMake" and are warned that no generator was selected, and notice that there are no generators in the combo box, you will likely have to [http://doc.qt.digia.com/qtcreator-2.4/creator-tool-chains.html manually configure your toolchain]. Select "Options…" from the "Tools" menu, then navigate to "Build & Run".

At the options window,
* Go to the "Kits" tab, and mouse over the "Desktop (default)" kit under "Manual". If there were any errors in configuring this kit, they will be displayed in the tool tip. If there are problems, select the kit. You may need to manually specify the location of the MinGW debugger, for example, which is typically <code>C:\MinGW\bin\gdb.exe</code>.
* Go to the "Compilers" tab, and ensure that MinGW is present. If not, you will need to add it manually.

==Linux==

===Dependencies===

{{TODO|This may be incomplete.}}

====Debian/Ubuntu====

sudo apt-get install build-essential cmake libcurl4-gnutls-dev \
libglew-dev libgmp-dev nettle-dev zlib1g-dev libncursesw5-dev \
libsdl2-dev libopenal-dev libjpeg-dev libpng-dev libwebp-dev \
libogg-dev libvorbis-dev libopusfile-dev \
libfreetype6-dev \
liblua5.3-dev \
python3-yaml python3-jinja2

If the version of WebP supplied by your version of Debian or Ubuntu is older than v0.2.0, you will need to [https://code.google.com/p/webp/downloads/detail?name=libwebp-0.2.0.tar.gz download] and [https://developers.google.com/speed/webp/docs/compiling#unix compile it from source]. After compiling and installing with <code>sudo make install</code>, in CMake, you'll need to set <code>WEBP_INCLUDE_DIR</code> to <code>/usr/local/include/webp</code> and <code>WEBP_LIBRARY</code> to <code>/usr/local/lib/libwebp.so</code>.

Developpment package name may differs, for example <code>libgmp-dev</code> may be named <code>libgmp3-dev</code> and <code>libglew-dev</code> may be named <code>libglew1.7-dev</code>.

We have a <code>debian</code> directory in the source tree, you can check what's missing this way.

cd <var>path/to/unvanquished</var>
dpkg-checkbuilddeps

Then install the listed packages this way:

sudo apt-get install <var>package list</var>

The <code>dpkg-checkbuilddeps</code> command produces no output if you already have the required dependencies.

Note that you only need <code>debhelper</code> to build <code>.deb</code> files.

====Fedora====

(This was tested to work on fedora 22 workstation)

$ sudo dnf install \
cmake gcc gcc-c++ \
{glew,gmp,lua,mesa-libGL,ncurses,nettle,openal-soft,opus,opusfile,SDL2,speex}-devel \
lib{curl,jpeg-turbo,png12,vorbis,webp}-devel

====Gentoo====

$ emerge curl freetype glew gmp jpeg ncurses media-sound/opus-tools libogg openal libpng libsdl libvorbis sys-libs/zlib

====openSUSE====

$ sudo install zypper gcc gcc-c++ Mesa-libGL-devel SDL-devel libjpeg8-devel \
libpng12-devel glew-devel webp-devel ncurses-devel gmp-devel libcurl-devel \
libnettle-devel openal-soft-devel speex-devel libvorbis-devel

The latest version of WebP must be installed manually (FIXME: why, if there is webp-devel in the zypper package list?):

$ cd Unvanquished/daemon/external_deps
$ ./build.sh linux-amd64-default webp naclsdk naclports
$ ./build.sh linux-amd64-default install

You must disable curses (set <code>USE_CURSES</code> appropriately in CMake) as failing to do so will cause Unvanquished to crash on startup.

===Configuring the code with CMake===

After you have [[Getting the source|acquired the source code]], you can proceed to compile. Unvanquished uses CMake, so you must have that installed.

====Using ccmake (curses-based front-end)====

On Debian or Ubuntu:

$ sudo apt-get install cmake-curses-gui

On Gentoo you should set the '''ncurses''' USE flag either globally or individually, just for cmake.
To add the USE flag globally, edit the USE array in /etc/make.conf for it to include '''ncurses'''.
To only install cmake with ncurses functionality, you could do the following:

$ echo 'dev-util/cmake ncurses' >> /etc/portage/package.use && emerge cmake

Note that in Ubuntu, <code>cmake-curses-gui</code> is in Universe, which you may have to enable with <code>software-properties-gtk</code>. Make sure to reload the software sources with <code>sudo apt-get update</code> afterwards.

Optionally: to use clang (rather than the default gcc and g++ compilers) export the CC and CXX variables before running cmake:

$ export CC="clang"
$ export CXX="clang++ -stdlib=libc++ -lc++abi"

Next, configure the codebase.

$ cd <var>/path/to/unvanquished</var>
$ mkdir build
$ cd build
$ ccmake ..

In Debian or Ubuntu you can build a package this way (you need <code>devscripts</code> and <code>fakeroot</code> packages):

$ cd <var>/path/to/unvanquished</var>
$ fakeroot dpkg-buildpackage -b -uc
$ sudo dpkg -i <var>../unvanquished_*.deb</var>

Once in <code>ccmake</code>, use the following keys:

* Press {{Hotkey|c}} to configure. If an error occurs during this phase, make note of it and press {{Hotkey|e}} to dismiss it.
* Use the up and down arrow keys to navigate the compilation options.
* Press {{Hotkey|Enter}} to enable or disable boolean options (i.e., on/off) or to edit textual options.
** Press {{Hotkey|Esc}} when editing a textual option to cancel the change.

Once you have finished the configuration process, press {{Hotkey|C}} again, then {{Hotkey|G}} to generate the makefile.

====Using cmake-qt-gui (graphical front-end)====

This graphical front end for cmake has its own package you must install:

=====Debian/Ubuntu=====

$ sudo apt-get install cmake-qt-gui

=====Gentoo=====

With the '''qt4''' USE flag enabled:

$ emerge cmake

Once installed, run with <code>cmake-gui</code>.

[[Image:Cmake-qt-gui.png|thumb]]

# Set the path where you have the source code downloaded.
# Set the path where you would like to build the engine. This may be the same directory if you wish.
# Click 'Configure'.
# Click 'Generate'.

====Unnecessary libraries====

Regardless of which front-end to cmake you use, you may want to disable some libraries that are not strictly necessary:

* <code>USE_BREAKPAD</code> — Disabling this will cause the game to not produce crashdumps on failure.
* <code>USE_CURSES</code> — Disabling this will cause the external (not in-game) console to not use curses; it will not be scrollable and will be similar to the console in the original Tremulous. This does in no way affect gameplay.

===Compiling===

$ cd <var>path/to/unvanquished/build</var>
$ make -j4

The <code>-j</code> switch to make allows you to speed up the compilation process by running it in multiple threads; set the number following this to the number of cores your processor(s) have.

==FreeBSD==

While building on FreeBSD is usually very similar to building on Linux, the PNaCl toolchain not being native to FreeBSD means a not everything can be built on FreeBSD. See the [[Systems/FreeBSD]] page for details and dedicated instructions.

==Acquiring the Game Files==

===Acquiring mandatory game files===

The game files are not in the Git repository, and must be downloaded separately. They must be saved to the [[Game locations|data location]] for your system.

Linux users may use the <code>download-paks</code> script that is distributed with the source code, which requires one of curl, wget or aria2 to be installed:

$ cd <var>path/to/unvanquished/build</var>
$ ../download-paks pkg

Otherwise, the set of necessary packages can be extracted from the [https://github.com/Unvanquished/Unvanquished/releases latest release], or downloaded a la carte from the [http://dl.unvanquished.net/pkg/ package index].