README.md
1# Doomsday Engine
2
3This is the source code for Doomsday Engine: a portable, enhanced source port of id Software's Doom I/II and Raven Software's Heretic and Hexen. The sources are under the GNU General Public license (see doomsday/gpl-3.0.txt), with the exception of the Doomsday 2 libraries that are under the GNU Lesser General Public License (see doomsday/lgpl-3.0.txt).
4
5For [compilation instructions](https://manual.dengine.net/devel/compilation) and other details, see the [Doomsday Manual](https://manual.dengine.net/).
6
7Linux 64-bit [](https://travis-ci.org/skyjake/Doomsday-Engine) Windows 32-bit [](https://ci.appveyor.com/project/skyjake/doomsday-engine)
8
9## Libraries
10
11**libcore** is the core of Doomsday 2. It is a C++ class framework containing functionality such as the file system, plugin loading, Doomsday Script, network communications, and generic data structures. Almost everything relies or will rely on this core library.
12
13**liblegacy** is a collection of C language routines extracted from the old Doomsday 1 code base. Its purpose is to (eventually) act as a C wrapper for libcore. (Game plugins are mostly in C.)
14
15**libgui** builds on libcore to add low-level GUI capabilities such as OpenGL graphics, fonts, images, and input devices.
16
17**libappfw** contains the Doomsday UI framework: widgets, generic dialogs, abstract data models. libappfw is built on libgui and libcore.
18
19**libshell** has functionality related to connecting to and controlling Doomsday servers remotely.
20
21**libdoomsday** is an application-level library that contains shared functionality for the client, server, and plugins.
22
23## External Dependencies
24
25### CMake
26
27Doomsday is compiled using [CMake](http://cmake.org/). Version 3.1 or later is required.
28
29### Qt
30
31Using the latest version of Qt 5 is recommended. The minimum required version is Qt 5.5 (complete build) or Qt 5.0 (client disabled).
32
33### Open Asset Import Library
34
35libgui requires the [Open Asset Import Library](http://assimp.sourceforge.net/lib_html/index.html) for reading 3D model and animation files. It is compiled automatically as part of the build and is expected to be present as a Git submodule in _doomsday/external/assimp_. Source tarballs come with the Assimp sources included.
36
37### SDL 2
38
39[SDL 2](http://libsdl.org) is needed for game controller input (e.g., joysticks and gamepads). Additionally, SDL2_mixer can be used for audio output (not required).
40
41### FMOD Studio
42
43The optional FMOD audio plugin requires the [FMOD Studio Low-Level Programmer API](http://www.fmod.org/download).
44
45## Branches
46
47The following branches are currently active in the repository.
48
49- **master**: Main code base. This is where releases are made from on a biweekly basis. Bug fixing is done in this branch, while larger development efforts occur in separate work branches.
50- **stable**: Latest stable release. Patch releases can be made from this branch when necessary.
51- **stable-x.y**: Stable release x.y.
52- **legacy**: Old stable code base. Currently at the 1.8.6 release.
53
){kind=link}