smalllixin / ioq3-renderer-bgfx

bgfx-based renderer for ioquake3

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ioq3-renderer-bgfx

Appveyor CI Build Status Travis CI Build Status

This is a renderer for ioquake3 written in C++ and using bgfx.

Goal: Make Quake 3 Arena and derivitives look slightly better on a modern PC without content replacement. It doesn't need to run at 600fps, trade some of that performance for visuals.

Status: Work in Progress. Not widely tested. Q3A and TA more or less look how they should.

Features

  • Anti-aliasing - MSAA, SMAA
  • Soft sprites
  • Real dynamic lights
  • Extra dynamic lights for Q3A weapons - BFG, Lightning, Plasma, Railgun
  • Bloom

Screenshots

Binaries

Windows (x86)

Linux (x86_64)

These are updated after every commit.

Compiling

Prerequisites

Clone bgfx and bx to the same parent directory as ioq3-renderer-bgfx.

Linux

Required packages: libgl1-mesa-dev libsdl2-dev

./premake5 shaders
./premake5 gmake
cd build
make

Cygwin/MinGW-w64/MSYS2

Clone ioquake3 to the same parent directory as ioq3-renderer-bgfx.

./premake5.exe shaders
./premake5.exe gmake
cd build
make

Visual Studio

  1. Run CompileShaders.bat
  2. Use ioq3-premake-msvc.

Usage

Copy the renderer binaries from build\bin_* to where you have a ioquake3 test build installed.

Select the renderer in-game with cl_renderer bgfx followed by vid_restart.

Console Variables

Run the following console variables without any arguments to see a list of possible values.

Variable Description
r_aa Anti-aliasing.
r_aa_hud Anti-aliasing for 3D HUD elements.
r_backend Rendering backend - OpenGL, Direct3D 9 etc.
r_bgfx_stats Show bgfx statistics.
r_bloom Enable bloom.
r_bloomScale Scale the bloom effect.
r_dynamicLightIntensity Make dynamic lights brighter/dimmer.
r_dynamicLightScale Scale the radius of dynamic lights.
r_lerpTextureAnimation Use linear interpolation on texture animation - flames, explosions.
r_maxAnisotropy Enable anisotropic filtering.
r_waterReflections Show planar water reflections. Only enabled on q3dm2 for now.

Console Commands

Command Description
screenshotPNG

About

bgfx-based renderer for ioquake3

License:GNU General Public License v2.0


Languages

Language:C 64.0%Language:C++ 31.3%Language:HLSL 2.2%Language:SuperCollider 1.1%Language:Lua 0.7%Language:Objective-C 0.5%Language:Shell 0.2%Language:Scala 0.0%Language:Batchfile 0.0%