aboutsummaryrefslogtreecommitdiff
path: root/libs/game_bethesda/src/games/enderal/gameenderal.cpp
blob: 959d5454251fe8afc6ab14c8049e0250c0568297 (plain)
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
#include "gameenderal.h"

#include "enderalbsainvalidation.h"
#include "enderaldataarchives.h"
#include "enderalgameplugins.h"
#include "enderallocalsavegames.h"
#include "enderalmoddatachecker.h"
#include "enderalmoddatacontent.h"
#include "enderalsavegame.h"
#include "enderalscriptextender.h"

#include "executableinfo.h"
#include "pluginsetting.h"
#include "steamutility.h"
#include "utility.h"

#include <gamebryogameplugins.h>
#include <gamebryosavegameinfo.h>
#include <gamebryounmanagedmods.h>

#include <QCoreApplication>
#include <QDebug>
#include <QFileInfo>

#include <QIcon>
#include <QtDebug>

#ifdef _WIN32
#include <Windows.h>
#include <winver.h>
#endif

#include <exception>
#include <memory>
#include <stdexcept>
#include <string>
#include <vector>

using namespace MOBase;

GameEnderal::GameEnderal() {}

bool GameEnderal::init(IOrganizer* moInfo)
{
  if (!GameGamebryo::init(moInfo)) {
    return false;
  }

  auto dataArchives = std::make_shared<EnderalDataArchives>(this);
  registerFeature(std::make_shared<EnderalScriptExtender>(this));
  registerFeature(dataArchives);
  registerFeature(std::make_shared<EnderalBSAInvalidation>(dataArchives.get(), this));
  registerFeature(std::make_shared<GamebryoSaveGameInfo>(this));
  registerFeature(std::make_shared<EnderalLocalSavegames>(this, "Enderal.ini"));
  registerFeature(std::make_shared<EnderalModDataChecker>(this));
  registerFeature(std::make_shared<EnderalModDataContent>(moInfo->gameFeatures()));
  registerFeature(std::make_shared<EnderalGamePlugins>(moInfo));
  registerFeature(std::make_shared<GamebryoUnmangedMods>(this));

  return true;
}

QString GameEnderal::gameName() const
{
  return "Enderal";
}

QList<ExecutableInfo> GameEnderal::executables() const
{
  return QList<ExecutableInfo>()
         //<< ExecutableInfo("SKSE",
         // findInGameFolder(feature<ScriptExtender>()->loaderName()))
         //<< ExecutableInfo("SBW", findInGameFolder("SBW.exe"))
         << ExecutableInfo("Enderal (SKSE)", findInGameFolder(binaryName()))
         << ExecutableInfo("Enderal Launcher", findInGameFolder(getLauncherName()))
         << ExecutableInfo("BOSS", findInGameFolder("BOSS/BOSS.exe"))
         << ExecutableInfo("LOOT", QFileInfo(getLootPath()))
                .withArgument("--game=\"Enderal\"")
         << ExecutableInfo("Creation Kit", findInGameFolder("CreationKit.exe"))
                .withSteamAppId("202480");
}

QList<ExecutableForcedLoadSetting> GameEnderal::executableForcedLoads() const
{
  return QList<ExecutableForcedLoadSetting>();
}

QString GameEnderal::name() const
{
  return "Enderal Support Plugin";
}

QString GameEnderal::localizedName() const
{
  return tr("Enderal Support Plugin");
}

QString GameEnderal::author() const
{
  return "AL12 & MO2 Team";
}

QString GameEnderal::description() const
{
  return tr("Adds support for the game Enderal");
}

MOBase::VersionInfo GameEnderal::version() const
{
  return VersionInfo(1, 3, 1, VersionInfo::RELEASE_FINAL);
}

QList<PluginSetting> GameEnderal::settings() const
{
  QList<PluginSetting> results;
  results.push_back(
      PluginSetting("sse_downloads", "allow Skyrim SE downloads", QVariant(false)));
  return results;
}

