Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpcy/ioq3-renderer-bgfx
A renderer for ioquake3 that uses bgfx.
https://github.com/jpcy/ioq3-renderer-bgfx
bgfx ioquake3 quake3 quake3arena
Last synced: 7 days ago
JSON representation
A renderer for ioquake3 that uses bgfx.
- Host: GitHub
- URL: https://github.com/jpcy/ioq3-renderer-bgfx
- Owner: jpcy
- License: gpl-2.0
- Created: 2015-11-01T13:14:05.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-29T09:21:59.000Z (about 3 years ago)
- Last Synced: 2024-12-09T21:11:02.495Z (17 days ago)
- Topics: bgfx, ioquake3, quake3, quake3arena
- Language: C
- Homepage:
- Size: 27 MB
- Stars: 205
- Watchers: 15
- Forks: 35
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: COPYING.txt
Awesome Lists containing this project
README
## ioq3-renderer-bgfx
[](https://github.com/jpcy/ioq3-renderer-bgfx/actions) [](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
This is a renderer for [ioquake3](https://github.com/ioquake/ioq3) that uses [bgfx](https://github.com/bkaradzic/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 |
|---|---|
| [](http://i.imgur.com/WHYjbF0.jpg) | [](http://i.imgur.com/vPhQbMc.jpg) |
| Planar Reflections | Soft Sprites |
|---|---|
| [](http://i.imgur.com/ShxFR3o.jpg) | [](http://i.imgur.com/LvMyLgB.jpg) |
## Compiling
`premake5 gmake` if premake5 is in your PATH. Otherwise, `./bin/premake5 gmake` to use the local copy of premake.
The generated makefiles are written to `build`.
### Linux requirements
Packages: libgl1-mesa-dev libsdl2-dev
### Cygwin/MinGW-w64/MSYS2 requirements
ioquake3 SDL2 libs and headers are required. Clone [ioquake3](https://github.com/ioquake/ioq3) to the same parent directory as ioq3-renderer-bgfx.
### Visual Studio
Use [ioq3-premake-msvc](https://github.com/jpcy/ioq3-premake-msvc).
## Recompiling Shaders
Linux/Cygwin/MinGW-w64/MSYS2: `premake5 shaders` or `./bin/premake5 shaders`
Visual Studio: run `bin/shaders.bat`
## Usage
Copy the renderer binaries from `build\bin_*` to where you have a [ioquake3 test build](http://ioquake3.org/get-it/test-builds/) 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](https://en.wikipedia.org/wiki/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.