Skip to content

Commit

Permalink
Updated Readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
= committed Mar 14, 2018
1 parent bb6b424 commit 9a61616
Show file tree
Hide file tree
Showing 6 changed files with 141 additions and 53 deletions.
55 changes: 26 additions & 29 deletions Assets/Scripts/TES/GameSettings.cs
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,7 @@ public static string CheckSettings(TESUnity tes)
case "RenderExteriorCellLights": tes.renderExteriorCellLights = ParseBool(value, tes.renderExteriorCellLights); break;
case "WaterBackSideTransparent": tes.waterBackSideTransparent = ParseBool(value, tes.waterBackSideTransparent); break;
case "RenderPath":
var renderPathID = ParseInt(value, 0);
if (renderPathID == 1 || renderPathID == 3)
tes.renderPath = (RenderingPath)renderPathID;

tes.renderPath = value == "Forward" ? RenderingPath.Forward : RenderingPath.DeferredShading;
break;
case "Shader":
switch (value)
Expand Down Expand Up @@ -155,53 +152,53 @@ public static void CreateConfigFile()
sb.Append("\r\n");

sb.Append("[Global]\r\n");
sb.Append("PlayMusic = \r\n");
sb.Append("PlayMusic = True\r\n");
sb.Append(string.Format("{0} = \r\n", MWDataPathName));
sb.Append("\r\n");

sb.Append("[Rendering]\r\n");
sb.Append("RenderPath = \r\n");
sb.Append("Shader = \r\n");
sb.Append("CameraFarClip = \r\n");
sb.Append("WaterQuality = \r\n");
sb.Append("RenderPath = Deferred\r\n");
sb.Append("Shader = Standard\r\n");
sb.Append("CameraFarClip = 500\r\n");
sb.Append("WaterQuality = 0\r\n");
sb.Append("\r\n");

sb.Append("[Lighting]\r\n");
sb.Append("AnimateLights = \r\n");
sb.Append("SunShadows = \r\n");
sb.Append("LightShadows = \r\n");
sb.Append("RenderExteriorCellLights = \r\n");
sb.Append("DayNightCycle = \r\n");
sb.Append("GenerateNormalMap = \r\n");
sb.Append("NormalGeneratorIntensity = \r\n");
sb.Append("AnimateLights = True\r\n");
sb.Append("SunShadows = True\r\n");
sb.Append("LightShadows = False\r\n");
sb.Append("RenderExteriorCellLights = True\r\n");
sb.Append("DayNightCycle = True\r\n");
sb.Append("GenerateNormalMap = True\r\n");
sb.Append("NormalGeneratorIntensity = 0.75\r\n");
sb.Append("\r\n");

sb.Append("[Effects]\r\n");
sb.Append("AntiAliasing = \r\n");
sb.Append("PostProcessQuality = \r\n");
sb.Append("WaterBackSideTransparent = \r\n");
sb.Append("AntiAliasing = True\r\n");
sb.Append("PostProcessQuality = 3\r\n");
sb.Append("WaterBackSideTransparent = False\r\n");
sb.Append("\r\n");

sb.Append("[VR]\r\n");
sb.Append("FollowHeadDirection = \r\n");
sb.Append("DirectModePreview = \r\n");
sb.Append("RoomScale = \r\n");
sb.Append("ForceControllers = \r\n");
sb.Append("XRVignette = \r\n");
sb.Append("FollowHeadDirection = True\r\n");
sb.Append("RoomScale = False\r\n");
sb.Append("ForceControllers = True\r\n");
sb.Append("XRVignette = False\r\n");
sb.Append("\r\n");

sb.Append("[Debug]\r\n");
sb.Append("CreaturesEnabled = \r\n");
sb.Append("CreaturesEnabled = False\r\n");

File.WriteAllText(ConfigFile, sb.ToString());
}

private static bool ParseBool(string value, bool defaultValue)
{
bool result;

if (bool.TryParse(value, out result))
return result;
var val = value.ToLower();
if (val == "true" || val == "1")
return true;
else if (val == "false" || value == "0")
return false;

return defaultValue;
}
Expand Down
4 changes: 4 additions & 0 deletions Assets/Vendors/XR Controller/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Model downloaded on Sketchfab
URL: https://sketchfab.com/models/c1944c64e06544babc90e9d0aa953551?utm_source=triggered-emails&utm_medium=email&utm_campaign=model-downloaded
Author: rje
License: Creative Common
7 changes: 7 additions & 0 deletions Assets/Vendors/XR Controller/LICENSE.txt.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

49 changes: 43 additions & 6 deletions README-VR.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,47 @@
# TESUnity VR

TESUnity supports the Oculus Rift, OSVR and the OpenVR API. The world of Morrowind is generated at runtime, so some optimizations can't be done, especially lights and culling optimizations. Because of that, the game can slow down when a new group of cells are loaded.
TESUnity supports the Oculus Rift and OpenVR devices (HTC Vive, Windows Mixed Reality, etc.).