void GameEnderal::initializeProfile(const QDir& path, ProfileSettings settings) const
{
  if (settings.testFlag(IPluginGame::MODS)) {
    copyToProfile(localAppFolder() + "/enderal", path, "plugins.txt");
  }

  if (settings.testFlag(IPluginGame::CONFIGURATION)) {
    if (settings.testFlag(IPluginGame::PREFER_DEFAULTS) ||
        !QFileInfo(myGamesPath() + "/Enderal.ini").exists()) {

      // there is no default ini, actually they are going to put them in for us!
      copyToProfile(gameDirectory().absolutePath(), path, "Enderal_default.ini",
                    "Enderal.ini");
      copyToProfile(gameDirectory().absolutePath(), path, "EnderalPrefs_default.ini",
                    "EnderalPrefs.ini");
    } else {
      copyToProfile(myGamesPath(), path, "Enderal.ini");
      copyToProfile(myGamesPath(), path, "EnderalPrefs.ini");
    }
  }
}

bool GameEnderal::looksValid(QDir const& path) const
{
  // we need to check both launcher and binary because the binary also exists for
  // Skyrim and the launcher for Enderal SE
  return path.exists(getLauncherName()) && path.exists(binaryName());
}

QIcon GameEnderal::gameIcon() const
{
  return MOBase::iconForExecutable(gameDirectory().absoluteFilePath(getLauncherName()));
}

QString GameEnderal::savegameExtension() const
{
  return "ess";
}

QString GameEnderal::savegameSEExtension() const
{
  return "skse";
}

std::shared_ptr<const GamebryoSaveGame>
GameEnderal::makeSaveGame(QString filepath) const
{
  return std::make_shared<const EnderalSaveGame>(filepath, this);
}

QString GameEnderal::steamAPPId() const
{
  return "933480";
}

QStringList GameEnderal::primaryPlugins() const
{
  return {"Skyrim.esm", "Enderal - Forgotten Stories.esm", "Update.esm"};
}

QString GameEnderal::binaryName() const
{
  return "skse_loader.exe";
}

QString GameEnderal::getLauncherName() const
{
  return "Enderal Launcher.exe";
}

QString GameEnderal::gameShortName() const
{
  return "Enderal";
}

QString GameEnderal::localAppName() const
{
  // Enderal uses lowercase "enderal" in AppData/Local
  return "enderal";
}

QString GameEnderal::gameNexusName() const
{
  return "enderal";
}

QStringList GameEnderal::primarySources() const
{
  return {"Skyrim"};
}

QStringList GameEnderal::validShortNames() const
{
  QStringList results;
  results.push_back("Skyrim");
  if (m_Organizer->pluginSetting(name(), "sse_downloads").toBool()) {
    results.push_back("SkyrimSE");
  }
  return results;
}

QStringList GameEnderal::iniFiles() const
{
  return {"Enderal.ini", "EnderalPrefs.ini"};
}

QStringList GameEnderal::DLCPlugins() const
{
  return {};
}

IPluginGame::LoadOrderMechanism GameEnderal::loadOrderMechanism() const
{
  return LoadOrderMechanism::PluginsTxt;
}

int GameEnderal::nexusModOrganizerID() const
{
  return 0;
}

int GameEnderal::nexusGameID() const
{
  return 2736;
}

QString GameEnderal::identifyGamePath() const
{
#ifdef _WIN32
  QString path = "Software\\SureAI\\Enderal";
  QString result;
  try {
    result =
        findInRegistry(HKEY_CURRENT_USER, path.toStdWString().c_str(), L"Install_Path");
  } catch (MOBase::MyException) {
    result = MOBase::findSteamGame("Enderal", "Data\\Enderal - Forgotten Stories.esm");
  }
  return result;
#else
  // Prefer exact Steam app-id resolution for Enderal LE.
  QString result = parseSteamLocation(steamAPPId(), "Enderal");
  if (!result.isEmpty() && looksValid(QDir(result))) {
    return result;
  }

  result = MOBase::findSteamGame("Enderal", "Data/Enderal - Forgotten Stories.esm");
  if (!result.isEmpty() && looksValid(QDir(result))) {
    return result;
  }

  return GameGamebryo::identifyGamePath();
#endif
}