-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathgetting-started.html
440 lines (419 loc) · 29.5 KB
/
getting-started.html
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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Unofficial Crusader Patch</title>
<link rel="icon" type="image/ico" href="assets/img/icon6.ico" />
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.5.0/css/all.css" integrity="sha384-B4dIYHKNBt8Bc12p+WXckhzcICo0wtJAoU8YZTY5qE0Id1GSseTk6S+L3BlXeVIU" crossorigin="anonymous">
</head>
<body>
<div class="container-fluid page">
<nav class="navbar navbar-expand-lg navbar-light bg-light">
<a class="navbar-brand" href="index.html"><img src="assets/img/icon6.ico" /></a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarSupportedContent">
<ul class="navbar-nav mr-auto">
<li class="nav-item active">
<a class="nav-link" href="index.html">Home</a>
</li>
<li class="nav-item">
<a class="nav-link" href="#">Getting Started <span class="sr-only">(current)</span></a>
</li>
<li class="nav-item">
<a class="nav-link" href="features.html">Features</a>
</li>
<li class="nav-item dropdown">
<a class="nav-link dropdown-toggle" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
AI Character Introduction
</a>
<div class="dropdown-menu" aria-labelledby="navbarDropdown">
<a class="dropdown-item" href="aic/overview.html">Overview</a>
<div class="dropdown-divider"></div>
<a class="dropdown-item" href="aic/detailed.html">AI Personality Values</a>
<a class="dropdown-item" href="aic/field-values.html">AIC Field Values</a>
</div>
</li>
<li class="nav-item">
<a class="nav-link" href="aiv.html">AI Castle Introduction</a>
</li>
<li class="nav-item">
<a class="nav-link" href="contributing.html">Contributing</a>
</li>
<li class="nav-item">
<a class="nav-link" href="faq.html">FAQ</a>
</li>
</ul>
</div>
</nav>
<div class="header">
<h4 class="text-center">Latest Version: UCP 3
<a href="https://github.com/UnofficialCrusaderPatch/UnofficialCrusaderPatch"><i class="fab fa-github"></i></a>
<a class="latest-release" href="https://github.com/UnofficialCrusaderPatch/UnofficialCrusaderPatch/releases">releases</a>
<a class="latest-release" href="https://github.com/UnofficialCrusaderPatch/UCP3-GUI/releases/download/v1.0.11/UCP3-GUI_1.0.11_x64-setup.exe">download</a>
<a href="https://discord.gg/P9dkF38Q2t"><img src="https://discordapp.com/api/guilds/426318193603117057/widget.png?style=shield"></a>
</h4>
</div>
<hr class="header-divider">
<div id="content" class="row">
<div class="col-lg-6 feature-highlights">
<h3>Installation</h3>
<div id="instructions">
<div class="card instruction">
<div class="card-header" id="instruction-one" data-toggle="collapse" data-target="#collapseOne" aria-expanded="true" aria-controls="collapseOne">
<h5 class="mb-0">
<button class="btn btn-link">
<i class="fas fa-download"></i> Download the Unofficial Crusader Patch (UCP)
</button>
</h5>
</div>
<div id="collapseOne" class="collapse" aria-labelledby="instruction-one" data-parent="#accordion-instructions">
<div class="card-body install-step">
<a href="https://github.com/UnofficialCrusaderPatch/UnofficialCrusaderPatch/releases/download/v2.15/UnofficialCrusaderPatch_2.15b.zip">Latest Stable Release</a>
<br>
<a href="https://github.com/Sh0wdown/UnofficialCrusaderPatch/tree/master"> View source on GitHub <i class="fab fa-github"></i></a>
</div>
</div>
</div>
<div class="card instruction">
<div class="card-header" id="instruction-two" data-toggle="collapse" data-target="#collapseTwo" aria-expanded="false" aria-controls="collapseTwo">
<h5 class="mb-0">
<button class="btn btn-link collapsed">
<i class="fas fa-copy"></i> Extract files from the UnofficialCrusaderPatch zip
</button>
</h5>
</div>
<div id="collapseTwo" class="collapse" aria-labelledby="instruction-two" data-parent="#accordion-instructions">
<div class="card-body install-step">
The UCP needs to know where your Stronghold Crusader (Extreme) installation directory is located.
It normally determines this based on the Path entry in the ucp.cfg file.
<br>
When installing using the GUI you may need to browse for and select the path to your Crusader installation.
<br>
When using the CLI tool (see Silent and Custom installation steps) the UnofficialCrusaderPatch looks for your Crusader installation:
first based on the ucp.cfg configuration file, then in the current directory, and finally one directory higher than the current directory.
<br>
If the location is under C:\Program Files you may need to complete the remaining instructions by running the UnofficialCrusaderPatch as administrator.
Common default installation paths are:
<ul>
<li>C:\Program Files (x86)\Firefly Studios\Stronghold Crusader</li>
<li>C:\Program Files (x86)\Steam\steamapps\common\Stronghold Crusader Extreme</li>
</ul>
</div>
</div>
</div>
<div class="card instruction">
<div class="card-header" id="instruction-three" data-toggle="collapse" data-target="#collapseThree" aria-expanded="false" aria-controls="collapseThree">
<h5 class="mb-0">
<button class="btn btn-link collapsed">
<i class="fas fa-copy"></i> (Optional) Copy ucp.cfg and extra content to UCP folder
</button>
</h5>
</div>
<div id="collapseThree" class="collapse" aria-labelledby="instruction-three" data-parent="#accordion-instructions">
<div class="card-body install-step">
If you plan to play multiplayer or wish to use someone else's configuration then sharing the ucp.cfg file is the best way to do this.
<br> For multiplayer, the UCP settings must be identical or else desync is almost certain to happen.
Additionally, certain features such as changing Player 1's color and Activate Spectator Mode will cause crash or desync in multiplayer.
<br><br>
The UnofficialCrusaderPatch allows you to use and install your own content including AIV, AIC, Starting Goods, and Starting Troops content.
After extracting your zip file containing the UnofficialCrusaderPatch, you will see a folder named 'Resources'.<br>
Inside this folder there are subfolders for:
<br>
<ul>
<li>aic<br>
<ul>
<li>Place your JSON aic files here, or your older .aic files for converting</li>
<li>If there is an issue loading your AIC file the UCP will display a message and the problems found
in the file will be written to a file named AICParsing.log
</li>
</ul>
</li>
<li>aiv<br>
<ul>
<li>Place you aiv files within a subfolder of this directory</li>
<li>When you open the UnofficialCrusaderPatch you will see the name of your folder in the AIV tab</li>
<li>To give your aiv collection a localized description create files named by language (ie. English.txt) and their
content will be shown in the interface.
</li>
</ul>
</li>
<li>goods<br>
<ul>
<li>Place your JSON starting goods files here</li>
<li>A "bootstrap" starting goods file is provided as an example within this folder.
</li>
</ul>
</li>
<li>troops<br>
<ul>
<li>Place your JSON starting troops files here</li>
<li>If there is an issue loading your AIC file the UCP will display a message and the problems found
in the file will be written to a file named StartTroopsParsing.log
</li>
</ul>
</li>
</ul>
<br>
Inside each subfolder you may add your own content of the appropriate type.
You may also export any of the built-in files - they will be exported to a new folder called "exports" within the appropriately named subfolder.
</div>
</div>
</div>
<div class="card instruction">
<div class="card-header" id="instruction-four" data-toggle="collapse" data-target="#collapseFour" aria-expanded="false" aria-controls="collapseFour">
<h5 class="mb-0">
<button class="btn btn-link collapsed">
<i class="fas fa-mouse-pointer"></i> Interactive installation steps
</button>
</h5>
</div>
<div id="collapseFour" class="collapse" aria-labelledby="instruction-four" data-parent="#accordion-instructions">
<div class="card-body install-step">
<ul>
<li>Double-click UnofficialCrusaderPatchGUI.exe and select your preferred language</li>
<li>Browse and locate path to Stronghold Crusader if not already shown on the interface</li>
<li>Click continue to choose your options <a href="features.html">(see overview of options)</a></li>
<li>When you are ready click install</li>
</ul>
</div>
</div>
</div>
<div class="card instruction">
<div class="card-header" id="instruction-five" data-toggle="collapse" data-target="#collapseFive" aria-expanded="false" aria-controls="collapseFive">
<h5 class="mb-0">
<button class="btn btn-link collapsed">
<i class="fas fa-arrow-circle-right"></i> Silent installation steps
</button>
</h5>
</div>
<div id="collapseFive" class="collapse" aria-labelledby="instruction-five" data-parent="#accordion-instructions">
<div class="card-body install-step">
<ul>
<li>Open extracted folder and double-click to run UnofficialCrusaderPatchCLI.exe</li>
</ul>
<i>You may need to run this as administrator if your install is located within a system-protected folder such as Program Files</i>
<br>
<i>A black (console) window will temporarily open while the UnofficialCrusaderPatch is installing. This is normal behavior.</i>
</div>
</div>
</div>
<div class="card instruction">
<div class="card-header" id="instruction-six" data-toggle="collapse" data-target="#collapseSix" aria-expanded="false" aria-controls="collapseSix">
<h5 class="mb-0">
<button class="btn btn-link collapsed">
<i class="fas fa-arrow-circle-right"></i> Advanced (custom) installation steps
</button>
</h5>
</div>
<div id="collapseSix" class="collapse" aria-labelledby="instruction-six" data-parent="#accordion-instructions">
<div class="card-body install-step">
The UnofficialCrusaderPatchCLI.exe executable accepts a number of command-line arguments that allow you to customize the installation.
<br> Command-line arguments are as follows:
<ul>
<li><code>--aiv[-overwrite]=<relative path to source aiv folder></code></li>
<li><code>--maps[-overwrite]=<relative path to source maps folder></code></li>
<li><code>--mapsExtreme[-overwrite]=<relative path to source mapsExtreme folder></code></li>
<li><code>--no-output</code></li>
</ul>
<i>Enclosure in square brackets indicate optional presence. Source folder refers to the folder where you have kept your aiv and/or maps files.</i>
<br> Default mode is copy. Behavior is described as follows. aiv files will be used as an example.
<br> Program Output:
<ul>
<li>When the CLI tool is passed an argument it will by default display where files, if any, are saved to. It will also display what files (ie. aic) are copied, and to where (see below for details). This feature can be disabled by running the CLI tool with the argument <code>--no-output</code></li>
</ul>
<br> With argument <code>--aiv=<aiv path></code> the following happens:
<ul>
<li>Files in "aiv" folder of installation are copied to folder bak-YYYY-MM-DDTHHMMSS</li>
<li>Files from <code><aiv path></code> folder are copied to aiv folder of installation</li>
<li>Installation proceeds. For aiv files, the copied files from can be used in the silent install if they are specified in the ucp.cfg</li>
</ul>
<br> With argument <code>--aiv-overwrite=<aiv path></code> the following happens:
<ul>
<li>Suppose file with filename 1.aiv exists in "aiv" folder of installation.. </li>
<li>File 1.aiv is deleted from installation folder</li>
<li>The new 1.aiv is copied from <code><aiv path></code> to "aiv" folder of installation</li>
<li>Installation proceeds. For aiv files, the copied files from can be used in the silent install if they are specified in the ucp.cfg</li>
</ul>
</div>
</div>
</div>
<div class="card instruction">
<div class="card-header" id="instruction-seven" data-toggle="collapse" data-target="#collapseSeven" aria-expanded="false" aria-controls="collapseSeven">
<h5 class="mb-0">
<button class="btn btn-link collapsed">
<i class="fas fa-mouse-pointer"></i> Uninstalling the UnofficialCrusaderPatch
</button>
</h5>
</div>
<div id="collapseSeven" class="collapse" aria-labelledby="instruction-seven" data-parent="#accordion-instructions">
<div class="card-body install-step">
<ul>
<li>Double-click UnofficialCrusaderPatchGUI.exe and then select your preferred language</li>
<li>Browse and locate path to Stronghold Crusader if not already shown on the interface</li>
<li>Click the uninstall button to uninstall the UnofficialCrusaderPatch</li>
<li><b>Note that for AIVs the most recently backed up version will be restored when uninstalling.
If you have installed multiple AIV sets previously you may need to manually go to the "aiv" folder
of your installation and restore the correct files</b>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="col-lg-6">
<h3>Visual Overview of Installation</h3>
<br>
<div id="carouselInstallation" class="carousel slide" data-ride="carousel">
<ol class="carousel-indicators">
<li data-target="#carouselInstallation" data-slide-to="0" class="active"></li>
<li data-target="#carouselInstallation" data-slide-to="1"></li>
<li data-target="#carouselInstallation" data-slide-to="2"></li>
</ol>
<div class="carousel-inner">
<div class="carousel-item active">
<div class="d-md-block text-center">
<h4>Step 1: Language Selection</h4>
</div>
<img class="d-block" style="height: 350px; margin: auto;" src="assets/img/language-select.png" alt="First slide">
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>Step 2: Installation Path Selection</h4>
</div>
<img class="d-block" style="height: 350px; margin: auto;" src="assets/img/window.png" alt="Second slide">
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>Step 3: Select Your <a href="features.html">Features</a></h4>
</div>
<img class="d-block" style="height: 350px; margin: auto;" src="assets/img/bugfixes.png" alt="Third slide">
</div>
</div>
<br><br>
<a class="carousel-control-prev" href="#carouselInstallation" role="button" data-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="carousel-control-next" href="#carouselInstallation" role="button" data-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>
<h3>Visual Overview of Features</h3>
<h5><i>See the <a href="features.html">Features</a> page for a full description of each feature</i></h5>
<br>
<div id="carouselFeatures" class="carousel slide" data-ride="carousel">
<div class="carousel-inner">
<div class="carousel-item active">
<div class="d-md-block text-center">
<h4>Bugfixes</h4>
</div>
<img class="d-block" style="height: 400px; margin: auto;" src="assets/img/bugfixes.png" alt="See Features page for description">
<div class="d-md-block text-center">
<h5><i>These include fixes to various gameplay bugs. Most users will want to select all options.</i></h5>
</div>
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>AIV</h4>
</div>
<img class="d-block" style="height: 400px; margin: auto;" src="assets/img/aiv.png" alt="See AI Castle Introduction page for description">
<div class="d-md-block text-center">
<h5><i>Selecting a castle set here will change the way the AI characters build their castles in-game.</i></h5>
<h5><i>See <a href="aiv/overview.html">AI Castle Introduction</a> for more about castle editing</i></h5>
</div>
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>AIC</h4>
</div>
<img class="d-block" style="height: 400px; margin: auto;" src="assets/img/aic.png" alt="See AI Character Introduction page for description">
<div class="d-md-block text-center">
<h5><i>Selecting a file here will change the in-game behavior of the AI.
The boxes that are colored beige indicate user-provided aic files.
<br>
vanilla is the AI behavior as it is defined in Stronghold Crusader (without UCP).
<br>
You may hold Ctrl and click to select/deselect multiple aic files.
Note that if an AI Character is defined multiple times they are used in order of selection</i></h5>
<h5><i>See <a href="aic/overview.html">AI Character Introduction</a> for more about editing AI behavior</i></h5>
</div>
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>AI Lords</h4>
</div>
<img class="d-block" style="height: 400px; margin: auto;" src="assets/img/ai-lords.png" alt="See Features page for description">
<div class="d-md-block text-center">
<h5><i>These include changes to how the AI characters behave.</i></h5>
<br>
</div>
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>Units</h4>
</div>
<img class="d-block" style="height: 400px; margin: auto;" src="assets/img/units.png" alt="See Features page for description">
<div class="d-md-block text-center">
<h5><i>These include changes to the characteristics of certain troops.</i></h5>
<br>
</div>
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>Other</h4>
</div>
<img class="d-block" style="height: 400px; margin: auto;" src="assets/img/other.png" alt="See Features page for description">
<div class="d-md-block text-center">
<h5><i>These include various quality of life and convenience changes.</i></h5>
<br>
</div>
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>StartTroops</h4>
</div>
<img class="d-block" style="height: 400px; margin: auto;" src="assets/img/starttroops.png" alt="">
<div class="d-md-block text-center">
<h5><i>Here you can select a starting unit configuration for AI Lords as well as your Crusader or Arabic Lord.
The vanilla configuration and a UCP patch configuration are provided for your convenience.</i></h5>
<br>
</div>
</div>
<div class="carousel-item">
<div class="d-md-block text-center">
<h4>StartGoods</h4>
</div>
<img class="d-block" style="height: 400px; margin: auto;" src="assets/img/startgoods.png" alt="">
<div class="d-md-block text-center">
<h5><i>Here you can select a starting resource configuration that will apply for all human and AI players in the game.
The vanilla configuration is provided for your convenience.
</i></h5>
<br>
</div>
</div>
</div>
<a class="carousel-control-prev" href="#carouselFeatures" role="button" data-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="carousel-control-next" href="#carouselFeatures" role="button" data-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>
</div>
</div>
</div>
</body>
<link rel="stylesheet" href="assets/css/index.css">
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
<script src="https://code.jquery.com/jquery-3.4.1.js" integrity="sha256-WpOohJOqMqqyKL9FccASB9O0KwACQJpFTUBLTYOVvVU=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
<script src="assets/js/carousel.js"></script>
</html>