## OSVR Users
The [OSVR Unity plugin](https://github.com/OSVR/OSVR-Unity) is not as optimized as other VR vendors. It is recommanded to switch to OpenVR (using SteamVR-OSVR) for best performance. However if you want to use the native OSVR integration, it is recommanded to turn off all effects and use the Unlit shader. We'll work with the OSVR Unity Team to find how to solve this problem.
The game requires a lot of CPU and GPU to work at a good framerate. The following presets will help you to configure the game with your own hardware.

If the [SteamVR-OSVR plugin](https://github.com/OSVR/SteamVR-OSVR) is enabled, it will load the OpenVR integration automatically, preventing you to start the game with the native OSVR integration. To solve that, you can
* Disable your SteamVR driver
* Start the game like that `TESUnity.exe -vrmode None`.

### Maximum Performances

| Parameter | Values |
|-----------|---------|
| SunShadows | `False` |
| LightShadows | `False` |
| RenderExteriorCellLights | `False` |
| DayNightCycle | `False` |
| GenerateNormalMap | `False` |
|**Effects** | |
|AntiAliasing | `0` |
| PostProcessQuality | 0 |
|WaterBackSideTransparent | `False` |
|**Rendering** | |
| Shader | `Unlit` |
| RenderPath | `Forward` |
| CameraFarClip | `250` |
| WaterQuality | `0` |

In the launcher start the game in `Fastest`.

### Mix between performances and quality
| Parameter | Values |
|-----------|---------|
| SunShadows | `true` |
| LightShadows | `False` |
| RenderExteriorCellLights | `true` |
| DayNightCycle | `true` |
| GenerateNormalMap | `true` |
|**Effects** | |
|AntiAliasing | `3` |
| PostProcessQuality | 2 |
|WaterBackSideTransparent | `False` |
|**Rendering** | |
| Shader | `Standard` |
| RenderPath | `Deferred` |
| CameraFarClip | `500` |
| WaterQuality | `0` |

In the launcher start the game in `Good` or `Beautiful`.
42 changes: 24 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,33 +25,39 @@ The first step is to rename the `config.ini.dist` file to `config.ini`.
| SunShadows | `True` or `False` |
| LightShadows | `True` or `False` |
| RenderExteriorCellLights | `True` or `False` |
| DayNightCycle | `True` or `False` |
| GenerateNormalMap | `True` or `False` |
| NormalGeneratorIntensity | A value from 0.1 to 1.0 |
|**Effects** | |
|AntiAliasing | `True` or `False` |
|AmbientOcclusion | `True` or `False` |
|Bloom | `True` or `False` |
|WaterBackSideTransparent | `True` or `False` |
| AntiAliasing | A value from 0 to 3 (0 is disabled) |
| PostProcessQuality | A value from 0 to 3 (0 is disabled) |
| WaterBackSideTransparent | `True` or `False` |
|**Rendering** | |
| Shader | `Unlit` or `Standard` or `Default` or `Bumped` |
| RenderPath | `1` = Forward, `3` = Deferred |
| RenderPath | `Forward` or `Deferred` |
| CameraFarClip | a value from 10 to 10000 |
| WaterQuality | a value from 0 to 2 |
|**VR** | |
| FollowHeadDirection | `True` or `False` |
| DirectModePreview | `True` or `False` |
| RoomScale | `True` or `False` |
| ForceControllers | `True` or `False` |
| XRVignette = | `True` or `False` |
|**Debug** | |
| CreaturesEnabled | `True` or `False` |

## Controls
| Action | Keys | Gamepad |
|--------|------|---------|
| Move | W, A, S, D* | Left thumbstick |
| Sprint | Left Shift | Left thumbstick button |
| Walk | Left Ctrl | Right thumstick button |
| Use / Open / Attack | Space | Button A |
| Cancel / Menu | Left click | Button B |
| Take (book mode) | Nothing | Button X |
| Jump | E | button Y |
| Toggle Flight Mode | Tab | Nothing |
| Toggle Lantern | L | Nothing |
| Free Cursor Lock | Backquote | Nothing |
| Action | Keys | Gamepad | VR |
|--------|------|---------|----|
| Move | W, A, S, D* | Left thumbstick | Left thumbstick |
| Sprint | Left Shift | Left thumbstick button | Left Grip |
| Walk | Left Ctrl | Right thumstick button | Right Grip |
| Use / Open / Attack | Space | Button A | Right Trigger |
| Cancel / Menu | Left click | Button B | Left Menu |
| Take (book mode) | Nothing | Button X | Left Trigger |
| Jump | E | button Y | Left thumbstick |
| Toggle Flight Mode | Tab | Nothing | Nohtin |
| Toggle Lantern | L | Nothing | Right thumbstick |
| Free Cursor Lock | Backquote | Nothing | Nothing |

\* *It uses the AZERTY mapping for French users.*

Expand Down
37 changes: 37 additions & 0 deletions config.ini.dist
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# TESUnity Configuration File

[Global]
PlayMusic = True
MorrowindDataPath = D:\Jeux\SteamLibrary\steamapps\common\Morrowind\Data Files

[Rendering]
RenderPath = Deferred
Shader = Standard
CameraFarClip = 500
# 0 = Normal / 1 = Reflective / 2 = Refractive
WaterQuality = 0

[Lighting]
AnimateLights = True
SunShadows = True
LightShadows = False
RenderExteriorCellLights = True
DayNightCycle = True
GenerateNormalMap = True
NormalGeneratorIntensity = 0.75

[Effects]
# 0 = Disabled / 1 = FXAA / 2 = SMAA (not supported in VR) / 3 = TAA
AntiAliasing = 3
# 0 = Disabled / 1 = Low / 2 = Medium / 3 = High
PostProcessQuality = 3
WaterBackSideTransparent = False

[VR]
FollowHeadDirection = True
RoomScale = False
ForceControllers = True
XRVignette = False

[Debug]
CreaturesEnabled = False

0 comments on commit 9a61616

Please sign in to comment.