diff --git a/README.md b/README.md index 622324d8..4e763db8 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ I started this project in 2012 and focused on making this code being future proo All 3 light types (point, spot, parallel/sun) are supported which means parallel lights (sun) use scene independent cascaded shadow mapping. * True internal 64 bit HDR lighting with filmic ACES tone mapping and gamma-correct rendering in linear RGB space -* Enhanced Subpixel Morphological Antialiasing as a cheap alternative for MSAA. For more information see "Anti-Aliasing Methods in CryENGINE 3" and the docs at http://www.iryoku.com/smaa/ +* Enhanced Subpixel Morphological Antialiasing as a cheap alternative for MSAA and that works well with HDR. For more information see "Anti-Aliasing Methods in CryENGINE 3" and the docs at http://www.iryoku.com/smaa/ * Filmic post process effects like Chromatic Aberration and Dithering * Screen Space Ambient Occlusion http://graphics.cs.williams.edu/papers/SAOHPG12/ used to only dim down the Global Illumination contribution like in the Frostbite engine * Bink video playback through libbinkdec (thanks to Daniel Gibson) or FFmpeg (thanks to Carl Kenner) @@ -80,19 +80,14 @@ I started this project in 2012 and focused on making this code being future proo ## Modding Support RBDOOM-3-BFG allows mod editing and has many tiny fixes so custom content can be put into mod directories and the engine accepts it like vanilla Doom 3. DOOM 3 BFG wasn't designed for actual development or modding support. Many things like reading anything outside of the packed resource files was not supported. I also fixed many things in the renderer like r_showTris. +* TrenchBroom Mapping Support - see more information in the TrenchBroom section * New PBR related material keywords like basecolormap, normalmap, rmaomap * invertGreen( normalmap.png ) material keyword to allow flipping the Y-Axis for tangent space normal maps * PNG image support * Collada .DAE model support in addition to .ase and .lwo for static map models * Wavefront OBJ model support to make it easier getting static models from Blender/Maya/3D Studio Max into TrenchBroom * Added back dmap and aas compilers (mapping tools, thanks to Pat Raynor) and improved them to work with TrenchBroom -* Added in-engine Flash debugging tools and new console variables. - These tools help to analyse the id Tech view of Flash and what SWF tags are supported and how they are interpreted - by id Tech's own ActionScript 2 interpreter - - postLoadExportFlashAtlas - - postLoadExportFlashToSWF - - postLoadExportFlashToJSON - - swf_show : Draws the bounding box of instanced Flash sprites in red and their names +* Added in-engine Flash debugging tools and new console variables * Added Steel Storm 2 Engine render demo fixes * Merged LordHavoc's image compression progress bar which shows up in the map loading screen when loading and compressing new images from mods @@ -109,14 +104,6 @@ so it would end up looking like: RBDoom3BFG +set fs_game modDirectoryName IMPORTANT: RBDOOM-3-BFG does not support old Doom 3 modifications that include sourcecode modifications in binary form (.dll) You can fork RBDOOM-3-BFG and create a new renamed binary that includes all required C++ game code modifications. -## TrenchBroom Mapping Support -***The goal of the TrenchBroom support is to make mapping for RBDOOM-3-BFG as easy as for Quake 1.*** - -* idMapFile and dmap were changed to support the Valve 220 .map format to aid mapping with TrenchBroom -* Added exportFGD `[nomodels]` console command which exports all def/*.def entityDef declarations to base/exported/_tb/ as Forge Game Data files. TrenchBroom has native support to read those files https://developer.valvesoftware.com/wiki/FGD. -If the nomodels argument is not given then it will also export all needed models by entity declarations to base/_tb/ as Wavefront OBJ files. -* Support ***angles*** keyword again for TrenchBroom like in Quake 3 - --- # ".plan" @@ -351,48 +338,28 @@ The first top band is the original signal. The second shows just 8 blocks and if # TrenchBroom Mapping Support - + -***This is still very much Work in Progress and not supported by the official TrenchBroom.*** +***The goal of the TrenchBroom support is to make mapping for RBDOOM-3-BFG as easy as for Quake 1.*** -Mapping for Doom 3 using TrenchBroom requires an extended unofficial build that is bundled with the official RBDOOM-3-BFG 7z package. +Mapping for Doom 3 BFG using TrenchBroom requires an extended unofficial build that is bundled with the official RBDOOM-3-BFG 7z package. You can find the customized version under tools/trenchbroom/. -You can get the source of that version here: +More information about this custom TrenchBroom and the source code is here: -https://github.com/RobertBeckebans/TrenchBroom/tree/doom3-support3 +https://github.com/RobertBeckebans/TrenchBroom -Doom 3 also requires some extensions in order to work with TrenchBroom. I usually develop these things for RBDOOM-3-BFG but I created a seperated brach for vanilla Doom 3 so everybody can adopt TrenchBroom and the new Doom 3 (Valve) .map support. +Doom 3 BFG also requires some extensions in order to work with TrenchBroom. +The Quake 1/2/3 communities already adopted the Valve 220 .map format in the BSP compilers and I did the same with dmap in RBDOOM-3-BFG. -https://github.com/RobertBeckebans/DOOM-3/tree/506-TrenchBroom-interop - -The goal of the TrenchBroom support is to make it easier to create new maps. It doesn't allow to create bezier patches at the moment so you won't be able to edit existing Doom 3 maps. - -You can only save maps to the Doom 3 Valve format but you can copy paste from the vanilla Doom 3 .map format into the Doom 3 (Valve)configuration and reset your texture alignment as you want. -TrenchBroom doesn't support brush primitives like in D3Radiant or DarkRadiant and if you are familiar with TrenchBroom then you know that the preferred .map format is some kind of (Valve) .map format for your game. - -The Quake 1/2/3 communities already adopted the Valve .map format in the BSP compilers and I did the same with dmap in RBDOOM-3-BFG. - -Here is an overview of the changes made to TrenchBroom: - -***New*** -* Doom 3 .map parser with brushDef3, patchDef2, patchDef3 primitives -* Doom 3 Valve .map configuration -* Quake 3 .shader parser adopted to support .mtr -* .mtr support includes support for Doom 3 diffuse stages and the lookup for them is like in idMaterial::GetEditorImage() -* New Doom 3 OBJ parser. My TB Interop branch automatically creates OBJ files to work with TB and it also allows seamless interop with Blender 2.8x and 2.9x with the need of additional model formats for func_static entities (like misc_model for Quake 3) -* Game FGDs for Doom 3 and Doom 3 BFG - -***Issues*** -* It has no support for BFG .resource files and .bimage files. BFG only shipped for precompressed textures and no .tga files so people who want to mod for BFG have to copy the vanilla D3 base/textures/* and base/models/* to D3BFG/base/ -* Many entities work differently in Doom 3 if they have an origin. Brush work in D3 is usually stored in entity space and not world space. This is a major issue. For new maps textures/common/origin has been reintroduced in the engine like in former times -* Doom 3's primary model formats are LWO and ASE. LWO and .md5mesh model support is missing. -* Some ASE models can't be loaded and materials are usually all wrong if loaded -* TrenchBroom doesn't support the "rotation" keyword and many models have the wrong orientation -* The custom TrenchBroom build breaks compatibility for other id Tech engines, e.g. entity links work between "target[num]" and "name" and not "targetname" - -### Some Scenes of Mars City 1 loaded into TrenchBroom - +### TrenchBroom speficic Changes +* idMapFile and dmap were changed to support the Valve 220 .map format to aid mapping with TrenchBroom +* Added exportFGD `[nomodels]` console command which exports all def/*.def entityDef declarations to base/exported/_tb/ as Forge Game Data files. TrenchBroom has native support to read those files https://developer.valvesoftware.com/wiki/FGD. +If the nomodels argument is not given then it will also export all needed models by entity declarations to base/_tb/ as Wavefront OBJ files. +* Support ***angles*** keyword again for TrenchBroom like in Quake 3 +* Added cmd convertMapToValve220 `` +* Added cmd exportImagesToTrenchBroom which decompresses and saves all .bimage images to _tb/*.png files +* Added cmd exportModelsToTrenchBroom which saves all .base|.blwo|.bmd5mesh models to _tb/*.obj files --- @@ -405,12 +372,13 @@ Directory | Description RBDOOM-3-BFG/base/ | Doom 3 BFG media directory ( models, textures, sounds, maps, etc. ) RBDOOM-3-BFG/neo/ | RBDOOM-3-BFG source code ( renderer, game code for multiple games, OS layer, etc. ) RBDOOM-3-BFG/build/ | Build folder for CMake -RBDOOM-3-BFG/tools/blender/ | Blender scripts for level mapping +RBDOOM-3-BFG/tools/blender/ | Blender scripts for level mapping (TBD in release packages) RBDOOM-3-BFG/tools/trenchbroom | TrenchBroom level editor customized for DOOM 3 and RBDOOM-3-BFG RBDOOM-3-BFG/tools/darkradiant | DarkRadiant level editor with an additional config for RBDOOM-3-BFG RBDOOM-3-BFG/tools/runtimedeps | Visual Studio C++ Redistributables if you have problems to start the engine or the tools +RBDOOM-3-BFG/tools/bfgpakexlorer| BFG Resource File Manager by George Kalampokis aka Mr.GK -This release does not contain any game data, the game data is still +The GPL release does not contain any game data, the game data is still covered by the original EULA and must be obeyed as usual. You must patch the game to the latest version. @@ -673,7 +641,7 @@ Name | Description :--------------------------------------| :------------------------------------------------ r_antiAliasing | Different Anti-Aliasing modes r_useShadowMapping [0 or 1] | Use soft shadow mapping instead of hard stencil shadows -r_hdrAutoExposure [0 or 1] | Adaptive tonemapping with HDR. This allows to have very bright or very dark scenes but the camera will adapt to it so the scene won't loose details +r_hdrAutoExposure [0 or 1] | Adaptive tonemapping with HDR. This allows to have very bright or very dark scenes but the camera will adapt to it so the scene won't loose details. Default is 0 r_exposure [0 .. 1] | Default 0.5, Controls brightness and affects HDR -> sRGB Rec. 709 exposure key. This is what you change in the video brightness options r_useSSAO [0 .. 1] | Use Screen Space Ambient Occlusion to darken the corners in the scene r_useFilmicPostProcessing [0, 1] | Apply several post process effects to mimic a filmic look @@ -735,11 +703,14 @@ You can find your qconsole.log on Windows in C:\Users\\Saved Gam # FAQ **Q**: Why bother with DOOM-3-BFG in 2021? -**A**: It is fun, period. Doom 3 was an impressive milestone in total game development in 2004. In 2011 id Software added lot stuff from the development of Rage like its own Flash SWF and ActionScript 2 interpreter, proper support for gamepads and widescreens. It also combines the gamecode for Doom 3 and its missionpacks and runs it in a seperate thread and it has many multithreaded rendering optimizations. +**A**: It is fun, period. Doom 3 is from 2004 but is still an impressive and entertaining game. In 2011 id Software added lot stuff from the development of Rage like its own Flash SWF and ActionScript 2 interpreter, proper support for gamepads and widescreens. It also combines the gamecode for Doom 3 and its missionpacks and runs it in a seperate thread and it has many multithreaded rendering optimizations. DOOM-3 and DOOM-3-BFG are some of the most transparent games available where you can open all files and inspect how the game was built. Unlike Quake 1-3, DOOM-3-BFG shipped with all level .map sources for 47 single player maps. There is plenty of stuff you can learn from it like solid run & gun core gameplay, AI, animations, client/server multiplayer, level design or simple and elegant engine design. +**Q**: Why bother with DOOM-3-BFG in 2022? +**A**: The engine compiles faster than opening a project in Unity. + **Q**: Can I use this engine to make a commercial game? **A**: You can but don't bother me to give you free support and you probably should use Unreal Engine 4. I am a full time game developer and usually don't have time for any free support. diff --git a/base/def/_rbdoom_misc_model.def b/base/def/_rbdoom_misc_model.def deleted file mode 100644 index 158446e3..00000000 --- a/base/def/_rbdoom_misc_model.def +++ /dev/null @@ -1,12 +0,0 @@ -entityDef misc_model -{ - "inherit" "func_static" - "editor_color" "0 .5 .8" - "editor_mins" "-12 -12 -12" - "editor_maxs" "12 12 12" - "editor_rotatable" "1" - - "editor_usage" "Inherits from a func_static but is fixed size and a FGD PointClass." - "editor_usage1" "Use it to place all kinds of models" - "angles" "0 0 0" -} \ No newline at end of file diff --git a/base/def/_tb_helpers.def b/base/def/_tb_helpers.def new file mode 100644 index 00000000..5f0f6037 --- /dev/null +++ b/base/def/_tb_helpers.def @@ -0,0 +1,49 @@ +entityDef misc_model +{ + "inherit" "func_static" + "editor_color" "0 .5 .8" + "editor_mins" "-12 -12 -12" + "editor_maxs" "12 12 12" + "editor_rotatable" "1" + + "editor_usage" "Inherits from a func_static but uses a model and is a FGD PointClass so it displays correctly in TrenchBroom." + "editor_usage1" "Use it to place all kinds of models" + "angles" "0 0 0" +} + +entityDef func_door_model +{ + "inherit" "func_door" + + "editor_usage" "Inherits from a func_door but uses a model and is a FGD PointClass so it displays correctly in TrenchBroom." + "editor_usage1" "Use it to place all kinds of models" + "angles" "0 0 0" +} + +/* +already exists and is called func_mover_amodel ... + +entityDef func_mover_model +{ + "inherit" "func_mover" + + "editor_usage" "Inherits from a func_mover but uses a model and is a FGD PointClass so it displays correctly in TrenchBroom." + "angles" "0 0 0" +} +*/ + +entityDef func_rotating_model +{ + "inherit" "func_rotating" + + "editor_usage" "Inherits from a func_rotating but uses a model and is a FGD PointClass so it displays correctly in TrenchBroom." + "angles" "0 0 0" +} + +entityDef func_plat_model +{ + "inherit" "func_plat" + + "editor_usage" "Inherits from a func_plat but uses a model and is a FGD PointClass so it displays correctly in TrenchBroom." + "angles" "0 0 0" +} \ No newline at end of file diff --git a/base/materials/_tb_helpers.mtr b/base/materials/_tb_helpers.mtr new file mode 100644 index 00000000..f6a5742d --- /dev/null +++ b/base/materials/_tb_helpers.mtr @@ -0,0 +1,9 @@ + +// RB: map TrenchBroom's default material to textures/base_wall/snpanel2rust so users have properly sealed maps +__TB_empty +{ + qer_editorimage textures/base_wall/snpanel2rust.tga + bumpmap textures/base_wall/snpanel2_local.tga + diffusemap textures/base_wall/snpanel2rust_d.tga + specularmap textures/base_wall/snpanel2rust_s.tga +} \ No newline at end of file diff --git a/neo/framework/DeclManager.cpp b/neo/framework/DeclManager.cpp index 64940947..1b6d9d95 100644 --- a/neo/framework/DeclManager.cpp +++ b/neo/framework/DeclManager.cpp @@ -2173,6 +2173,7 @@ void idDeclManagerLocal::ExportDeclsToTrenchBroom_f( const idCmdArgs& args ) solidClassNames.AddUnique( "func_rotating" ); solidClassNames.AddUnique( "func_splinemover" ); solidClassNames.AddUnique( "func_static" ); + solidClassNames.AddUnique( "func_mover" ); solidClassNames.AddUnique( "moveable_base" ); solidClassNames.AddUnique( "trigger_" ); @@ -2281,7 +2282,8 @@ void idDeclManagerLocal::ExportDeclsToTrenchBroom_f( const idCmdArgs& args ) for( int i = 0; i < solidClassNames.Num(); i++ ) { const char* solidStr = solidClassNames[ i ].c_str(); - if( idStr::Icmpn( decl->GetName(), solidStr, ( int )strlen( solidStr ) ) == 0 ) + if( idStr::Icmpn( decl->GetName(), solidStr, ( int )strlen( solidStr ) ) == 0 && + !( idStr::FindText( decl->GetName(), "_model", false ) != -1 || idStr::FindText( decl->GetName(), "_amodel", false ) != -1 ) ) { solidClass = true; break; @@ -2340,7 +2342,7 @@ void idDeclManagerLocal::ExportDeclsToTrenchBroom_f( const idCmdArgs& args ) file->Printf( "color(%i %i %i) ", int( color.x * 255 ) & 0xFF, int( color.y * 255 ) & 0xFF, int( color.z * 255 ) & 0xFF ); } -#if 1 +#if 0 //if( idStr::Icmp( decl->GetName(), "monster_zombie_maint_bald" ) == 0 ) if( idStr::Icmp( decl->GetName(), "monster_demon_imp" ) == 0 ) { @@ -2436,7 +2438,11 @@ void idDeclManagerLocal::ExportDeclsToTrenchBroom_f( const idCmdArgs& args ) } if( idStr::Icmp( decl->GetName(), "light" ) == 0 || - idStr::Icmp( decl->GetName(), "func_static" ) == 0 ) + idStr::Icmp( decl->GetName(), "misc_model" ) == 0 || + idStr::Icmp( decl->GetName(), "func_door_model" ) == 0 || + idStr::Icmp( decl->GetName(), "func_mover_amodel" ) == 0 || + idStr::Icmp( decl->GetName(), "func_plat_model" ) == 0 || + idStr::Icmp( decl->GetName(), "func_rotating_model" ) == 0 ) { // entities with dynamic models @@ -2517,7 +2523,11 @@ void idDeclManagerLocal::ExportDeclsToTrenchBroom_f( const idCmdArgs& args ) idStrStatic< MAX_OSPATH > exportedModelFileName; if( idStr::Icmp( decl->GetName(), "light" ) != 0 && - idStr::Icmp( decl->GetName(), "func_static" ) != 0 ) + idStr::Icmp( decl->GetName(), "misc_model" ) != 0 && + idStr::Icmp( decl->GetName(), "func_door_model" ) != 0 && + idStr::Icmp( decl->GetName(), "func_mover_amodel" ) != 0 && + idStr::Icmp( decl->GetName(), "func_plat_model" ) != 0 && + idStr::Icmp( decl->GetName(), "func_rotating_model" ) != 0 ) { //kv = dictToWrite.MatchPrefix( "model" ); //while( kv ) @@ -2563,7 +2573,11 @@ void idDeclManagerLocal::ExportDeclsToTrenchBroom_f( const idCmdArgs& args ) { file->Printf( "model({ \"path\": \"%s\" }) ", exportedModelFileName.c_str() ); } - else if( idStr::Icmp( decl->GetName(), "func_static" ) == 0 ) + else if( idStr::Icmp( decl->GetName(), "misc_model" ) == 0 || + idStr::Icmp( decl->GetName(), "func_door_model" ) == 0 || + idStr::Icmp( decl->GetName(), "func_mover_amodel" ) == 0 || + idStr::Icmp( decl->GetName(), "func_plat_model" ) == 0 || + idStr::Icmp( decl->GetName(), "func_rotating_model" ) == 0 ) { // dynamic model case file->Printf( "model({ \"path\" : model }) " ); diff --git a/neo/idlib/MapFile.cpp b/neo/idlib/MapFile.cpp index 184d84fb..085ca13b 100644 --- a/neo/idlib/MapFile.cpp +++ b/neo/idlib/MapFile.cpp @@ -2905,12 +2905,27 @@ bool idMapFile::ConvertToValve220Format() { // just a regular entity + // TrenchBroom doesn't allow models for SolidClasses so use helper classes instead if( idStr::Icmp( classname, "func_static" ) == 0 && idStr::Icmp( model.c_str(), classname.c_str() ) != 0 ) { - // TrenchBroom doesn't allow models for SolidClasses - // use Quake 3 style misc_model helper class instead ent->epairs.Set( "classname", "misc_model" ); } + else if( idStr::Icmp( classname, "func_door" ) == 0 && idStr::Icmp( model.c_str(), classname.c_str() ) != 0 ) + { + ent->epairs.Set( "classname", "func_door_model" ); + } + else if( idStr::Icmp( classname, "func_mover" ) == 0 && idStr::Icmp( model.c_str(), classname.c_str() ) != 0 ) + { + ent->epairs.Set( "classname", "func_mover_amodel" ); + } + else if( idStr::Icmp( classname, "func_rotating" ) == 0 && idStr::Icmp( model.c_str(), classname.c_str() ) != 0 ) + { + ent->epairs.Set( "classname", "func_rotating_model" ); + } + else if( idStr::Icmp( classname, "func_plat" ) == 0 && idStr::Icmp( model.c_str(), classname.c_str() ) != 0 ) + { + ent->epairs.Set( "classname", "func_plat_model" ); + } // replace "rotation" with angles because it is not supported by TrenchBroom if( ent->epairs.FindKey( "rotation" ) ) @@ -2954,6 +2969,7 @@ bool idMapFile::ConvertToValve220Format() } worldspawn->epairs.Set( "_tb_textures", list ); + worldspawn->epairs.Set( "_tb_def", "builtin:DOOM-3-all.fgd" ); } int n = classTypeOverview.GetNumKeyVals(); diff --git a/zip-RBDOOM-3-BFG-lite-snapshot.bat b/zip-RBDOOM-3-BFG-lite-snapshot.bat index 28042d0f..1e75f5bd 100644 --- a/zip-RBDOOM-3-BFG-lite-snapshot.bat +++ b/zip-RBDOOM-3-BFG-lite-snapshot.bat @@ -1,5 +1,5 @@ REM 7z a RBDOOM-3-BFG-1.3.1.1-lite-win64-20220109-git-xxxxxxx.7z -r base/env/ base/maps/*.lightgrid base/maps/*_extra_ents.map -x!generated -set filename=RBDOOM-3-BFG-1.4.0.1-lite-win64-20220122-git-xxxxxxx.7z +set filename=RBDOOM-3-BFG-1.4.0.2-lite-win64-20220129-git-xxxxxxx.7z 7z a %filename% README.md RELEASE-NOTES.md base/devtools.cfg base/modelviewer.cfg base/extract_resources.cfg base/convert_maps_to_valve220.cfg base/def/*.def base/textures/common base/textures/editor -x!generated -xr!*.xcf 7z a %filename% README.md RELEASE-NOTES.md tools/trenchbroom pause