e01416ef32
I added skipping for the ADGF_WARNING and ADGF_UNSUPPORTED flags. For me, this is mostly about fixing bug no. 13282. We sometimes have bogus entries which only have the purpose of presenting the error message (reasons for being unsupported) contained in the extra field of the detection entry.
220 lines
8.8 KiB
C++
220 lines
8.8 KiB
C++
/* 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 3 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, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
#include "base/plugins.h"
|
|
|
|
#include "common/fs.h"
|
|
#include "common/gui_options.h"
|
|
|
|
#include "engines/metaengine.h"
|
|
|
|
/* Broken Sword */
|
|
static const PlainGameDescriptor sword1FullSettings =
|
|
{"sword1", "Broken Sword: The Shadow of the Templars"};
|
|
static const PlainGameDescriptor sword1DemoSettings =
|
|
{"sword1demo", "Broken Sword: The Shadow of the Templars (Demo)"};
|
|
static const PlainGameDescriptor sword1MacFullSettings =
|
|
{"sword1mac", "Broken Sword: The Shadow of the Templars (Mac)"};
|
|
static const PlainGameDescriptor sword1MacDemoSettings =
|
|
{"sword1macdemo", "Broken Sword: The Shadow of the Templars (Mac demo)"};
|
|
static const PlainGameDescriptor sword1PSXSettings =
|
|
{"sword1psx", "Broken Sword: The Shadow of the Templars (PlayStation)"};
|
|
static const PlainGameDescriptor sword1PSXDemoSettings =
|
|
{"sword1psxdemo", "Broken Sword: The Shadow of the Templars (PlayStation demo)"};
|
|
|
|
|
|
// check these subdirectories (if present)
|
|
static const char *const g_dirNames[] = { "clusters", "music", "speech", "english", "italian"};
|
|
|
|
#define NUM_COMMON_FILES_TO_CHECK 1
|
|
#define NUM_PC_FILES_TO_CHECK 3
|
|
#define NUM_MAC_FILES_TO_CHECK 4
|
|
#define NUM_DEMO_FILES_TO_CHECK 1
|
|
#define NUM_MAC_DEMO_FILES_TO_CHECK 1
|
|
#define NUM_PSX_FILES_TO_CHECK 1
|
|
#define NUM_PSX_DEMO_FILES_TO_CHECK 2
|
|
|
|
#define NUM_FILES_TO_CHECK NUM_COMMON_FILES_TO_CHECK + NUM_PC_FILES_TO_CHECK + NUM_MAC_FILES_TO_CHECK + NUM_PSX_FILES_TO_CHECK + NUM_DEMO_FILES_TO_CHECK + NUM_MAC_DEMO_FILES_TO_CHECK + NUM_PSX_DEMO_FILES_TO_CHECK
|
|
static const char *const g_filesToCheck[NUM_FILES_TO_CHECK] = { // these files have to be found
|
|
"swordres.rif", // Mac, PC and PSX version
|
|
"general.clu", // PC and PSX version
|
|
"compacts.clu", // PC and PSX version
|
|
"scripts.clu", // PC and PSX version
|
|
"general.clm", // Mac version only
|
|
"compacts.clm", // Mac version only
|
|
"scripts.clm", // Mac version only
|
|
"paris2.clm", // Mac version (full game only)
|
|
"1m14a.wav", // this one should only exist in the demo version
|
|
"scripts.clm", // Mac version both demo and full game
|
|
"train.plx", // PSX version only
|
|
"speech.dat", // PSX version only
|
|
"tunes.dat", // PSX version only
|
|
// the engine needs several more files to work, but checking these should be sufficient
|
|
};
|
|
|
|
class SwordMetaEngineDetection : public MetaEngineDetection {
|
|
public:
|
|
const char *getEngineId() const override {
|
|
return "sword1";
|
|
}
|
|
|
|
const char *getName() const override {
|
|
return "Broken Sword: The Shadow of the Templars";
|
|
}
|
|
const char *getOriginalCopyright() const override {
|
|
return "Broken Sword: The Shadow of the Templars (C) Revolution";
|
|
}
|
|
|
|
PlainGameList getSupportedGames() const override;
|
|
PlainGameDescriptor findGame(const char *gameId) const override;
|
|
DetectedGames detectGames(const Common::FSList &fslist, uint32 /*skipADFlags*/) override;
|
|
};
|
|
|
|
PlainGameList SwordMetaEngineDetection::getSupportedGames() const {
|
|
PlainGameList games;
|
|
games.push_back(sword1FullSettings);
|
|
games.push_back(sword1DemoSettings);
|
|
games.push_back(sword1MacFullSettings);
|
|
games.push_back(sword1MacDemoSettings);
|
|
games.push_back(sword1PSXSettings);
|
|
games.push_back(sword1PSXDemoSettings);
|
|
return games;
|
|
}
|
|
|
|
PlainGameDescriptor SwordMetaEngineDetection::findGame(const char *gameId) const {
|
|
if (0 == scumm_stricmp(gameId, sword1FullSettings.gameId))
|
|
return sword1FullSettings;
|
|
if (0 == scumm_stricmp(gameId, sword1DemoSettings.gameId))
|
|
return sword1DemoSettings;
|
|
if (0 == scumm_stricmp(gameId, sword1MacFullSettings.gameId))
|
|
return sword1MacFullSettings;
|
|
if (0 == scumm_stricmp(gameId, sword1MacDemoSettings.gameId))
|
|
return sword1MacDemoSettings;
|
|
if (0 == scumm_stricmp(gameId, sword1PSXSettings.gameId))
|
|
return sword1PSXSettings;
|
|
if (0 == scumm_stricmp(gameId, sword1PSXDemoSettings.gameId))
|
|
return sword1PSXDemoSettings;
|
|
return PlainGameDescriptor::empty();
|
|
}
|
|
|
|
void Sword1CheckDirectory(const Common::FSList &fslist, bool *filesFound) {
|
|
for (Common::FSList::const_iterator file = fslist.begin(); file != fslist.end(); ++file) {
|
|
if (!file->isDirectory()) {
|
|
for (int cnt = 0; cnt < NUM_FILES_TO_CHECK; cnt++)
|
|
if (scumm_stricmp(file->getName().c_str(), g_filesToCheck[cnt]) == 0)
|
|
filesFound[cnt] = true;
|
|
} else {
|
|
for (int cnt = 0; cnt < ARRAYSIZE(g_dirNames); cnt++)
|
|
if (scumm_stricmp(file->getName().c_str(), g_dirNames[cnt]) == 0) {
|
|
Common::FSList fslist2;
|
|
if (file->getChildren(fslist2, Common::FSNode::kListFilesOnly))
|
|
Sword1CheckDirectory(fslist2, filesFound);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
DetectedGames SwordMetaEngineDetection::detectGames(const Common::FSList &fslist, uint32 /*skipADFlags*/) {
|
|
int i, j;
|
|
DetectedGames detectedGames;
|
|
bool filesFound[NUM_FILES_TO_CHECK];
|
|
for (i = 0; i < NUM_FILES_TO_CHECK; i++)
|
|
filesFound[i] = false;
|
|
|
|
// The required game data files can be located in the game directory, or in
|
|
// a subdirectory called "clusters". In the latter case, we don't want to
|
|
// detect the game in that subdirectory, as this will detect the game twice
|
|
// when mass add is searching inside a directory. In this case, the first
|
|
// result (the game directory) will be correct, but the second result (the
|
|
// clusters subdirectory) will be wrong, as the optional speech, music and
|
|
// video data files will be ignored. Note that this fix will skip the game
|
|
// data files if the user has placed them inside a "clusters" subdirectory,
|
|
// or if he/she points ScummVM directly to the "clusters" directory of the
|
|
// game CD. Fixes bug #5274.
|
|
if (!fslist.empty()) {
|
|
Common::String directory = fslist[0].getParent().getName();
|
|
if (directory.hasPrefixIgnoreCase("clusters") && directory.size() <= 9)
|
|
return detectedGames;
|
|
}
|
|
|
|
Sword1CheckDirectory(fslist, filesFound);
|
|
bool mainFilesFound = true;
|
|
bool pcFilesFound = true;
|
|
bool macFilesFound = true;
|
|
bool demoFilesFound = true;
|
|
bool macDemoFilesFound = true;
|
|
bool psxFilesFound = true;
|
|
bool psxDemoFilesFound = true;
|
|
for (i = 0; i < NUM_COMMON_FILES_TO_CHECK; i++)
|
|
if (!filesFound[i])
|
|
mainFilesFound = false;
|
|
for (j = 0; j < NUM_PC_FILES_TO_CHECK; i++, j++)
|
|
if (!filesFound[i])
|
|
pcFilesFound = false;
|
|
for (j = 0; j < NUM_MAC_FILES_TO_CHECK; i++, j++)
|
|
if (!filesFound[i])
|
|
macFilesFound = false;
|
|
for (j = 0; j < NUM_DEMO_FILES_TO_CHECK; i++, j++)
|
|
if (!filesFound[i])
|
|
demoFilesFound = false;
|
|
for (j = 0; j < NUM_MAC_DEMO_FILES_TO_CHECK; i++, j++)
|
|
if (!filesFound[i])
|
|
macDemoFilesFound = false;
|
|
for (j = 0; j < NUM_PSX_FILES_TO_CHECK; i++, j++)
|
|
if (!filesFound[i])
|
|
psxFilesFound = false;
|
|
for (j = 0; j < NUM_PSX_DEMO_FILES_TO_CHECK; i++, j++)
|
|
if (!filesFound[i] || psxFilesFound)
|
|
psxDemoFilesFound = false;
|
|
|
|
DetectedGame game;
|
|
if (mainFilesFound && pcFilesFound && demoFilesFound)
|
|
game = DetectedGame(getEngineId(), sword1DemoSettings);
|
|
else if (mainFilesFound && pcFilesFound && psxFilesFound)
|
|
game = DetectedGame(getEngineId(), sword1PSXSettings);
|
|
else if (mainFilesFound && pcFilesFound && psxDemoFilesFound)
|
|
game = DetectedGame(getEngineId(), sword1PSXDemoSettings);
|
|
else if (mainFilesFound && pcFilesFound && !psxFilesFound)
|
|
game = DetectedGame(getEngineId(), sword1FullSettings);
|
|
else if (mainFilesFound && macFilesFound)
|
|
game = DetectedGame(getEngineId(), sword1MacFullSettings);
|
|
else if (mainFilesFound && macDemoFilesFound)
|
|
game = DetectedGame(getEngineId(), sword1MacDemoSettings);
|
|
else
|
|
return detectedGames;
|
|
|
|
game.setGUIOptions(GUIO2(GUIO_NOMIDI, GUIO_NOASPECT));
|
|
|
|
game.appendGUIOptions(getGameGUIOptionsDescriptionLanguage(Common::EN_ANY));
|
|
game.appendGUIOptions(getGameGUIOptionsDescriptionLanguage(Common::DE_DEU));
|
|
game.appendGUIOptions(getGameGUIOptionsDescriptionLanguage(Common::FR_FRA));
|
|
game.appendGUIOptions(getGameGUIOptionsDescriptionLanguage(Common::IT_ITA));
|
|
game.appendGUIOptions(getGameGUIOptionsDescriptionLanguage(Common::ES_ESP));
|
|
game.appendGUIOptions(getGameGUIOptionsDescriptionLanguage(Common::PT_BRA));
|
|
game.appendGUIOptions(getGameGUIOptionsDescriptionLanguage(Common::CS_CZE));
|
|
game.appendGUIOptions(getGameGUIOptionsDescriptionLanguage(Common::HE_ISR));
|
|
|
|
detectedGames.push_back(game);
|
|
|
|
return detectedGames;
|
|
}
|
|
|
|
REGISTER_PLUGIN_STATIC(SWORD1_DETECTION, PLUGIN_TYPE_ENGINE_DETECTION, SwordMetaEngineDetection);
|