Git Product home page Git Product logo

ioq3-renderer-bgfx's Introduction

ioq3-renderer-bgfx

Appveyor CI Build Status Travis CI Build Status License: GPL v2

This is a renderer for ioquake3 that uses bgfx to support multiple graphics APIs.

Minimum requirements: OpenGL 3.2 or Direct3D 11.

Features

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

Screenshots

Bloom Extra Dynamic Lights
Planar Reflections Soft Sprites

Binaries

Windows (x86) Linux (x86_64)

These are updated after every commit.

Compiling

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_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_extraDynamicLights Enable extra dynamic lights on Q3A weapons.
r_fastPath Disables all optional features to improve performance.
r_lerpTextureAnimation Use linear interpolation on texture animation - flames, explosions.
r_maxAnisotropy Enable anisotropic filtering.
r_textureVariation Hide obvious texture tiling in a few Q3A maps.
r_waterReflections Show planar water reflections. Only enabled on q3dm2 for now.

Console Commands

Command Description
r_captureFrame Capture a RenderDoc frame.
screenshotPNG

RenderDoc

The renderer must be built in debug mode - make config=debug_x86 or make config=debug_x86_64.

Place the RenderDoc shared library - renderdoc.dll or librenderdoc.so - in the same directory as the renderer binary.

Use the r_captureFrame console command to capture a frame. Bind it to a key so the console doesn't show up in the capture.

Capture files will be saved to the same directory as the ioquake3 executable as ioq3-renderer-bgfx_frameX.rdc where X is the frame number.

ioq3-renderer-bgfx's People

Contributors

jpcy avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.