Skip to content

Commit 578d190

Browse files
committed
clarity
1 parent 6ca57d0 commit 578d190

2 files changed

Lines changed: 159 additions & 123 deletions

File tree

docs/OOO/OBR/dependencies.html

Lines changed: 140 additions & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
<!DOCTYPE html>
22
<html lang="en">
3+
34
<head>
45
<meta charset="UTF-8">
56
<meta name="viewport" content="width=device-width, initial-scale=1.0">
67
<title>OOORF — Dependencies</title>
78
<link rel="stylesheet" href="../../css/devnull-shared.css">
89
</head>
10+
911
<body>
1012
<div class="container">
1113
<header>
@@ -15,126 +17,142 @@ <h1>Oscuro's Oblivion Overhaul Remastered FULL</h1>
1517
<nav><a href="index.html">Home</a> | <a href="overview.html">Overview</a> | <a href="changelog.html">Changelog</a> | <a href="install.html">Install</a> | <a href="dependencies.html" class="highlight-text">Dependencies</a> | <a href="https://github.com/devakm/OblivionRemastered_OOO/releases" target="_blank" rel="noopener">Downloads (GitHub Releases)</a></nav>
1618
<h1>Dependencies</h1>
1719

18-
<p>These are the runtime components a player needs to install themselves. <strong>None of them are bundled in the OOORF release archive</strong> — install them separately before deploying OOORF.</p>
19-
20-
<h2>Required</h2>
21-
22-
<h3>Oblivion Remastered</h3>
23-
24-
<p>The base game. Install via Steam, Game Pass, or your platform of choice.</p>
25-
26-
<table>
27-
<thead>
28-
<tr>
29-
<th>Detail</th>
30-
<th>Value</th>
31-
</tr>
32-
</thead>
33-
<tbody>
34-
<tr>
35-
<td>Engine</td>
36-
<td>Unreal Engine 5.3</td>
37-
</tr>
38-
<tr>
39-
<td>Default content path</td>
40-
<td><code>…\Oblivion Remastered\OblivionRemastered\Content\</code></td>
41-
</tr>
42-
<tr>
43-
<td>Default mod-pak path</td>
44-
<td><code>…\Oblivion Remastered\OblivionRemastered\Content\Paks\~mods\</code></td>
45-
</tr>
46-
<tr>
47-
<td>TES4 data path</td>
48-
<td><code>…\Oblivion Remastered\OblivionRemastered\Content\Dev\ObvData\Data\</code></td>
49-
</tr>
50-
</tbody>
51-
</table>
52-
53-
<h3>MagicLoader</h3>
54-
55-
<p>OOORF ships its plugin in <strong>two complementary forms</strong>: a single <code>Oscuro&#x27;s_Oblivion_Overhaul.esp</code> plus a per-record-type JSON family under <code>…\ObvData\Data\MagicLoader\</code>. <strong>MagicLoader</strong> reads those JSONs at game start and merges them into the live record set, sidestepping the 255-plugin load-order limit.</p>
56-
57-
<ul>
58-
<li>Required for everything record-related to work (creatures, items, spells, etc.) beyond what the bare ESP defines.</li>
59-
</ul>
60-
61-
<h3>TesSyncMapInjector (UE4SS Lua mod)</h3>
62-
63-
<p>OOORF&#x27;s <code>…\ObvData\Data\SyncMap\Oscuro&#x27;s_Oblivion_Overhaul.ini</code> is a list of <code>&lt;TES4 FormID hex&gt;=&lt;UE5 SoftObjectPath&gt;</code> lines. <strong>TesSyncMapInjector</strong> consumes this at load time and rebinds each FormID to its UE5 asset path — the bridge that lets ESP records point at UE5 meshes/blueprints.</p>
64-
65-
<ul>
66-
<li>Required for any item / object whose ESP record was authored to point at a non-default UE5 asset (e.g. the bundled Obsidian items).</li>
67-
</ul>
68-
69-
<h3>UE4SS</h3>
70-
71-
<p>The Unreal Engine 4 / 5 Scripting System. A loader for native DLL and Lua mods inside Unreal games.</p>
72-
73-
<ul>
74-
<li>Required by <strong>TesSyncMapInjector</strong> (Lua) and by the bundled <code>Begone</code>, <code>OOO_REFRFix</code>, <code>RAX</code> mods.</li>
75-
</ul>
76-
77-
<h2>Optional but supported</h2>
78-
79-
<p>The OptionalPatches/ subfolder ships ESPs that add compatibility with these mods if you also have them installed:</p>
80-
81-
<table>
82-
<thead>
83-
<tr>
84-
<th>Patch ESP</th>
85-
<th>Provides compatibility with</th>
86-
</tr>
87-
</thead>
88-
<tbody>
89-
<tr>
90-
<td><code>OOO_DeluxeEdition.esp</code></td>
91-
<td>Oblivion Remastered Deluxe Edition (extra cosmetic/content). Pair with <code>SyncMap - DeluxeEdition/</code> override.</td>
92-
</tr>
93-
<tr>
94-
<td><code>OOO_OOMC_Compatibility_Patch.esp</code></td>
95-
<td>OOMC (<a href="https://www.nexusmods.com/oblivionremastered/mods/4992" target="_blank" rel="noopener">Opulent Outfits: Mages of Cyrodiil</a>).</td>
96-
</tr>
97-
<tr>
98-
<td><code>OOO_UORP.esp</code></td>
99-
<td>The <a href="https://www.nexusmods.com/oblivionremastered/mods/477" target="_blank" rel="noopener">Unofficial Oblivion Remaster Patch</a>.</td>
100-
</tr>
101-
<tr>
102-
<td><code>OOO_UnlimitedRingsReduxPatch.esp</code></td>
103-
<td><a href="https://www.nexusmods.com/oblivionremastered/mods/2457" target="_blank" rel="noopener">Unlimited Rings Redux</a>.</td>
104-
</tr>
105-
</tbody>
106-
</table>
107-
108-
<h2>Bundled UE4SS mods (auto-installed)</h2>
109-
110-
<p>These ride along <em>inside</em> the OOORF archive — don&#x27;t install separately, but they DO require UE4SS to be installed first.</p>
111-
112-
<table>
113-
<thead>
114-
<tr>
115-
<th>Mod (under <code>…\Binaries\Win64\ue4ss\Mods\</code>)</th>
116-
<th>Role</th>
117-
</tr>
118-
</thead>
119-
<tbody>
120-
<tr>
121-
<td><code>Begone/</code></td>
122-
<td>Removes specific actor/object references at runtime per the bundled <code>Config/OscurosOblivionOverhaul.json</code>.</td>
123-
</tr>
124-
<tr>
125-
<td><code>OOO_REFRFix/</code></td>
126-
<td>Patches OOO reference placements that need runtime correction; see <code>Scripts/spawn_deltas.lua</code>. Only needed if you have existing saves carrying older-alpha OOO references.</td>
127-
</tr>
128-
<tr>
129-
<td><code>RAX/</code></td>
130-
<td>Allows loading of custom UE5 maps (the new <code>L_*_Map</code> dungeons). Native DLL (<code>dlls/main.dll</code>) plus Lua glue.</td>
131-
</tr>
132-
</tbody>
133-
</table>
134-
135-
<h2>Game install layout reference</h2>
136-
137-
<pre><code>…\Oblivion Remastered\
20+
<p>These are the runtime components a player needs to install themselves. <strong>None of them are bundled in the OOORF release archive</strong> — install them separately before deploying OOORF.</p>
21+
22+
<h2>Required</h2>
23+
24+
<h3>Oblivion Remastered</h3>
25+
26+
<p>The base game. Install via Steam, Game Pass, or your platform of choice.</p>
27+
28+
<table>
29+
<thead>
30+
<tr>
31+
<th>Detail</th>
32+
<th>Value</th>
33+
</tr>
34+
</thead>
35+
<tbody>
36+
<tr>
37+
<td>Engine</td>
38+
<td>Unreal Engine 5.3</td>
39+
</tr>
40+
<tr>
41+
<td>Default content path</td>
42+
<td><code>…\Oblivion Remastered\OblivionRemastered\Content\</code></td>
43+
</tr>
44+
<tr>
45+
<td>Default mod-pak path</td>
46+
<td><code>…\Oblivion Remastered\OblivionRemastered\Content\Paks\~mods\</code></td>
47+
</tr>
48+
<tr>
49+
<td>TES4 data path</td>
50+
<td><code>…\Oblivion Remastered\OblivionRemastered\Content\Dev\ObvData\Data\</code></td>
51+
</tr>
52+
</tbody>
53+
</table>
54+
55+
<h3>MagicLoader</h3>
56+
57+
<p>OOORF ships its plugin in <strong>two complementary forms</strong>: a single <code>Oscuro&#x27;s_Oblivion_Overhaul.esp</code> plus a per-record-type JSON family under <code>…\ObvData\Data\MagicLoader\</code>. <strong>MagicLoader</strong> reads those JSONs at game start and merges them into the live record set, sidestepping the 255-plugin load-order limit.</p>
58+
59+
<ul>
60+
<li>Required for everything record-related to work (creatures, items, spells, etc.) beyond what the bare ESP defines.</li>
61+
</ul>
62+
63+
<h3>TesSyncMapInjector (UE4SS Lua mod)</h3>
64+
65+
<p>OOORF&#x27;s <code>…\ObvData\Data\SyncMap\Oscuro&#x27;s_Oblivion_Overhaul.ini</code> is a list of <code>&lt;TES4 FormID hex&gt;=&lt;UE5 SoftObjectPath&gt;</code> lines. <strong>TesSyncMapInjector</strong> consumes this at load time and rebinds each FormID to its UE5 asset path — the bridge that lets ESP records point at UE5 meshes/blueprints.</p>
66+
67+
<ul>
68+
<li>Required for any item / object whose ESP record was authored to point at a non-default UE5 asset (e.g. the bundled Obsidian items).</li>
69+
</ul>
70+
71+
<h3>UE4SS</h3>
72+
73+
<p>The Unreal Engine 4 / 5 Scripting System. A loader for native DLL and Lua mods inside Unreal games.</p>
74+
75+
<ul>
76+
<li>Required by <strong>TesSyncMapInjector</strong> (Lua) and <strong>RAX</strong> — both essential for normal play (SyncMap binding and custom-map loading respectively).</li>
77+
<li>Also used by the optional bundled mods <code>Begone</code> (development test recording / debugging) and <code>OOO_REFRFix</code> (save migration for users with existing saves on older alpha releases) when those are enabled.</li>
78+
</ul>
79+
80+
<h2>Optional recommended compatibility patches</h2>
81+
82+
<p>The OptionalPatches/ subfolder ships ESPs that add compatibility with these mods if you also have them installed:</p>
83+
84+
<table>
85+
<thead>
86+
<tr>
87+
<th>Patch ESP</th>
88+
<th>Provides compatibility with</th>
89+
</tr>
90+
</thead>
91+
<tbody>
92+
<tr>
93+
<td><code>OOO_DeluxeEdition.esp</code></td>
94+
<td>Oblivion Remastered Deluxe Edition (extra cosmetic/content). Pair with <code>SyncMap - DeluxeEdition/</code> override.</td>
95+
</tr>
96+
<tr>
97+
<td><code>OOO_OOMC_Compatibility_Patch.esp</code></td>
98+
<td>OOMC (<a href="https://www.nexusmods.com/oblivionremastered/mods/4992" target="_blank" rel="noopener">Opulent Outfits: Mages of Cyrodiil</a>).</td>
99+
</tr>
100+
<tr>
101+
<td><code>OOO_UORP.esp</code></td>
102+
<td>The <a href="https://www.nexusmods.com/oblivionremastered/mods/477" target="_blank" rel="noopener">Unofficial Oblivion Remaster Patch</a>.</td>
103+
</tr>
104+
<tr>
105+
<td><code>OOO_UnlimitedRingsReduxPatch.esp</code></td>
106+
<td><a href="https://www.nexusmods.com/oblivionremastered/mods/2457" target="_blank" rel="noopener">Unlimited Rings Redux</a>.</td>
107+
</tr>
108+
</tbody>
109+
</table>
110+
111+
<h2>Bundled UE4SS mods — required for normal play</h2>
112+
113+
<p>This ships <em>inside</em> the OOORF archive — don&#x27;t install separately, but it DOES require UE4SS to be installed first.</p>
114+
115+
<table>
116+
<thead>
117+
<tr>
118+
<th>Mod (under <code>…\Binaries\Win64\ue4ss\Mods\</code>)</th>
119+
<th>Role</th>
120+
</tr>
121+
</thead>
122+
<tbody>
123+
<tr>
124+
<td><code>RAX/</code></td>
125+
<td>Allows loading of custom UE5 maps (the new <code>L_*_Map</code> dungeons). Native DLL (<code>dlls/main.dll</code>) plus Lua glue.</td>
126+
</tr>
127+
</tbody>
128+
</table>
129+
130+
<h2>Alpha-testing utilities (also bundled, optional)</h2>
131+
132+
<p>These run on UE4SS too and live in the same <code>…\Mods\</code> folder, but are <strong>not required for normal play</strong>. They exist to support the OOORF alpha-testing workflow. Safe to disable if you&#x27;re not testing or migrating an older save.</p>
133+
134+
<table>
135+
<thead>
136+
<tr>
137+
<th>Mod (under <code>…\Binaries\Win64\ue4ss\Mods\</code>)</th>
138+
<th>Role</th>
139+
</tr>
140+
</thead>
141+
<tbody>
142+
<tr>
143+
<td><code>Begone/</code></td>
144+
<td><strong>Test recording, debugging, and ad-hoc UE5-mesh suppression.</strong> Originally Begone hid UE5 ghost objects at runtime per <code>Config/OscurosOblivionOverhaul.json</code>; alpha90 baked that suppression into the map paks, so it is no longer required for normal play. Two ongoing uses: (1) capturing per-cell object inventories during alpha-test walkthroughs and verifying suppression coverage when new map paks are built; and (2) a runtime escape hatch — if a problem UE5 mesh slips through into a shipped pak, Begone can still suppress it via config rules until a pak rebuild lands.</td>
145+
</tr>
146+
<tr>
147+
<td><code>OOO_REFRFix/</code></td>
148+
<td>Save-file migration helper. Patches OOO reference placements that need runtime correction; see <code>Scripts/spawn_deltas.lua</code>. Only needed if you have existing saves carrying OOO references from older alpha releases.</td>
149+
</tr>
150+
</tbody>
151+
</table>
152+
153+
<h2>Game install layout reference</h2>
154+
155+
<pre><code>…\Oblivion Remastered\
138156
├── OblivionRemastered\
139157
│ ├── Binaries\Win64\
140158
│ │ └── ue4ss\ ← UE4SS install lives here; bundled Mods\ overlays into it
@@ -153,4 +171,5 @@ <h2>Game install layout reference</h2>
153171
</footer>
154172
</div>
155173
</body>
156-
</html>
174+
175+
</html>

