Skip to content

Commit ff002be

Browse files
Updated README to reflect some of the newer changes
1 parent 17b2812 commit ff002be

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This file contains the following sections:
3333
9. [Compiling on Windows](#compile_windows)
3434
10. [Compiling on Linux](#compile_linux)
3535
11. [Compiling on macOS](#compile_macos)
36-
12. [Getting the Game Data](#installation)
36+
12. [Installation](#installation)
3737
13. [New Console Variables](#console)
3838
14. [Known Issues](#issues)
3939
15. [Bug Reports](#reports)
@@ -85,14 +85,19 @@ RBDOOM-3-BFG allows mod editing and has many tiny fixes so custom content can be
8585
* New PBR related material keywords like basecolormap, normalmap, rmaomap
8686
* invertGreen( normalmap.png ) material keyword to allow flipping the Y-Axis for tangent space normal maps
8787
* glTF2 .glb model support for static and skinned models (thanks to Harrie van Ginneken)
88+
* Added back dmap and aas compilers as `standalone rbdmap.exe` tool (thanks to Pat Raynor) and improved them to work with TrenchBroom and Blender
8889
* Changed dmap to support compiling maps straight from glTF2 .glb models instead of .map files using a new polygon based workflow
8990
* Wavefront OBJ model support to make it easier getting static models from Blender/Maya/3D Studio Max into TrenchBroom
90-
* Added back dmap and aas compilers (mapping tools, thanks to Pat Raynor) and improved them to work with TrenchBroom and Blender
9191
* Added in-engine Flash debugging tools and new console variables
9292
* Added support for Mikkelsen tangent space standard for new assets (thanks to Stephen Pridham)
9393
* Bumped the static vertex cache limit of 31 MB to roughly ~ 128 MB to help with some custom models and maps by the Doom 3 community
9494
* com_showFPS bigger than 1 uses ImGui to show more detailed renderer stats like the original console prints with r_speeds
95-
* Native C++ AI & Weapons framework instead of Doomscript in the IcedHellfire mod by Justin Marshall (mods/icedhellfire branch)
95+
* .png .exr .hdr image support
96+
* .ogg sound file support
97+
* .pk4 archive support
98+
* Reworked virtual filesystem so .resources and .pk4 archives in mod directories have a higher priority than in base/
99+
* Native C++ AI & Weapons framework instead of Doomscript in the IcedHellfire mod by Justin Marshall (`mods/icedhellfire` Git branch)
100+
96101

97102
If you want to start mod from a directory, you should first specify your mod directory adding the following command to the launcher:
98103

@@ -115,7 +120,7 @@ Short term goals:
115120

116121
---
117122
# May or may not ".plan" <a name="plan2"></a>
118-
* Replace expensive multipass forward shading with a faster forward+ solution
123+
* Replace traditional multipass forward shading with a faster forward+ solution
119124
* [Volumetric Lighting](http://www.alexandre-pestana.com/volumetric-lights/)
120125
* ReSTIR or some other realtime path tracing
121126
* Optional alternative collision detection and physics with PhysX 5 or Jolt
@@ -482,9 +487,9 @@ Recommended in this case is `cmake-vs2022-win64-no-ffmpeg.bat`
482487

483488
> make -j<number of your cores>
484489

485-
6. Copy the base folder of your `Steam/steamapps/common/DOOM 3 BFG Edition/base/` over to `DoomCode/base/` See also [Getting the Game Data](#installation)
490+
6. Copy the base folder of your `Steam/steamapps/common/DOOM 3 BFG Edition/base/` over to `DoomCode/base/` See also [Installation](#installation)
486491

487-
7. [`OPTIONAL`] Download https://www.moddb.com/mods/rbdoom-3-bfg/downloads/rbdoom-3-bfg-130 and unpack it over your DoomCode/ folder and then run in `DoomCode/`
492+
7. [`OPTIONAL`] Download https://www.moddb.com/mods/rbdoom-3-bfg/downloads/rbdoom-3-bfg-130 and unpack it over your `DoomCode/` folder and then run in `DoomCode/`
488493

489494
> git checkout .
490495
@@ -537,11 +542,11 @@ Recommended in this case is `cmake-vs2022-win64-no-ffmpeg.bat`
537542
For Xcode builds double click on `DoomCode/xcode-\<buildtype\>/RBDoom3BFG.xcodeproj` and start the build. The generated Xcode project file is pre-configured with the correct targets and build settings.
538543

539544
---
540-
# Installation, Getting the Game Data, Running the Game <a name="installation"></a>
545+
# Installation <a name="installation"></a>
541546

542547
## For 99% of all users:
543548

544-
1. Download the newest version from the [RBDOOM-3-BFG Mod DB Page](https://www.moddb.com/mods/rbdoom-3-bfg)
549+
1. Download the newest version from the [RBDOOM-3-BFG ModDB Page](https://www.moddb.com/mods/rbdoom-3-bfg)
545550

546551
<a href="https://www.moddb.com/mods/rbdoom-3-bfg" title="View RBDOOM-3-BFG on Mod DB" target="_blank"><img src="https://button.moddb.com/popularity/medium/mods/49231.png" alt="RBDOOM-3-BFG" /></a>
547552

@@ -555,7 +560,7 @@ Those packages don't ship with the precomputed light data but have everything el
555560

556561
3. Copy `base/` from your Steam Doom 3 BFG folder into `DoomBFG`
557562

558-
4. Download the RBDOOM-3-BFG 1.3.0 full package from the RBDOOM-3-BFG ModDB page and extract it over DoomBFG
563+
4. Download the RBDOOM-3-BFG 1.3.0 full package from the RBDOOM-3-BFG ModDB page and extract it over `DoomBFG`
559564

560565
5. Do the same with the newest version version which acts like a patch
561566

0 commit comments

Comments
 (0)