Iortcw 1.42b linux x86 64

README

Rend2
<insert ascii art here>

Rend2 is an alternate renderer for iortcw.  It aims to implement modern
features and technologies into the id tech 3 engine, but without sacrificing
compatibility with existing RTCW mods.


-------------------------------------------------------------------------------
  FEATURES
-------------------------------------------------------------------------------

  - Compatible with most vanilla RTCW mods.
  - HDR Rendering, and support for HDR lightmaps
  - Tone mapping and auto-exposure.
  - Cascaded shadow maps.
  - Multisample anti-aliasing.
  - Texture upsampling.
  - Advanced materials support.
  - Advanced shading and specular methods.
  - LATC and BPTC texture compression support.
  - Screen-space ambient occlusion.


-------------------------------------------------------------------------------
  INSTALLATION
-------------------------------------------------------------------------------

For *nix:

1. This should be identical to installing iortcw.  Check their README for more
   details.

   
For Win32:

1. Have a RTCW install, fully patched.

2. Copy the following files into RTCW's install directory: 
     
     ioWolfMP.x86.exe
     renderer_opengl1_x86.dll
     renderer_rend2_x86.dll
     
   These can be found in build/release-mingw32-x86 after compiling, or bug
   someone to release binaries.
  

-------------------------------------------------------------------------------
  RUNNING
-------------------------------------------------------------------------------

1. Start iowolfmp. (ioWolfMP.x86.exe on Win32)
 
2. Open the console (default key ~) and type '/cl_renderer rend2; vid_restart'

3. Enjoy.


-------------------------------------------------------------------------------
  CVARS
-------------------------------------------------------------------------------

Cvars for simple rendering features:
  r_ext_compressed_textures       - Automatically compress textures.
                                     0 - No texture compression. (default)
                                     1 - DXT/LATC texture compression if
                                         supported.
                                     2 - BPTC texture compression if supported.

  r_ext_framebuffer_multisample  - Multisample Anti-aliasing.
                                     0    - None. (default)
                                     1-16 - Some.
                                     17+  - Too much!

  r_ssao                         - Enable screen-space ambient occlusion.
                                   Currently eats framerate and has some
                                   visible artifacts.
                                     0 - No. (default)
                                     1 - Yes.

Cvars for HDR and tonemapping:
  r_hdr                          - Do scene rendering in a framebuffer with
                                   high dynamic range.  (Less banding, and
                                   exposure changes look much better)
                                     0 - No.
                                     1 - Yes. (default)

  r_cameraExposure               - Cheat.  Alter brightness, in powers of two.
                                     -2  - 4x as dark.
                                     0   - Normal. (default)
                                     0.5 - Sqrt(2)x as bright.
                                     2   - 4x as bright.

  r_postProcess                  - Enable post-processing.
                                     0 - No.
                                     1 - Yes. (default)

  r_toneMap                      - Enable tone mapping.  Requires 
                                   r_hdr and r_postProcess.
                                     0 - No.
                                     1 - Yes. (default)

  r_forceToneMap                 - Cheat.  Override built-in and map tonemap
                                   settings and use cvars r_forceToneMapAvg,
                                   r_forceToneMapMin, and r_forceToneMapMax.
                                     0 - No. (default)
                                     1 - Yes.

  r_forceToneMapAvg              - Cheat.  Map average scene luminance to this
                                   value, in powers of two.  Requires 
                                   r_forceToneMap.
                                    -2.0 - Dark.
                                    -1.0 - Kinda dark. (default).
                                     2.0 - Too bright.

  r_forceToneMapMin              - Cheat.  After mapping average, luminance
                                   below this level is mapped to black.
                                   Requires r_forceToneMap.
                                    -5    - Not noticeable.
                                    -3.25 - Normal. (default)
                                     0.0  - Too dark.

  r_forceToneMapMin              - Cheat.  After mapping average, luminance
                                   above this level is mapped to white.
                                   Requires r_forceToneMap.
                                    0.0 - Too bright.
                                    1.0 - Normal. (default).
                                    2.0 - Washed out.

  r_autoExposure                 - Do automatic exposure based on scene
                                   brightness.  Hardcoded to -2 to 2 on maps
                                   that don't specify otherwise.  Requires
                                   r_hdr, r_postprocess, and r_toneMap.
                                     0 - No.
                                     1 - Yes. (default)
                                     
  r_forceAutoExposure            - Cheat.  Override built-in and map auto
                                   exposure settings and use cvars
                                   r_forceAutoExposureMin and 
                                   r_forceAutoExposureMax.
                                     0 - No. (default)
                                     1 - Yes.

  r_forceAutoExposureMin         - Cheat.  Set minimum exposure to this value,
                                   in powers of two.  Requires
                                   r_forceAutoExpsure.
                                    -3.0 - Dimmer.
                                    -2.0 - Normal. (default)
                                    -1.0 - Brighter.

  r_forceAutoExposureMax         - Cheat.  Set maximum exposure to this value,
                                   in powers of two.  Requires
                                   r_forceAutoExpsure.
                                     1.0 - Dimmer.
                                     2.0 - Normal. (default)
                                     3.0 - Brighter.

Cvars for advanced material usage:
  r_normalMapping                - Enable normal mapping for materials that
                                   support it, and also specify advanced 
                                   shading techniques.
                                     0 - No.
                                     1 - Yes. (default)
                                     2 - Yes, and use Oren-Nayar reflectance
                                         model.
                                     3 - Yes, and use tri-Ace's Oren-Nayar
                                         reflectance model.

  r_specularMapping              - Enable specular mapping for materials that
                                   support it, and also specify advanced
                                   specular techniques.
                                     0 - No.
                                     1 - Yes, and use tri-Ace. (default)
                                     2 - Yes, and use Blinn-Phong.
                                     3 - Yes, and use Cook-Torrance.
                                     4 - Yes, and use Torrance-Sparrow.

  r_deluxeMapping                - Enable deluxe mapping.  (Map is compiled
                                   with light directions.)  Even if the map 
                                   doesn't have deluxe mapping compiled in,
                                   an approximation based on the lightgrid
                                   will be used.
                                     0 - No.
                                     1 - Yes. (default)

  r_parallaxMapping              - Enable parallax mapping for materials that
                                   support it.
                                     0 - No. (default)
                                     1 - Use parallax occlusion mapping.
                                     2 - Use relief mapping. (slower)

  r_baseSpecular                 - Set the specular reflectance of materials
                                   which don't include a specular map or
                                   use the specularReflectance keyword.
                                     0    - No.
                                     0.04 - Realistic. (default)
                                     1.0  - Ack.

  r_baseGloss                    - Set the glossiness of materials which don't
                                   include a specular map or use the
                                   specularExponent keyword.
                                     0   - Rough.
                                     0.3 - Default.
                                     1.0 - Shiny.

  r_baseNormalX                  - Set the scale of the X values from normal
                                   maps when the normalScale keyword is not
                                   used.
                                     -1  - Flip X.
                                     0   - Ignore X.
                                     1   - Normal X. (default)
                                     2   - Double X.

  r_baseNormalY                  - Set the scale of the Y values from normal