-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
360 lines (331 loc) · 21.5 KB
/
Copy pathindex.html
File metadata and controls
360 lines (331 loc) · 21.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
<!DOCTYPE html>
<html data-bs-theme="dark">
<head>
<title>RE3 Randomizer for Archipelago</title>
<meta http-equiv="Permissions-Policy" content="interest-cohort=()">
<link href="vendor/css/bootstrap-5.3.0.min.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.5/font/bootstrap-icons.css">
<link href="css/main.css" rel="stylesheet">
<link href="css/responsive.css" rel="stylesheet">
<style>
@import url('https://fonts.googleapis.com/css2?family=Bebas+Neue&family=Prompt:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap');
</style>
<script src="vendor/js/bootstrap-5.3.1.bundle.min.js"></script>
</head>
<body>
<div id="app">
<nav class="navbar navbar-expand-lg">
<div class="container-fluid">
<a class="navbar-brand" href="#">
<span class="red">R</span>esident <span class="red">E</span>vil 3: <span class="yellow">AP Randomizer</span>
<span class="subtitle">Setup Guide</span>
</a>
</div>
</nav>
<ul class="nav justify-content-center">
<li class="nav-item">
<a class="nav-link active" id="link_clientmods" href="#clientmods">1. Game</a>
</li>
<li class="nav-item">
<a class="nav-link" id="link_yamloptions" href="#yamloptions">2. YAML Options</a>
</li>
<li class="nav-item">
<a class="nav-link" id="link_generation" href="#generation">3. Generate</a>
</li>
<li class="nav-item">
<a class="nav-link" id="link_hosting" href="#hosting">4. Host</a>
</li>
<li class="nav-item">
<a class="nav-link" id="link_connecting" href="#connecting">5. Connect</a>
</li>
<li class="nav-item">
<a class="nav-link" id="link_datapackage" href="#datapackage">Datapackage</a>
</li>
</ul>
<div id="container">
<div id="clientmods" class="page active">
<div class="panel panel-1">
<div class="step-number">1</div>
<h4>Install the game.</h4>
<ul>
<li>Any version should work. <br /> Just be sure to grab the proper REFramework <br />
for the build you have from Step 2.</li>
</ul>
</div>
<div class="panel panel-2">
<div class="step-number">2</div>
<div class="images">
<img src="images/clientmods/framework2.jpg" />
</div>
<h4>Install REFramework.</h4>
<ul>
<li>Non-RTX Users - <a href="https://github.com/praydog/REFramework/releases" target="_blank">most recent release here</a>.</li>
<li>RTX Users - <a href="https://github.com/praydog/REFramework-nightly/releases" target="_blank">nightly release here</a>.</li>
<li>Extract the contents of that zip into your RE3R game install's folder</li>
<li>Note: Do not extract the VR/XR dlls if you don't plan on using VR/XR</li>
</ul>
</div>
<div class="panel panel-3">
<div class="step-number">3</div>
<div class="images">
<img src="images/clientmods/client.jpg" />
</div>
<h4>Install the AP client mods.</h4>
<ul>
<li>Download the "source.zip" file from the <a href="https://github.com/TheRealSolidusSnake/RE3R_AP_Client/releases" target="_blank">most recent release here</a>.</li>
<li>Extract the contents of "source.zip" into your RE3R game install's folder.</li>
<li>(If it asks you to overwrite the "reframework" folder, choose Yes.)</li>
</ul>
</div>
<div class="panel panel-4">
<div class="step-number">4</div>
<div class="images">
<img src="images/clientmods/game_window.jpg" />
</div>
<h4>Verify that mods are installed.</h4>
<ul>
<li>Open your game normally and click through until you see the RE3R title screen.</li>
<li>If you see both a "REFramework" and a couple of "Archipelago" windows in-game, the install worked!</li>
</ul>
</div>
<div class="clear"><!-- x --></div>
<button class="btn btn-success next-step" data-step="#yamloptions">Next Step: YAML Options</button>
</div>
<div id="yamloptions" class="page">
<form id="form_yaml" onsubmit="return false;">
<div class="form-group">
<h4>Basic Options</h4>
<div>
<label for="player_name">Player Name:</label>
<input id="player_name" name="player_name" placeholder="Your AP player name" />
</div>
<div>
<label for="difficulty">Difficulty:</label>
<select id="difficulty" name="difficulty">
<option value="standard" selected>Standard</option>
</select>
</div>
<div class="form-check">
</div>
</div>
<div class="form-group">
<h4>Gameplay Options</h4>
<div class="form-check">
<input type="checkbox" name="allow_missable_locations" id="allow_missable_locations" /> <label class="checkbox-label" for="allow_missable_locations">Allow Missable Locations</label>
</div>
<div class="form-check">
<input type="checkbox" name="allow_progression_in_nest" id="allow_progression_in_nest" /> <label class="checkbox-label" for="allow_progression_in_nest">Allow Progression in NEST</label>
</div>
<div>
<label for="add_files_as_locations">Add Files as Locations:</label>
<select id="add_files_as_locations" name="add_files_as_locations">
<option value="none" selected>None</option>
<option value="all">All</option>
</select>
</div>
<div>
<label for="add_enemy_kills_as_locations">Add Enemy Kills as Locations:</label>
<select id="add_enemy_kills_as_locations" name="add_enemy_kills_as_locations">
<option value="none" selected>None</option>
<option value="all">All</option>
</select>
</div>
<div class="form-subgroup">
<div>
<label for="enemy_kill_items">Enemy Kill Items:</label>
<select id="enemy_kill_items" name="enemy_kill_items">
<option value="mixed">Mixed</option>
<option value="all_weapon_related">All Weapon Related</option>
<option value="ammo_related">Ammo Related</option>
<option value="ammo" selected>Ammo</option>
<option value="gunpowder">Gunpowder</option>
<option value="healing">Healing</option>
</select>
<div class="option-subtext">Used when enemy kills are enabled.</div>
</div>
</div>
</div>
<div class="form-group">
<h4>Helpful Options</h4>
<div>
<label for="starting_hip_pouches">Starting Hip Pouches:</label>
<select id="starting_hip_pouches" name="starting_hip_pouches">
<option value="pockets" selected>Pockets (0)</option>
<option value="fanny_pack">Fanny Pack (1)</option>
<option value="purse">Purse (2)</option>
<option value="backpack">Backpack (3)</option>
</select>
</div>
<div class="form-check">
<input type="checkbox" name="bonus_start" id="bonus_start" checked /> <label class="checkbox-label" for="bonus_start">Bonus Start</label> <span id="recommend_bonus_start">RECOMMENDED</span>
</div>
<div class="form-check">
<input type="checkbox" name="early_fire_hose" id="early_fire_hose" checked /> <label class="checkbox-label" for="early_fire_hose">Early Fire Hose</label> <span id="recommend_early_fire_hose">RECOMMENDED</span>
</div>
<div class="form-check">
<input type="checkbox" name="extra_sewer_items" id="extra_sewer_items" checked /> <label class="checkbox-label" for="extra_sewer_items">Extra Sewer Items</label> <span id="recommend_extra_sewer_items">RECOMMENDED</span>
</div>
</div>
<div class="form-group">
<h4>Weapon Options</h4>
<div class="form-check">
<input type="checkbox" name="local_weapons" id="local_weapons" checked /> <label class="checkbox-label" for="local_weapons">Local Weapons</label> <span id="recommend_local_weapons">RECOMMENDED</span>
</div>
<div class="form-check">
<input type="checkbox" name="double_weapons" id="double_weapons" /> <label class="checkbox-label" for="double_weapons">Double Weapons</label>
</div>
<div>
<label for="ammo_pack_modifier">Ammo Pack Modifier:</label>
<select id="ammo_pack_modifier" name="ammo_pack_modifier">
<option value="none" selected>None</option>
<option value="max">Max</option>
<option value="double">Double</option>
<option value="half">Half</option>
</select>
</div>
<div class="form-check">
<input type="checkbox" name="oops_all_grenades" id="oops_all_grenades" /> <label class="checkbox-label" for="oops_all_grenades">Oops! All Grenades</label>
</div>
<div class="form-check">
<input type="checkbox" name="oops_all_handguns" id="oops_all_handguns" /> <label class="checkbox-label" for="oops_all_handguns">Oops! All Handguns</label>
</div>
</div>
<div class="form-group notice">
<strong>NOTE:</strong>
<p>The options presented here are limited to options that are considered "safe" for community syncs and asyncs.</p>
<p class="small"><em>Additionally, recommended checkbox options are enabled by default on this screen.</em></p>
<p>For the full set of available options, you'll need to customize the template YAML provided with the apworld release.</p>
</div>
<div class="action-group">
<button class="btn btn-primary" onclick="exportYAML()">Generate YAML</button><br />
<button class="btn btn-success next-step" data-step="#generation">Next Step: Generate</button>
</div>
</form>
</div>
<div id="generation" class="page">
<div class="panel panel-1">
<div class="step-number">1</div>
<div class="images">
<img src="images/generation/ap_release.jpg" />
</div>
<h4>Install Archipelago.</h4>
<ul>
<li>Download and install Archipelago from the <a href="https://github.com/ArchipelagoMW/Archipelago/releases" target="_blank">most recent release here</a>.</li>
</ul>
</div>
<div class="panel panel-2">
<div class="step-number">2</div>
<div class="images">
<img src="images/generation/apworld.jpg" /><br />
<img src="images/generation/custom_world.jpg" />
</div>
<h4>Install the most recent APWorld.</h4>
<ul>
<li>Download the RE3R .apworld file from the<br /><a href="https://github.com/TheRealSolidusSnake/RE3R_AP_World/releases" target="_blank">most recent release here</a>.</li>
<li>Put that RE3R .apworld file in the<br />"custom_worlds" folder of your Archipelago<br />(AP) install.</li>
</ul>
</div>
<div class="panel panel-3">
<div class="step-number">3</div>
<div class="images">
<img src="images/generation/yaml.jpg" />
</div>
<h4>Place YAML in the Players folder.</h4>
<ul>
<li><em>If you haven't generated a YAML yet, go back to the "2. YAML Options" step.</em></li>
<li>Place the YAML (that you generated in the "2. YAML Options" step) in the "Players" folder of your Archipelago (AP) install.</li>
</ul>
</div>
<div class="panel panel-4">
<div class="step-number">4</div>
<div class="images">
<img src="images/generation/generate.jpg" />
</div>
<h4>Generate your multiworld.</h4>
<ul>
<li><em>If you are participating in a multiworld that someone else is generating, you can skip this step.</em></li>
<li>Double-click the "ArchipelagoGenerate.exe" in your Archipelago (AP) install to generate your multiworld.</li>
<li>If generation succeeded, the console window will close on its own.</li>
</ul>
</div>
<div class="clear"><!-- x --></div>
<button class="btn btn-success next-step" data-step="#hosting">Next Step: Host</button>
</div>
<div id="hosting" class="page">
<div class="panel panel-1">
<div class="images">
<img src="images/hosting/host.jpg" />
</div>
<h4>If playing solo, you can host locally.</h4>
<ul>
<li>Double-click the "ArchipelagoServer.exe" in your Archipelago (AP) install to host your solo multiworld.</li>
</ul>
</div>
<div class="panel panel-2">
<div class="images">
<img src="images/hosting/website.jpg" />
</div>
<h4>Otherwise, host on the website.</h4>
<ul>
<li>Go to <a href="https://archipelago.gg/uploads" target="_blank">https://archipelago.gg/uploads</a> and click the "Upload File" button.</li>
<li>Navigate to the "output" folder of your Archipelago (AP) install and choose the most recent AP_* zip file.</li>
<li>(Optionally, click the "Download" link on this page to get the spoiler log for this multiworld.)</li>
<li>Click the "Create New Room" link to start your multiworld room.</li>
</ul>
</div>
<div class="clear"><!-- x --></div>
<button class="btn btn-success next-step" data-step="#connecting">Next Step: Connect</button>
</div>
<div id="connecting" class="page">
<div class="panel panel-1">
<div class="step-number">1</div>
<div class="images">
<img src="images/connecting/client_window.jpg" />
</div>
<h4>Connect to the multiworld.</h4>
<ul>
<li><em>If you haven't installed the client mods for your game, go back to the "1. Game" step.</em></li>
<li>In the "Archipelago Client for REFramework" window in your game, enter the connection details for your multiworld.</li>
<li>"Host" will be the host that is shown in the console (hosting locally) or on the website (hosting there).</li>
<li>"Slot" will be the player name that you configured in the "2. YAML Options" step.</li>
<li>"Password" can be left empty, unless a password was configured for your generated multiworld. (This is usually not the case.)</li>
</ul>
</div>
<div class="panel panel-2">
<div class="step-number">2</div>
<div class="images">
<img src="images/connecting/complete.jpg" />
</div>
<h4>Start playing!</h4>
<ul>
<li>Once you connect, the "Archipelago Game Mod" window in your game will display the Character, Scenario, and Difficulty that was generated with.</li>
<li>Start the difficulty you selected in your yaml.</li>
<li>Enjoy!</li>
</ul>
</div>
<div class="clear"><!-- x --></div>
</div>
<div id="datapackage" class="page">
<div class="panel panel-items"></div>
<div class="panel panel-locations"></div>
</div>
</div>
</div>
<div class="modal in" id="viewImg" tabindex="-1" role="dialog">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title">Viewing Image</h4>
<button type="button" class="btn close" data-bs-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
</div>
<div class="modal-body">
<div id="imgViewer"></div>
</div>
</div>
</div>
</div>
<script src="vendor/js/filesaver-1.3.8.js"></script>
<script src="https://code.jquery.com/jquery-3.7.1.min.js" integrity="sha256-/JqT3SQfawRcv/BIHPThkBvs0OEvtFFmqPF/lYI/Cxo=" crossorigin="anonymous"></script>
<script src="js/main.js"></script>
</body>
</html>