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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#include "common/config-manager.h"
#include "common/debug-channels.h"
#include "common/events.h"
#include "common/keyboard.h"
#include "common/translation.h"
#include "common/system.h"
#include "gui/saveload.h"
#include "gui/message.h"
#include "mohawk/cursors.h"
#include "mohawk/installer_archive.h"
#include "mohawk/resource.h"
#include "mohawk/riven.h"
#include "mohawk/riven_card.h"
#include "mohawk/riven_graphics.h"
#include "mohawk/riven_inventory.h"
#include "mohawk/riven_saveload.h"
#include "mohawk/riven_sound.h"
#include "mohawk/riven_stack.h"
#include "mohawk/riven_stacks/aspit.h"
#include "mohawk/riven_stacks/bspit.h"
#include "mohawk/riven_stacks/gspit.h"
#include "mohawk/riven_stacks/jspit.h"
#include "mohawk/riven_stacks/ospit.h"
#include "mohawk/riven_stacks/pspit.h"
#include "mohawk/riven_stacks/rspit.h"
#include "mohawk/riven_stacks/tspit.h"
#include "mohawk/riven_video.h"
#include "mohawk/dialogs.h"
#include "mohawk/console.h"
namespace Mohawk {
MohawkEngine_Riven::MohawkEngine_Riven(OSystem *syst, const MohawkGameDescription *gamedesc) :
MohawkEngine(syst, gamedesc) {
_showHotspots = false;
_activatedPLST = false;
_activatedSLST = false;
_gameEnded = false;
_extrasFile = nullptr;
_stack = nullptr;
_gfx = nullptr;
_video = nullptr;
_sound = nullptr;
_rnd = nullptr;
_scriptMan = nullptr;
_console = nullptr;
_saveLoad = nullptr;
_optionsDialog = nullptr;
_card = nullptr;
_inventory = nullptr;
DebugMan.addDebugChannel(kRivenDebugScript, "Script", "Track Script Execution");
DebugMan.addDebugChannel(kRivenDebugPatches, "Patches", "Track Script Patching");
// NOTE: We can never really support CD swapping. All of the music files
// (*_Sounds.mhk) are stored on disc 1. They are copied to the hard drive
// during install and used from there. The same goes for the extras.mhk
// file. The following directories allow Riven to be played directly
// from the DVD.
const Common::FSNode gameDataDir(ConfMan.get("path"));
SearchMan.addSubDirectoryMatching(gameDataDir, "all");
SearchMan.addSubDirectoryMatching(gameDataDir, "data");
SearchMan.addSubDirectoryMatching(gameDataDir, "exe");
SearchMan.addSubDirectoryMatching(gameDataDir, "assets1");
SearchMan.addSubDirectoryMatching(gameDataDir, "program");
}
MohawkEngine_Riven::~MohawkEngine_Riven() {
delete _card;
delete _stack;
delete _sound;
delete _video;
delete _gfx;
delete _console;
delete _extrasFile;
delete _saveLoad;
delete _scriptMan;
delete _optionsDialog;
delete _inventory;
delete _rnd;
DebugMan.clearAllDebugChannels();
}
GUI::Debugger *MohawkEngine_Riven::getDebugger() {
return _console;
}
Common::Error MohawkEngine_Riven::run() {
MohawkEngine::run();
// Let's try to open the installer file (it holds extras.mhk)
// Though, we set a low priority to prefer the extracted version
if (_installerArchive.open("arcriven.z"))
SearchMan.add("arcriven.z", &_installerArchive, 0, false);
_gfx = new RivenGraphics(this);
_video = new RivenVideoManager(this);
_sound = new RivenSoundManager(this);
_console = new RivenConsole(this);
_saveLoad = new RivenSaveLoad(this, _saveFileMan);
_optionsDialog = new RivenOptionsDialog(this);
_scriptMan = new RivenScriptManager(this);
_inventory = new RivenInventory(this);
_rnd = new Common::RandomSource("riven");
// Create the cursor manager
if (Common::File::exists("rivendmo.exe"))
_cursor = new PECursorManager("rivendmo.exe");
else if (Common::File::exists("riven.exe"))
_cursor = new PECursorManager("riven.exe");
else // last resort: try the Mac executable
_cursor = new MacCursorManager("Riven");
initVars();
// Check the user has copied all the required datafiles
if (!checkDatafiles()) {
return Common::kNoGameDataFoundError;
}
// We need to have a cursor source, or the game won't work
if (!_cursor->hasSource()) {
Common::String message = _("You're missing a Riven executable. The Windows executable is 'riven.exe' or 'rivendmo.exe'. ");
message += _("Using the 'arcriven.z' installer file also works. In addition, you can use the Mac 'Riven' executable.");
GUIErrorMessage(message);
warning("%s", message.c_str());
return Common::kNoGameDataFoundError;
}
// Open extras.mhk for common images
_extrasFile = new MohawkArchive();
// We need extras.mhk for inventory images, marble images, and credits images
if (!_extrasFile->openFile("extras.mhk")) {
Common::String message = _("You're missing 'extras.mhk'. Using the 'arcriven.z' installer file also works.");
GUIErrorMessage(message);
warning("%s", message.c_str());
return Common::kNoGameDataFoundError;
}
// Set the transition speed
_gfx->setTransitionMode((RivenTransitionMode) _vars["transitionmode"]);
// Start at main cursor
_cursor->setCursor(kRivenMainCursor);
_cursor->showCursor();
// Let's begin, shall we?
if (getFeatures() & GF_DEMO) {
// Start the demo off with the videos
changeToStack(kStackAspit);
changeToCard(6);
} else if (ConfMan.hasKey("save_slot")) {
// Load game from launcher/command line if requested
int gameToLoad = ConfMan.getInt("save_slot");
// Attempt to load the game.
Common::Error loadError = _saveLoad->loadGame(gameToLoad);
if (loadError.getCode() != Common::kNoError) {
return loadError;
}
} else {
// Otherwise, start us off at aspit's card 1 (the main menu)
changeToStack(kStackAspit);
changeToCard(1);
}
while (!hasGameEnded())
doFrame();
return Common::kNoError;
}
void MohawkEngine_Riven::doFrame() {
// Update background running things
_sound->updateSLST();
_video->updateMovies();
Common::Event event;
while (_eventMan->pollEvent(event)) {
switch (event.type) {
case Common::EVENT_MOUSEMOVE:
_stack->onMouseMove(event.mouse);
break;
case Common::EVENT_LBUTTONDOWN:
_stack->onMouseDown(_eventMan->getMousePos());
break;
case Common::EVENT_LBUTTONUP:
_stack->onMouseUp(_eventMan->getMousePos());
_inventory->checkClick(_eventMan->getMousePos());
break;
case Common::EVENT_KEYUP:
_stack->keyResetAction();
break;
case Common::EVENT_KEYDOWN:
switch (event.kbd.keycode) {
case Common::KEYCODE_d:
if (event.kbd.flags & Common::KBD_CTRL) {
_console->attach();
_console->onFrame();
}
break;
case Common::KEYCODE_SPACE:
pauseGame();
break;
case Common::KEYCODE_F5:
runDialog(*_optionsDialog);
if (_optionsDialog->getLoadSlot() >= 0)
loadGameStateAndDisplayError(_optionsDialog->getLoadSlot());
_gfx->setTransitionMode((RivenTransitionMode) _vars["transitionmode"]);
_card->initializeZipMode();
break;
case Common::KEYCODE_r:
// Return to the main menu in the demo on ctrl+r
if (event.kbd.flags & Common::KBD_CTRL && getFeatures() & GF_DEMO) {
if (_stack->getId() != kStackAspit)
changeToStack(kStackAspit);
changeToCard(1);
}
break;
case Common::KEYCODE_p:
// Play the intro videos in the demo on ctrl+p
if (event.kbd.flags & Common::KBD_CTRL && getFeatures() & GF_DEMO) {
if (_stack->getId() != kStackAspit)
changeToStack(kStackAspit);
changeToCard(6);
}
break;
default:
_stack->onKeyPressed(event.kbd);
break;
}
break;
default:
break;
}
}
_stack->onFrame();
if (!_scriptMan->runningQueuedScripts()) {
// Don't run queued scripts if we are calling from a queued script
// otherwise infinite looping will happen.
_scriptMan->runQueuedScripts();
}
_inventory->onFrame();
// Update the screen once per frame
_system->updateScreen();
// Cut down on CPU usage
_system->delayMillis(10);
}
void MohawkEngine_Riven::pauseEngineIntern(bool pause) {
MohawkEngine::pauseEngineIntern(pause);
if (pause) {
_video->pauseVideos();
} else {
_video->resumeVideos();
}
}
// Stack/Card-Related Functions
void MohawkEngine_Riven::changeToStack(uint16 stackId) {
// Don't change stack to the current stack (if the files are loaded)
if (_stack && _stack->getId() == stackId && !_mhk.empty())
return;
// Free resources that may rely on the current stack data being loaded
if (_card) {
_card->leave();
delete _card;
_card = nullptr;
}
_video->removeVideos();
_sound->stopAllSLST();
// Clear the graphics cache; images aren't used across stack boundaries
_gfx->clearCache();
// Clear the old stack files out
for (uint32 i = 0; i < _mhk.size(); i++)
delete _mhk[i];
_mhk.clear();
// Get the prefix character for the destination stack
char prefix = RivenStacks::getName(stackId)[0];
// Load files that start with the prefix
const char **datafiles = listExpectedDatafiles();
for (int i = 0; datafiles[i] != nullptr; i++) {
if (datafiles[i][0] == prefix) {
MohawkArchive *mhk = new MohawkArchive();
if (mhk->openFile(datafiles[i]))
_mhk.push_back(mhk);
else
delete mhk;
}
}
// Make sure we have loaded files
if (_mhk.empty())
error("Could not load stack %s", RivenStacks::getName(stackId));
delete _stack;
_stack = constructStackById(stackId);
}
const char **MohawkEngine_Riven::listExpectedDatafiles() const {
// The files are in reverse order because of the way the 1.02 patch works.
// The only "Data3" file is j_Data3.mhk from that patch. Patch files have higher
// priorities over the regular files and are therefore loaded and checked first.
static const char *datafilesDVD[] = {
"a_Data.mhk", "a_Sounds.mhk",
"b_Data.mhk", "b_Sounds.mhk",
"g_Data.mhk", "g_Sounds.mhk",
"j_Data2.mhk", "j_Data1.mhk", "j_Sounds.mhk",
"o_Data.mhk", "o_Sounds.mhk",
"p_Data.mhk", "p_Sounds.mhk",
"r_Data.mhk", "r_Sounds.mhk",
"t_Data2.mhk", "t_Data1.mhk", "t_Sounds.mhk",
nullptr
};
static const char *datafilesCD[] = {
"a_Data.mhk", "a_Sounds.mhk",
"b_Data1.mhk", "b_Data.mhk", "b_Sounds.mhk",
"g_Data.mhk", "g_Sounds.mhk",
"j_Data3.mhk", "j_Data2.mhk", "j_Data1.mhk", "j_Sounds.mhk",
"o_Data.mhk", "o_Sounds.mhk",
"p_Data.mhk", "p_Sounds.mhk",
"r_Data.mhk", "r_Sounds.mhk",
"t_Data.mhk", "t_Sounds.mhk",
nullptr
};
static const char *datafilesDemo[] = {
"a_Data.mhk", "a_Sounds.mhk",
"j_Data.mhk", "j_Sounds.mhk",
"t_Data.mhk", "t_Sounds.mhk",
nullptr
};
const char **datafiles;
if (getFeatures() & GF_DEMO) {
datafiles = datafilesDemo;
} else if (getFeatures() & GF_DVD) {
datafiles = datafilesDVD;
} else {
datafiles = datafilesCD;
}
return datafiles;
}
bool MohawkEngine_Riven::checkDatafiles() {
Common::String missingFiles;
const char **datafiles = listExpectedDatafiles();
for (int i = 0; datafiles[i] != nullptr; i++) {
if (!SearchMan.hasFile(datafiles[i])) {
if (strcmp(datafiles[i], "j_Data3.mhk") == 0
|| strcmp(datafiles[i], "b_Data1.mhk") == 0) {
// j_Data3.mhk and b_Data1.mhk come from the 1.02 patch. They are not required to play.
continue;
}
if (!missingFiles.empty()) {
missingFiles += ", ";
}
missingFiles += datafiles[i];
}
}
if (missingFiles.empty()) {
return true;
}
Common::String message = _("You are missing the following required Riven data files:\n") + missingFiles;
warning("%s", message.c_str());
GUIErrorMessage(message);
return false;
}
RivenStack *MohawkEngine_Riven::constructStackById(uint16 id) {
switch (id) {
case kStackAspit:
return new RivenStacks::ASpit(this);
case kStackBspit:
return new RivenStacks::BSpit(this);
case kStackGspit:
return new RivenStacks::GSpit(this);
case kStackJspit:
return new RivenStacks::JSpit(this);
case kStackOspit:
return new RivenStacks::OSpit(this);
case kStackPspit:
return new RivenStacks::PSpit(this);
case kStackRspit:
return new RivenStacks::RSpit(this);
case kStackTspit:
return new RivenStacks::TSpit(this);
default:
error("Unknown stack id '%d'", id);
}
}
// Riven uses some hacks to change stacks for linking books
// Otherwise, script command 27 changes stacks
struct RivenSpecialChange {
byte startStack;
uint32 startCardRMAP;
byte targetStack;
uint32 targetCardRMAP;
};
static const RivenSpecialChange rivenSpecialChange[] = {
{ kStackAspit, 0x1f04, kStackOspit, 0x44ad }, // Trap Book
{ kStackBspit, 0x1c0e7, kStackOspit, 0x2e76 }, // Dome Linking Book
{ kStackGspit, 0x111b1, kStackOspit, 0x2e76 }, // Dome Linking Book
{ kStackJspit, 0x28a18, kStackRspit, 0xf94 }, // Tay Linking Book
{ kStackJspit, 0x26228, kStackOspit, 0x2e76 }, // Dome Linking Book
{ kStackOspit, 0x5f0d, kStackPspit, 0x3bf0 }, // Return from 233rd Age
{ kStackOspit, 0x470a, kStackJspit, 0x1508e }, // Return from 233rd Age
{ kStackOspit, 0x5c52, kStackGspit, 0x10bea }, // Return from 233rd Age
{ kStackOspit, 0x5d68, kStackBspit, 0x1adfd }, // Return from 233rd Age
{ kStackOspit, 0x5e49, kStackTspit, 0xe87 }, // Return from 233rd Age
{ kStackPspit, 0x4108, kStackOspit, 0x2e76 }, // Dome Linking Book
{ kStackRspit, 0x32d8, kStackJspit, 0x1c474 }, // Return from Tay
{ kStackTspit, 0x21b69, kStackOspit, 0x2e76 } // Dome Linking Book
};
void MohawkEngine_Riven::changeToCard(uint16 dest) {
debug (1, "Changing to card %d", dest);
// Clear the graphics cache (images typically aren't used
// on different cards).
_gfx->clearCache();
if (!(getFeatures() & GF_DEMO)) {
for (byte i = 0; i < ARRAYSIZE(rivenSpecialChange); i++)
if (_stack->getId() == rivenSpecialChange[i].startStack && dest == _stack->getCardStackId(
rivenSpecialChange[i].startCardRMAP)) {
changeToStack(rivenSpecialChange[i].targetStack);
dest = _stack->getCardStackId(rivenSpecialChange[i].targetCardRMAP);
}
}
// Clear any timer still floating around
_stack->removeTimer();
if (_card) {
_card->leave();
delete _card;
}
_card = new RivenCard(this, dest);
_card->enter(true);
// Now we need to redraw the cursor if necessary and handle mouse over scripts
_stack->queueMouseCursorRefresh();
// Finally, install any hardcoded timer
_stack->installCardTimer();
}
Common::SeekableReadStream *MohawkEngine_Riven::getExtrasResource(uint32 tag, uint16 id) {
return _extrasFile->getResource(tag, id);
}
void MohawkEngine_Riven::delay(uint32 ms) {
uint32 startTime = _system->getMillis();
while (_system->getMillis() < startTime + ms && !hasGameEnded()) {
doFrame();
}
}
void MohawkEngine_Riven::runLoadDialog() {
GUI::SaveLoadChooser slc(_("Load game:"), _("Load"), false);
int slot = slc.runModalWithCurrentTarget();
if (slot >= 0) {
loadGameStateAndDisplayError(slot);
}
}
Common::Error MohawkEngine_Riven::loadGameState(int slot) {
return _saveLoad->loadGame(slot);
}
void MohawkEngine_Riven::loadGameStateAndDisplayError(int slot) {
assert(slot >= 0);
Common::Error loadError = loadGameState(slot);
if (loadError.getCode() != Common::kNoError) {
GUI::MessageDialog dialog(loadError.getDesc());
dialog.runModal();
}
}
Common::Error MohawkEngine_Riven::saveGameState(int slot, const Common::String &desc) {
return _saveLoad->saveGame(slot, desc);
}
void MohawkEngine_Riven::addZipVisitedCard(uint16 cardId, uint16 cardNameId) {
Common::String cardName = getStack()->getName(kCardNames, cardNameId);
if (cardName.empty())
return;
ZipMode zip;
zip.name = cardName;
zip.id = cardId;
if (Common::find(_zipModeData.begin(), _zipModeData.end(), zip) == _zipModeData.end())
_zipModeData.push_back(zip);
}
bool MohawkEngine_Riven::isZipVisitedCard(const Common::String &hotspotName) const {
bool foundMatch = false;
if (!hotspotName.empty())
for (uint16 j = 0; j < _zipModeData.size(); j++)
if (_zipModeData[j].name == hotspotName) {
foundMatch = true;
break;
}
return foundMatch;
}
bool MohawkEngine_Riven::canLoadGameStateCurrently() {
if (getFeatures() & GF_DEMO) {
return false;
}
if (_scriptMan->hasQueuedScripts()) {
return false;
}
return true;
}
bool MohawkEngine_Riven::canSaveGameStateCurrently() {
return canLoadGameStateCurrently();
}
bool MohawkEngine_Riven::hasGameEnded() const {
return _gameEnded || shouldQuit();
}
void MohawkEngine_Riven::setGameEnded() {
_gameEnded = true;
}
bool ZipMode::operator== (const ZipMode &z) const {
return z.name == name && z.id == id;
}
} // End of namespace Mohawk
|