Difference between revisions of "Required Libraries"

From OdaWiki
(wxWidgets)
(Windows)
 
(19 intermediate revisions by 6 users not shown)
Line 1: Line 1:
These libraries are required in order for Odamex to compile correctly.  Note that you must get both the runtime libraries and development libraries.
+
The Odamex client and launcher require extra libraries which are not usually included with your operating system.
  
''A special note if you are running Linux:''  Before downloading the libraries below, check to see if these librares are included with your distribution or avalable to download through an automated package management system, such as apt or yum.  If such packages are avalable, setting up your build environment will be substantially easier.
+
== SDL2 ==
  
==SDL==
+
SDL2 is a crossplatform library used to display graphics. It is required in order to compile the Odamex client.
Latest version is 1.2.11
+
  
*[http://www.libsdl.org/download-1.2.php SDL]
+
=== Windows ===
  
==SDL_mixer==
+
SDL2 comes with no installer on Windows, you simply extract the zip into a random directory and reference it. Pointing your compiler at SDL2 is discussed in the compiler-specific pages.
Latest version is 1.2.7
+
  
*[http://www.libsdl.org/projects/SDL_mixer/ SDL_mixer]
+
You want to grab the '''Development Library''' on [https://www.libsdl.org/download-2.0.php this page] that compliments your compiler.
 +
*• If you are using Visual Studio, get the one labeled "VC".
 +
*• If you are using MinGW, get the one labeled "Mingw32".  If you don't have anything to extract a tar.gz file with, install [http://www.7-zip.org/ 7-zip].  You will also need to download the library itself, as the MinGW package does not come with the .dll file.
  
==wxWidgets==
+
=== Linux ===
To build the launcher, you will need the latest wxWidgets
+
release from the site for your platform. Download the wxMSW package in ZIP format.
+
  
 +
There is usually a copy of SDL2 and SDL2_mixer included in the repositories of your distribution of choice:
 +
 +
*• CentOS (requires [http://fedoraproject.org/wiki/EPEL EPEL] for SDL2_mixer):  yum install SDL2-devel
 +
*• Debian: apt-get install libsdl2-dev
 +
*• Fedora: yum install SDL2-devel
 +
*• openSUSE: zypper in SDL2-devel
 +
*• Ubuntu: aptitude install libsdl2-dev
 +
 +
Otherwise, you can grab the latest source distribution of SDL2 from [https://www.libsdl.org/download-2.0.php here].
 +
 +
== SDL2_mixer ==
 +
 +
SDL2_mixer is a compliment to SDL2, and handles both sound and music.  It is required in order to compile the Odamex client.
 +
 +
=== Windows ===
 +
 +
SDL2_mixer comes with no installer on Windows, you simply extract the zip into a random directory and reference it.  Pointing your compiler at SDL2_mixer is discussed in the compiler-specific pages.
 +
 +
You want to grab the '''Development Library''' on [https://www.libsdl.org/projects/SDL_mixer/ this page].  It is labeled '''SDL2_mixer-devel''' and works with both Visual Studio and MinGW.
 +
 +
=== Linux ===
 +
 +
There is usually a copy of SDL and SDL_mixer included in the repositories of your distribution of choice:
 +
 +
*• CentOS (requires [http://fedoraproject.org/wiki/EPEL EPEL] for SDL2_mixer):  <tt>yum install SDL2_mixer-devel</tt>
 +
*• Debian: <tt>apt-get install libsdl2-mixer-dev</tt>
 +
*• Fedora: <tt>yum install SDL2_mixer-devel</tt>
 +
*• openSUSE: <tt>zypper in SDL2_mixer-devel</tt>
 +
*• Ubuntu: <tt>aptitude install libsdl2-mixer-dev</tt>
 +
 +
Otherwise, you can grab the latest source distribution of SDL2_mixer from [http://www.libsdl.org/projects/SDL_mixer/ here].
 +
 +
==wxWidgets==
 +
wxWidgets is a library used to display graphical user interfaces.  It is required in order to compile the Odamex launcher.
  
Latest version is 2.8.0
+
=== Windows ===
 +
wx on Windows is a peculiar beast. While it comes with an installer, you have to compile it yourself in order to generate the proper files for compiling Odalaunch.
  
*[http://www.wxwidgets.org/downloads/ wxWidgets]
+
# Download and wxWidgets 2.8 for MSW [http://www.wxwidgets.org/downloads/#latest_stable here].
 +
# Run the installer.  It is recommended to keep the default installation directory (in particular do not install it to Program Files).
 +
# Follow these instructions if you are using MinGW.
 +
## Make sure that MinGW is installed properly and that <tt>c:\MinGW\bin</tt> is in your path.
 +
## Open up a Command Prompt and change to the <tt>C:\wxWidgets-2.8.##\build\msw</tt> directory.
 +
## Run <tt>mingw32-make -f makefile.gcc MONOLITHIC=0 UNICODE=0 SHARED=0 BUILD=release</tt>
 +
## Change to the <tt>C:\wxWidgets-2.8.##\utils\wxrc</tt> directory.
 +
## Run the same command you ran in step 3.
 +
## You're done!
 +
# Follow these instructions if you are using Visual C++.
 +
## Open up a '''Visual Studio Command Prompt'''.  There is a shortcut for this in the Visual Studio folder of your Start menu.
 +
## Change to the <tt>C:\wxWidgets-2.8.##\build\msw</tt> directory.
 +
## Run <tt>nmake -f makefile.vc MONOLITHIC=0 UNICODE=0 SHARED=0 BUILD=release</tt>
 +
## Change to the <tt>C:\wxWidgets-2.8.##\utils\wxrc</tt> directory.
 +
## Run the same command you ran in step 3.
 +
## You're done!

Latest revision as of 15:28, 17 January 2019

The Odamex client and launcher require extra libraries which are not usually included with your operating system.

SDL2

SDL2 is a crossplatform library used to display graphics. It is required in order to compile the Odamex client.

Windows

SDL2 comes with no installer on Windows, you simply extract the zip into a random directory and reference it. Pointing your compiler at SDL2 is discussed in the compiler-specific pages.

You want to grab the Development Library on this page that compliments your compiler.

  • • If you are using Visual Studio, get the one labeled "VC".
  • • If you are using MinGW, get the one labeled "Mingw32". If you don't have anything to extract a tar.gz file with, install 7-zip. You will also need to download the library itself, as the MinGW package does not come with the .dll file.

Linux

There is usually a copy of SDL2 and SDL2_mixer included in the repositories of your distribution of choice:

  • • CentOS (requires EPEL for SDL2_mixer): yum install SDL2-devel
  • • Debian: apt-get install libsdl2-dev
  • • Fedora: yum install SDL2-devel
  • • openSUSE: zypper in SDL2-devel
  • • Ubuntu: aptitude install libsdl2-dev

Otherwise, you can grab the latest source distribution of SDL2 from here.

SDL2_mixer

SDL2_mixer is a compliment to SDL2, and handles both sound and music. It is required in order to compile the Odamex client.

Windows

SDL2_mixer comes with no installer on Windows, you simply extract the zip into a random directory and reference it. Pointing your compiler at SDL2_mixer is discussed in the compiler-specific pages.

You want to grab the Development Library on this page. It is labeled SDL2_mixer-devel and works with both Visual Studio and MinGW.

Linux

There is usually a copy of SDL and SDL_mixer included in the repositories of your distribution of choice:

  • • CentOS (requires EPEL for SDL2_mixer): yum install SDL2_mixer-devel
  • • Debian: apt-get install libsdl2-mixer-dev
  • • Fedora: yum install SDL2_mixer-devel
  • • openSUSE: zypper in SDL2_mixer-devel
  • • Ubuntu: aptitude install libsdl2-mixer-dev

Otherwise, you can grab the latest source distribution of SDL2_mixer from here.

wxWidgets

wxWidgets is a library used to display graphical user interfaces. It is required in order to compile the Odamex launcher.

Windows

wx on Windows is a peculiar beast. While it comes with an installer, you have to compile it yourself in order to generate the proper files for compiling Odalaunch.

  1. Download and wxWidgets 2.8 for MSW here.
  2. Run the installer. It is recommended to keep the default installation directory (in particular do not install it to Program Files).
  3. Follow these instructions if you are using MinGW.
    1. Make sure that MinGW is installed properly and that c:\MinGW\bin is in your path.
    2. Open up a Command Prompt and change to the C:\wxWidgets-2.8.##\build\msw directory.
    3. Run mingw32-make -f makefile.gcc MONOLITHIC=0 UNICODE=0 SHARED=0 BUILD=release
    4. Change to the C:\wxWidgets-2.8.##\utils\wxrc directory.
    5. Run the same command you ran in step 3.
    6. You're done!
  4. Follow these instructions if you are using Visual C++.
    1. Open up a Visual Studio Command Prompt. There is a shortcut for this in the Visual Studio folder of your Start menu.
    2. Change to the C:\wxWidgets-2.8.##\build\msw directory.
    3. Run nmake -f makefile.vc MONOLITHIC=0 UNICODE=0 SHARED=0 BUILD=release
    4. Change to the C:\wxWidgets-2.8.##\utils\wxrc directory.
    5. Run the same command you ran in step 3.
    6. You're done!