Updated README

README.txt

@@ -33,19 +33,17 @@ This file contains the following sections:
 
 	6) COMPILING ON GNU/LINUX
 	
-	7) GETTING THE GAMEDATA, RUNNING THE GAME
+	7) INSTALLATION, GETTING THE GAMEDATA, RUNNING THE GAME
 	
 	8) CHANGES
 	
-	9) FEATURES
+	9) CONSOLE VARIABLES
 	
-	10) CONSOLE VARIABLES
+	10) KNOWN ISSUES
 	
-	11) KNOWN ISSUES
+	11) BUG REPORTS
 	
-	12) BUG REPORTS
+	12) CODE LICENSE EXCEPTIONS
-	
-	13) CODE LICENSE EXCEPTIONS
 
 
 
@@ -173,10 +171,7 @@ _________________________
 		"libffmpeg1-devel" requires the PackMan repository. If you don't have that repo, and don't want to add it, remove the "libffmpeg1-devel" option and compile without ffmpeg support.
 		If you have the repo and compiles with ffmpeg support, make sure you download "libffmpeg1-devel", and not "libffmpeg-devel".
 	
-	Instead of SDL1.2 development files you can also use SDL2, but so far it 
+	Instead of SDL1.2 development files you can also use SDL2. Install SDL 2.0 and add to the cmake parameters -DSDL2=ON
-	seems like no distributions except openSUSE has packages for it yet, so you may have to 
-	compile and install SDL2 yourself. 
-	(There may be inofficial repositories like Ubuntu PPAs)
 	
 	SDL2 has better input support (especially in the console) and better 
 	support for multiple displays (especially in fullscreen mode).
@@ -194,9 +189,18 @@ _________________________
 
 ___________________________________________________
 
-7) GETTING THE GAMEDATA, RUNNING THE GAME
+7) INSTALLATION, GETTING THE GAMEDATA, RUNNING THE GAME
 __________________________________________
 
+
+If you use the prebuilt Win32 binaries then simply extract them to your
+C:\Program Files (x86)\Steam\SteamApps\common\Doom 3 BFG Edition\ directory and run RBDoom3BFG.exe.
+
+
+
+
+The following instructions are primarily intented for Linux users and all hackers on other operating systems.
+
 To play the game, you need the game data from a legal copy of the game, which 
 unfortunately requires Steam for Windows - Steam for Linux or OSX won't do, because
 (at least currently) the Doom 3 BFG game is only installable on Steam for Windows.
@@ -241,46 +245,60 @@ Anyway:
 
 6. Enjoy
 
-7. If you run into bugs, please report them, see 12)
+7. If you run into bugs, please report them, see 11)
 
 ___________________________________________________
 
 8) CHANGES
 __________________________________________
 
-	* Flexible build system using CMake
+- Flexible build system using CMake
-	* Linux support (32 and 64 bit)
+
-	* New OpenAL Soft sound backend primarily developed for Linux but works on Windows as well
+- Linux support (32 and 64 bit)
-	* Win64 support
+
+- New OpenAL Soft sound backend primarily developed for Linux but works on Windows as well
+
+- Win64 support
+
+- Implemented soft shadows using PCF hardware shadow mapping
+
+	The implementation uses sampler2DArrayShadow and PCF which usually
+	requires Direct3D 10.1 however it is in the OpenGL 3.2 core so it should
+	be widely supported.
+	All 3 light types are supported which means parallel lights (sun) use
+	scene independent cascaded shadow mapping.
+	The implementation is very fast with single taps (400 fps average per
+	scene on a GTX 660 ti OC) however I defaulted it to 16 taps so the shadows look
+	really good which should you give stable 100 fps on todays hardware.
+
+	The shadow filtering algorithm is based on Carmack's research which was
+	released in the original Doom 3 GPL release draw_exp.cpp.
+
+- Changed light interaction shaders to use Half-Lambert lighting like in Half-Life 2 to 
+	make the game less dark. https://developer.valvesoftware.com/wiki/Half_Lambert
+
 
 ___________________________________________________
 
-9) FEATURES
+9) CONSOLE VARIABLES
 __________________________________________
 
-// TODO
+r_useShadowMapping 1 - Use soft shadow mapping instead of hard stencil shadows
+
 
 ___________________________________________________
 
-10) CONSOLE VARIABLES
+10) KNOWN ISSUES
 __________________________________________
 
-// TODO
+Doom 3 wasn't designed to work with shadow maps so:
 
+- Some lights cause shadow acne with shadow mapping
+- Some shadows might almost disappear due to the shadow filtering
 
 ___________________________________________________
 
-11) KNOWN ISSUES
+11) BUG REPORTS
-__________________________________________
-
-	* Doomclassic is not supported on Linux (yet)
-	* There are some issues with the binary format loaders/writers on 64 bit platforms
-	* The intel open source drivers to not support OpenGL 3.2 yet
-
-
-___________________________________________________
-
-12) BUG REPORTS
 __________________________________________
 
 RBDOOM-3-BFG is not perfect, it is not bug free as every other software.
@@ -310,7 +328,7 @@ NOTE: We cannot help you with OS-specific issues like configuring OpenGL correct
 	
 ____________________________________________________________________________________
 
-13) CODE LICENSE EXCEPTIONS - The parts that are not covered by the GPL:
+12) CODE LICENSE EXCEPTIONS - The parts that are not covered by the GPL:
 _______________________________________________________________________