README.md 5.18 KB
Newer Older
1 2
# DarkRadiant

3 4 5 6 7 8 9
DarkRadiant is a level (map) editor for the **The Dark Mod**, an open-source Doom 3 modification which is available at www.thedarkmod.com

# Getting started

DarkRadiant requires game resources to work with, these resources are not installed by this editor. You'll need to point DarkRadiant to one of these games (The Dark Mod, Doom 3, Quake 4, etc.) before you can start to work on your map. Visit www.thedarkmod.com for download instructions, then proceed with one of the tutorials available on the web.

For The Dark Mod mappers, there's an extensive [Beginner's Guide](http://wiki.thedarkmod.com/index.php?title=A_-_Z_Beginner_Full_Guide_Start_Here!) on the project's wiki, which covers a lot of steps almost from scratch. Moreover, a couple of excellent video tutorials are available, linked from the top of that wiki article above.
10 11 12 13 14

# Compiling on Windows

## Prerequisites

15
DarkRadiant is built on Windows using *Microsoft Visual C++ 2017*. 
16 17
The free Community Edition can be obtained here:

18
*VC++ 2017:* https://www.visualstudio.com/downloads/ (Choose Visual Studio Community)
19

20
Since DarkRadiant uses a couple of open-source libraries that are not available on Windows by default, you will also need to download and install the dependencies. 7-Zip packages of the dependencies are available at the following
21 22
URL(s). [Get 7-zip here](http://www.7-zip.org/)

23
https://github.com/codereader/DarkRadiant/releases/download/2.5.0/windeps.7z  
24 25

The dependencies packages need to be extracted into the main DarkRadiant
26 27
source directory, i.e. alongside the `include/` and `radiant/` directories.
Just drop the windeps.7z in the DarkRadiant folder and use 7-zip's "Extract to here"
28 29 30 31 32

## Build

The main Visual C++ solution file is:

33
Visual Studio 2017: `tools/msvc/DarkRadiant.sln`
34 35 36

Open this file with Visual Studio and start a build by right-clicking on the top-level 
"Solution 'DarkRadiant'" item and choosing Build Solution. The DarkRadiant.exe file will be 
37
placed into the `install/` folder.
38 39 40 41 42

# Compiling on Linux

## Prerequisites

43
To compile DarkRadiant, a number of libraries (with development headers) and a standards-compliant C++11 compiler (GCC 5.3+) are required. On an Ubuntu system, the requirements may include any or all of the following packages:
44 45 46

* zlib1g-dev 
* libjpeg62-dev 
47 48 49 50 51 52
* libwxgtk3.0-dev 
* libxml2-dev 
* libsigc++-2.0-dev 
* libpng-dev 
* libftgl-dev 
* libglew-dev 
53
* libalut-dev 
54
* libvorbis-dev
55
* pybind11-dev (Ubuntu 17 and later)
56 57

This does not include core development tools such as g++ or the git client
58
to download the sources (use sudo apt-get install git for that). One possible set of packages might be:
59

60 61 62
`sudo apt-get install git automake libtool g++ gettext pkg-config`

More required package lists for various Linux distributions are [listed in the Wiki Article](http://wiki.thedarkmod.com/index.php?title=DarkRadiant_-_Compiling_in_Linux).
63 64 65 66 67

## Build

To build DarkRadiant the standard Autotools build process is used:

68 69
```
./autogen.sh
70 71 72 73 74 75 76
./configure
make
sudo make install
```

The available configure options are listed with `./configure --help`. There are
options for debug builds, and enabling or disabling various optional components
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
such as audio support and the Dark Mod-specific plugins (`--enable-darkmod-plugins`).

# Compiling on OS X

## Prerequisites

To compile DarkRadiant, a number of libraries (with development headers) are
required. You can obtain them by using [MacPorts](https://distfiles.macports.org/MacPorts/):

Install MacPorts, then open a fresh console and issue these commands:

```
sudo port install jpeg wxwidgets-3.0 pkgconfig libsigcxx2 freetype ftgl glew
sudo port install boost libxml2 freealut libvorbis libogg openal
```

## Build

Start Xcode and open the project file in `tools/xcode/DarkRadiant.xcodeproj`.
Hit CMD-B to start the build, the output files will be placed to a folder
similar to this:

`~/Library/Developer/Xcode/DerivedData/DarkRadiant-somethingsomething/Build/Products/Release`

The `DarkRadiant.app` package in that folder can be launched right away or
copied to some location of your preference.
103

104
# More Build Information
105 106 107 108 109 110 111

A more detailed compilation guide can be found on The Dark Mod's wiki:

http://wiki.thedarkmod.com/index.php?title=DarkRadiant_-_Compilation_Guide

# Contact / Discussion

112 113
DarkRadiant Website: http://www.darkradiant.net

114 115 116 117 118
All discussion is ongoing primarily at [The Dark Mod Forums](http://forums.thedarkmod.com/forum/51-darkradiant-feedback-and-development/), where you can get in touch with knowledgeable people 
and discuss changes or issues. If you happen to run into a bug, you're encouraged to report it to us, especially when running into
application crashes (see also [How to record a crashdump](http://wiki.thedarkmod.com/index.php?title=Save_a_Memory_Dump_for_debugging_Crashes)). 

The issue tracker for DarkRadiant is also run by the Dark Mod folks: [DarkRadiant Bugtracker](http://bugs.thedarkmod.com/view_all_bug_page.php?project_id=1).
119 120 121 122 123

# License

The DarkRadiant source code is published under the [GNU General Public License 2.0 (GPLv2)](http://www.gnu.org/licenses/gpl-2.0.html
), except for a few libraries which are using the BSD license, see the [LICENSE](https://raw.githubusercontent.com/codereader/DarkRadiant/master/LICENSE) file for further notes.