Tutorials/Getting started with NetRadiant

From Unvanquished
Jump to: navigation, search
Information 48x48.png

Note

The recommended level editor is NetRadiant.
See Level editors for other tools.

Getting and installing NetRadiant

  • Just unzip the archive and run the netradiant binary.

Some linux users may experience problems when trying to run it by clicking the icon in their file browser. A workaround is to open a terminal in that folder and type: ./netradiant

Arch Linux users can also use the netradiant-git PKGBUILD to get the editor.

Information 48x48.png

Note: NetRadiant-custom will not work.

You may have heard of a fork named netradiant-custom by Garux and may be wondering if it can be used for mapping with Unvanquished. While it features very interesting things, it will unfortunately not be compatible: this fork derivated from mainstream around 2014 and most of the development that happened upstream to support Unvanquished is missing. It does not support the DPK game archives neither the DPKdir source repositories. The WebP and CRN image formats used by the released game are not supported, and the support of the PNG image format may not be complete. One good news though: support for IQM model format was recently added but we didn't tested this yet. The produced minimaps will not work in game (one needed file isn't generated). That editor may provide a (maybe obsolete) Unvanquished gamepack that will give you the impression it will work with the game but even if that editor starts you will not be able to do anything with it, and our official Unvanquished gamepack will not work because of missing features. We don't provide support for that alternate radiant.

Gamepack

NetRadiant is designed to work with many Quake-based games, not just Unvanquished. The Unvanquished gamepack is provided with NetRadiant so you have nothing more to do. Just make sure the current game selected for mapping in NetRadiant is Unvanquished.

Start up NetRadiant for the first time

When you first start up NetRadiant you will be asked what game you want to edit levels for.

  • If Unvanquished is not listed, then you don't have the right NetRadiant package.
  • If you don't want to see this dialog on startup you can untick the second checkbox.

NetRadiant global preferences.png

You may also be asked for the game's engine path if NetRadiant can't find it. This is the basepath in table below. This is the location where the game stores its pkg folder holding the many .dpk resources.

NetRadiant engine path not found.png

If you installed the game using Flatpak or Universal zip or other means, see Game locations for specific paths.

When using the Unvanquished launcher, the default system paths are:

Platform Default data directory (basepath) Default binary directory (libpath)
Linux #xdg ${HOME}/.local/share/unvanquished/base
Windows %ProgramFiles%\Unvanquished
macOS ${HOME}/Games/Unvanquished ${HOME}/Games/Unvanquished/Unvanquished.app/Contents/MacOS

Finally you should be greeted by NetRadiant's default interface:

NetRadiant main window default layout.png

Make sure you have a common shader category. If you do not, contact the devs via chat or the forums.

Getting started

This is not a complete guide. Another tutorial will be required to tell how to make a complete map with required entities and all, but if you already mapped for other games before, this will give you the prerequisites you may miss.

Editing an existing map

Let's imagine you want to edit the chasm map :

  • Locate the pkg/map-chasm_1.2.dpk file in your installation directory (see above) and extract it as pkg/map-chasm_src.dpkdir in your user directory (see above). The .dpk file is a zip file with a different extension, so if your system does not recognize it, just make a copy with a .zip extension and extract it.
  • In the end you'll get something that looks like pkg/map-chasm_src.dpkdir/maps/chasm.map (and other files in the dpkdir). Just open that file in NetRadiant and do some edits, then build the map using the build menu. Congratulation, you can now load your edited map in game!

Making a new map from scratch

Let's imagine you want to make a map named castle:

  • Create a folder in your user directory (see above) in a way it is named pkg/map-castle_src.dpkdir.
  • Create a subfolder named maps this way: pkg/map-castle_src.dpkdir/maps.
  • Add a file named DEPS this way: pkg/map-castle_src.dpkdir/DEPS. For a start, just write tex-all in this file.
  • Open NetRadiant, save your new file as pkg/map-castle_src.dpkdir/maps/castle.map.
  • Click the refresh button on the toolbar, all the texture sets must appear in the texture browser!

Becoming a mapper

See Mapping guide.