docs/OOO/OBR/overview.html

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,8 @@ <h4 id="item-sets">Custom Glass-recolor item sets <em>(dedicated UE5 visuals new
217217

218218
<h3>UE4SS Lua mods (<code>OblivionRemastered/Binaries/Win64/ue4ss/Mods/</code>)</h3>
219219

220+
<h4>Required for normal play</h4>
221+
220222
<table>
221223
<thead>
222224
<tr>
@@ -229,13 +231,28 @@ <h3>UE4SS Lua mods (<code>OblivionRemastered/Binaries/Win64/ue4ss/Mods/</code>)<
229231
<td><code>RAX/</code></td>
230232
<td>Allows loading of new custom maps. Created by <a href="https://www.nexusmods.com/profile/Antrix/mods?gameId=7587" target="_blank" rel="noopener">Antrix</a> to allow OOO to load custom UE5 maps. Native DLL helper (<code>dlls/main.dll</code>) plus Lua glue. Required.</td>
231233
</tr>
234+
</tbody>
235+
</table>
236+
237+
<h4>Alpha-testing utilities (optional)</h4>
238+
239+
<p>Also bundled in the same folder, but <strong>not required for normal play</strong>. These exist to support the OOORF alpha-testing workflow — leave them enabled if you are testing or migrating an older save; disable them otherwise.</p>
240+
241+
<table>
242+
<thead>
243+
<tr>
244+
<th>Mod</th>
245+
<th>What it does</th>
246+
</tr>
247+
</thead>
248+
<tbody>
232249
<tr>
233250
<td><code>Begone/</code></td>
234-
<td>Removes specific actor/object references at runtime that are not needed or wanted in the UE5 maps; configured by <code>Config/OscurosOblivionOverhaul.json</code>. Required until we figure out how to delete them properly from the UE5 map clones.</td>
251+
<td><strong>Test recording, debugging, and ad-hoc UE5-mesh suppression.</strong> Originally Begone suppressed UE5 ghost objects (extra doors, fires, debris, dynamic FX) at runtime via per-cell rules in <code>Config/OscurosOblivionOverhaul.json</code>; as of alpha90 that suppression is baked into the map paks themselves, so Begone is no longer required for normal play. Two ongoing uses: (1) capturing per-cell object inventories during dungeon walkthroughs and verifying or extending suppression coverage when new map paks are being built; and (2) a runtime escape hatch — if a problem UE5 mesh slips through into a shipped pak, Begone can still suppress it via config rules until a pak rebuild lands.</td>
235252
</tr>
236253
<tr>
237254
<td><code>OOO_REFRFix/</code></td>
238-
<td>Fixes spawn / placement deltas for OOO references stored in your save file (<code>Scripts/spawn_deltas.lua</code>). Only required if you have existing saves with older alpha release OOO references. Not needed for new saves or if you never used prior alpha releases.</td>
255+
<td>Save-file migration helper. Fixes spawn / placement deltas for OOO references stored in your save file (<code>Scripts/spawn_deltas.lua</code>). Only required if you have existing saves with older alpha-release OOO references; not needed for new saves or if you never used prior alpha releases.</td>
239256
</tr>
240257
</tbody>
241258
</table>

0 commit comments

Comments
 (0)