PrismLauncher/launcher/minecraft/MinecraftInstance.h

184 lines
6.4 KiB
C
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* Prism Launcher - Minecraft Launcher
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
* Copyright (C) 2022 TheKodeToad <TheKodeToad@proton.me>
*
* 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, version 3.
*
* 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 <https://www.gnu.org/licenses/>.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2013-2021 MultiMC Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
2015-01-27 21:31:07 +00:00
#pragma once
2015-02-09 00:51:14 +00:00
#include "BaseInstance.h"
#include <java/JavaVersion.h>
#include "minecraft/mod/Mod.h"
#include <QProcess>
#include <QDir>
#include "minecraft/launch/MinecraftServerTarget.h"
class ModFolderModel;
class ResourceFolderModel;
class ResourcePackFolderModel;
class ShaderPackFolderModel;
class TexturePackFolderModel;
class WorldList;
class GameOptions;
class LaunchStep;
class PackProfile;
2015-01-27 21:31:07 +00:00
class MinecraftInstance: public BaseInstance
2015-01-27 21:31:07 +00:00
{
2018-07-15 13:51:05 +01:00
Q_OBJECT
2015-01-27 21:31:07 +00:00
public:
2018-07-15 13:51:05 +01:00
MinecraftInstance(SettingsObjectPtr globalSettings, SettingsObjectPtr settings, const QString &rootDir);
virtual ~MinecraftInstance() {};
virtual void saveNow() override;
void loadSpecificSettings() override;
2018-07-15 13:51:05 +01:00
// FIXME: remove
QString typeName() const override;
// FIXME: remove
QSet<QString> traits() const override;
bool canEdit() const override
{
return true;
}
bool canExport() const override
{
return true;
}
////// Directories and files //////
QString jarModsDir() const;
QString resourcePacksDir() const;
QString texturePacksDir() const;
QString shaderPacksDir() const;
QString modsRoot() const override;
2018-07-15 13:51:05 +01:00
QString coreModsDir() const;
QString nilModsDir() const;
QString modsCacheLocation() const;
2018-07-15 13:51:05 +01:00
QString libDir() const;
QString worldDir() const;
QString resourcesDir() const;
2018-07-15 13:51:05 +01:00
QDir jarmodsPath() const;
QDir librariesPath() const;
QDir versionsPath() const;
QString instanceConfigFolder() const override;
// Path to the instance's minecraft directory.
QString gameRoot() const override;
// Path to the instance's minecraft bin directory.
QString binRoot() const;
// where to put the natives during/before launch
QString getNativePath() const;
// where the instance-local libraries should be
QString getLocalLibraryPath() const;
2018-07-15 13:51:05 +01:00
/** Returns whether the instance, with its version, has support for demo mode. */
[[nodiscard]] bool supportsDemo() const;
2018-07-15 13:51:05 +01:00
void updateRuntimeContext();
2018-07-15 13:51:05 +01:00
////// Profile management //////
std::shared_ptr<PackProfile> getPackProfile() const;
2018-07-15 13:51:05 +01:00
////// Mod Lists //////
std::shared_ptr<ModFolderModel> loaderModList();
std::shared_ptr<ModFolderModel> coreModList();
std::shared_ptr<ModFolderModel> nilModList();
std::shared_ptr<ResourcePackFolderModel> resourcePackList();
std::shared_ptr<TexturePackFolderModel> texturePackList();
std::shared_ptr<ShaderPackFolderModel> shaderPackList();
std::shared_ptr<WorldList> worldList();
std::shared_ptr<GameOptions> gameOptionsModel();
2018-07-15 13:51:05 +01:00
////// Launch stuff //////
2021-11-21 22:36:55 +00:00
Task::Ptr createUpdateTask(Net::Mode mode) override;
shared_qobject_ptr<LaunchTask> createLaunchTask(AuthSessionPtr account, MinecraftServerTargetPtr serverToJoin) override;
QStringList extraArguments() override;
QStringList verboseDescription(AuthSessionPtr session, MinecraftServerTargetPtr serverToJoin) override;
QList<Mod*> getJarMods() const;
QString createLaunchScript(AuthSessionPtr session, MinecraftServerTargetPtr serverToJoin);
2018-07-15 13:51:05 +01:00
/// get arguments passed to java
QStringList javaArguments();
QString getLauncher();
2018-07-15 13:51:05 +01:00
/// get variables for launch command variable substitution/environment
QMap<QString, QString> getVariables() override;
2018-07-15 13:51:05 +01:00
/// create an environment for launching processes
QProcessEnvironment createEnvironment() override;
QProcessEnvironment createLaunchEnvironment() override;
2015-07-22 08:01:04 +01:00
2018-07-15 13:51:05 +01:00
/// guess log level from a line of minecraft log
MessageLevel::Enum guessLevel(const QString &line, MessageLevel::Enum level) override;
2018-07-15 13:51:05 +01:00
IPathMatcher::Ptr getLogFileMatcher() override;
2018-07-15 13:51:05 +01:00
QString getLogFileRoot() override;
2018-07-15 13:51:05 +01:00
QString getStatusbarDescription() override;
2018-07-15 13:51:05 +01:00
// FIXME: remove
virtual QStringList getClassPath();
2018-07-15 13:51:05 +01:00
// FIXME: remove
virtual QStringList getNativeJars();
2018-07-15 13:51:05 +01:00
// FIXME: remove
virtual QString getMainClass() const;
2018-07-15 13:51:05 +01:00
// FIXME: remove
virtual QStringList processMinecraftArgs(AuthSessionPtr account, MinecraftServerTargetPtr serverToJoin) const;
virtual JavaVersion getJavaVersion();
protected:
2018-07-15 13:51:05 +01:00
QMap<QString, QString> createCensorFilterFromSession(AuthSessionPtr session);
QStringList validLaunchMethods();
QString launchMethod();
protected: // data
std::shared_ptr<PackProfile> m_components;
mutable std::shared_ptr<ModFolderModel> m_loader_mod_list;
mutable std::shared_ptr<ModFolderModel> m_core_mod_list;
mutable std::shared_ptr<ModFolderModel> m_nil_mod_list;
mutable std::shared_ptr<ResourcePackFolderModel> m_resource_pack_list;
mutable std::shared_ptr<ShaderPackFolderModel> m_shader_pack_list;
mutable std::shared_ptr<TexturePackFolderModel> m_texture_pack_list;
2018-07-15 13:51:05 +01:00
mutable std::shared_ptr<WorldList> m_world_list;
mutable std::shared_ptr<GameOptions> m_game_options;
2015-01-27 21:31:07 +00:00
};
typedef std::shared_ptr<MinecraftInstance> MinecraftInstancePtr;