From 39a36613d7bf9f55facf2d570a8fc2d99a6a22fb Mon Sep 17 00:00:00 2001 From: Magnus Norddahl Date: Mon, 18 Mar 2024 02:07:30 +0100 Subject: [PATCH] Update README.md --- README.md | 48 +++++++++++++++++------------------------------- 1 file changed, 17 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 4afe84b..3565a30 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,20 @@ -# Unreal Tournament VulkanDrv -This project implements a vulkan render device for Unreal Tournament (UT99). +# Unreal Tournament Render Devices +This project implements Vulkan, Direct3D 12, and Direct3D 11 render devices for Unreal Tournament (UT99). ## Compiling the source The project files were made for Visual Studio 2022. Open VulkanDrv.sln, select the release configuration and press build. -Note: This project can no longer be built without the 469 SDK. It also requires 469c or newer to run. +Note: This project requires the 469 SDK. It also requires 469c or newer to run. -## Using VulkanDrv as the render device +## Using VulkanDrv, D3D11Drv or D3D12Drv as the render device -Copy the VulkanDrv.dll and VulkanDrv.int files to the Unreal Tournament system folder. +Copy the .dll and .int files files to the Unreal Tournament system folder. -In the [Engine.Engine] section of UnrealTournament.ini, change GameRenderDevice to VulkanDrv.VulkanRenderDevice +In the [Engine.Engine] section of UnrealTournament.ini, change GameRenderDevice to VulkanDrv.VulkanRenderDevice, D3D12Drv.D3D12RenderDevice or D3D11Drv.D3D11RenderDevice. Then launch the game. -Add the following section to the file: +All the render devices supports the following renderdev specific settings in each their section of the UnrealTournament.ini file: - [VulkanDrv.VulkanRenderDevice] LODBias=-0.500000 GammaOffsetBlue=0.000000 GammaOffsetGreen=0.000000 @@ -30,10 +29,17 @@ Add the following section to the file: Saturation=255 Contrast=128 LinearBrightness=128 + +VulkanDrv specific settings: + VkDebug=False VkDeviceIndex=0 VkExclusiveFullscreen=False +D3D12Drv specific settings: + + UseDebugLayer=False + ## Description of settings - LightMode: @@ -59,33 +65,13 @@ Add the following section to the file: ## Description of VulkanDrv specific settings -- VkDebug enables the vulkan debug layer and will cause the render device to output extra information into the UnrealTournament.log file. 'VkMemStats' can also be typed into the console. +- VkDebug enables the vulkan debug layer and will make the render device output extra information into the UnrealTournament.log file. 'VkMemStats' can also be typed into the console. - VkExclusiveFullscreen enables vulkan's exclusive full screen feature. It is off by default as some users have reported problems with it. - VkDeviceIndex selects which vulkan device in the system the render device should use. Type 'GetVkDevices' in the system console to get the list of available devices. -## Using D3D11Drv as the render device - -This project now also contains a Direct3D 11 render device. To use it, copy the D3D11Drv.dll and D3D11Drv.int files to the Unreal Tournament system folder. - -In the [Engine.Engine] section of UnrealTournament.ini, change GameRenderDevice to D3D11Drv.D3D11RenderDevice +## Description of D3D12Drv specific settings -Add the following section to the file: - - [D3D11Drv.D3D11RenderDevice] - LODBias=-0.500000 - GammaOffsetBlue=0.000000 - GammaOffsetGreen=0.000000 - GammaOffsetRed=0.000000 - GammaOffset=0.000000 - GammaMode=D3D9 - UseVSync=True - LightMode=Normal - OccludeLines=True - Hdr=False - AntialiasMode=MSAA_4x - Saturation=255 - Contrast=128 - LinearBrightness=128 +- UseDebugLayer enables the D3D12 debug layer and will make the render device output extra information into the UnrealTournament.log file for any errors or warnings. ## License