Skip to content

Latest commit

 

History

History
232 lines (158 loc) · 7.35 KB

README.md

File metadata and controls

232 lines (158 loc) · 7.35 KB
Raw

ezQuake — Modern QuakeWorld Client

Homepage: https://ezquake.com

Community discord: http://discord.quake.world

This is the right place to start playing QuakeWorld® — the fastest first person shooter action game ever.

Combining the features of all modern QuakeWorld® clients, ezQuake makes QuakeWorld® easier to start and play. The immortal first person shooter Quake® in the brand new skin with superb graphics and extremely fast gameplay.

Features

  • Modern graphics
  • QuakeTV support
  • Rich menus
  • Multiview support
  • Tons of features to serve latest pro-gaming needs
  • Built in server browser & MP3 player control
  • Recorded games browser
  • Customization of all possible graphics elements of the game including Heads Up Display
  • All sorts of scripting possibilities
  • Windows, Linux, MacOSX and FreeBSD platforms supported (SDL2).

Our client comes only with bare minimum of game media. If you want to experience ezQuake with modern graphics and other additional media including custom configurations, maps, textures and more, try using the nQuake-installer.

Support

Need help with using ezQuake? Try #dev-corner on discord

Or (less populated these days) visit us on IRC at QuakeNet, channel #ezQuake: webchat or IRC.

Sometimes help from other users of ezQuake might be more useful to you so you can also try visiting the quakeworld.nu Client Talk-forums.

If you have found a bug, please report it here

Installation guide

To play Quakeworld you need the files pak0.pak and pak1.pak from the original Quake-game.

Install ezQuake to an existing Quake-installation

If you have an existing Quake-installation simply extract the ezQuake executable into your Quake-directory.

A typical error message when installing ezQuake into a pre-existing directory is about glide2x.dll missing. To get rid of this error, remove the file opengl32.dll from your Quake directory.

Upgrade an nQuake-installation

If you have a version of nQuake already installed you can upgrade ezQuake by extracting the new executable into the nQuake-directory.

Minimal clean installation

If you want to make a clean installation of ezQuake you can do this by following these steps:

  1. Create a new directory
  2. Extract the ezQuake-executable into this directory
  3. Create a subdirectory called id1
  4. Copy pak0.pak and pak1.pak into this subdirectory

Compiling

Compiling a Windows binary

Using Visual Studio

The project contain a VS solution.

Clone the ezQuake source code:

git clone --recurse-submodules https://github.com/ezQuake/ezquake-source.git ezquake

Initialize Vcpkg, and refresh submodules if needed:

bootstrap.bat

Load the solution into VS, and compile your preferred target.

Using Ubuntu Bash (WSL)

You can use the new Ubuntu Bash feature in Windows 10 to compile ezQuake for Windows.

To enable Bash for Windows, press the Start button and type Turn Windows f and select Turn Windows features on or off. Scroll down to Windows Subsystem for Linux (Beta) and enable it.

Now press WINDOWS+I, go to Update & security and then to the For developers tab. Enable Developer mode.

Now press the Start button again and enter bash. Click it and install Bash.

Enter the following command to install all required prerequisites to build ezQuake:

sudo apt-get install -y git mingw-w64 build-essential libspeexdsp-dev dos2unix pkg-config

Now clone the ezQuake source code:

git clone --recurse-submodules https://github.com/ezQuake/ezquake-source.git ezquake

Make sure line endings are not CRLF:

dos2unix *.sh

Now build the ezQuake executable:

EZ_CONFIG_FILE=.config_windows make

Copy the compiled binary to your Quake folder, the binary is called ezquake.exe.

Using a Linux system

Initialize/update git submodules:

git submodule update --init --recursive --remote

Make sure you have mingw32 toolchain installed. On Arch Linux it's mingw-w64 (select complete group).

Build an executable using the following command:

EZ_CONFIG_FILE=.config_windows make

You can add -jN as a parameter to make to build in parallell. Use number of cpu cores plus 1 (e.g. -j5 if you have a quad core processor).

Compiling a Linux binary

These instructions were tested on Ubuntu

Make sure you have the dependencies installed:

(You may skip installing dependencies if you are going to use the build-linux.sh script included in the repository, this will take care of installing packages for you.)

  • For Debian/Ubuntu 16.10+
sudo apt install git build-essential libsdl2-2.0-0 libsdl2-dev libjansson-dev libexpat1-dev libcurl4-openssl-dev libpng-dev libjpeg-dev libspeex-dev libspeexdsp-dev libfreetype6-dev libsndfile1-dev libpcre2-dev libminizip-dev
  • For openSUSE Tumbleweed
sudo zypper install -t pattern devel_C_C++
sudo zypper install git pcre2-devel Mesa-libGL-devel SDL2-devel libjansson-devel libexpat-devel libcurl-devel libpng16-devel libpng16-compat-devel libjpeg8-devel libjpeg-turbo libsndfile-devel speex-devel speexdsp-devel libXxf86vm-devel
  • For Fedora
sudo dnf group install 'C Development Tools and Libraries'
sudo dnf install git pcre2-devel mesa-libEGL-devel SDL2-devel jansson-devel expat-devel libcurl-devel libpng-devel libjpeg-turbo-devel libsndfile-devel speex-devel speexdsp-devel libXxf86vm-devel

Clone the git repository:

git clone --recurse-submodules https://github.com/ezQuake/ezquake-source.git

Switch to ezquake-source path:

cd ~/ezquake-source/

Initialize/update git submodules:

git submodule update --init --recursive --remote

Run the compilation (replace 5 with the number of cpu cores you have +1):

make -j5

You can add -jN as a parameter to make to build in parallell. Use number of cpu cores plus 1 (e.g. -j5 if you have a quad core processor).

Copy the compiled binary to your Quake folder, on 64bit linux the binary will be called ezquake-linux-x86_64.

Compiling an OS X binary

These instructions were tested on Mac OS X 10.10.

Get Homebrew

Run exactly as it says on the front page:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Make sure you run the brew doctor as instructed before doing anything else.

Then run:

brew install sdl2 sdl2_net sdl2_image sdl2_gfx sdl2_mixer pcre2 jansson pkg-config speex speexdsp libsndfile

When it's done, just run make and it should compile without errors.

Creating an app bundle

Call from main ezquake-source directory, e.g. you probably do something like this:

make
sh misc/install/create_osx_bundle.sh

Current directory should have an ezQuake.app folder which is the app.

There will also be an ezquake.zip which basically just zips up the .app.

Nightly builds

Nightly builds can be found here