summaryrefslogtreecommitdiff
path: root/meshmc/launcher/minecraft/mod/Mod.h
blob: 430ae9519dd8c811e39543a1f71e6f1cbe28ef16 (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
/* SPDX-FileCopyrightText: 2026 Project Tick
 * SPDX-FileContributor: Project Tick
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 *   MeshMC - A Custom Launcher for Minecraft
 *   Copyright (C) 2026 Project Tick
 *
 *   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 <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.
 */

#pragma once
#include <QFileInfo>
#include <QDateTime>
#include <QList>
#include <memory>

#include "ModDetails.h"

class Mod
{
  public:
	enum ModType {
		MOD_UNKNOWN, //!< Indicates an unspecified mod type.
		MOD_ZIPFILE, //!< The mod is a zip file containing the mod's class
					 //!< files.
		MOD_SINGLEFILE, //!< The mod is a single file (not a zip file).
		MOD_FOLDER,		//!< The mod is in a folder on the filesystem.
		MOD_LITEMOD,	//!< The mod is a litemod
	};

	Mod() = default;
	Mod(const QFileInfo& file);

	QFileInfo filename() const
	{
		return m_file;
	}
	QString mmc_id() const
	{
		return m_mmc_id;
	}
	ModType type() const
	{
		return m_type;
	}
	bool valid()
	{
		return m_type != MOD_UNKNOWN;
	}

	QDateTime dateTimeChanged() const
	{
		return m_changedDateTime;
	}

	bool enabled() const
	{
		return m_enabled;
	}

	const ModDetails& details() const;

	QString name() const;
	QString version() const;
	QString homeurl() const;
	QString description() const;
	QStringList authors() const;

	bool enable(bool value);

	// delete all the files of this mod
	bool destroy();

	// change the mod's filesystem path (used by mod lists for *MAGIC* purposes)
	void repath(const QFileInfo& file);

	bool shouldResolve()
	{
		return !m_resolving && !m_resolved;
	}
	bool isResolving()
	{
		return m_resolving;
	}
	int resolutionTicket()
	{
		return m_resolutionTicket;
	}
	void setResolving(bool resolving, int resolutionTicket)
	{
		m_resolving = resolving;
		m_resolutionTicket = resolutionTicket;
	}
	void finishResolvingWithDetails(std::shared_ptr<ModDetails> details)
	{
		m_resolving = false;
		m_resolved = true;
		m_localDetails = details;
	}

  protected:
	QFileInfo m_file;
	QDateTime m_changedDateTime;
	QString m_mmc_id;
	QString m_name;
	bool m_enabled = true;
	bool m_resolving = false;
	bool m_resolved = false;
	int m_resolutionTicket = 0;
	ModType m_type = MOD_UNKNOWN;
	std::shared_ptr<ModDetails> m_localDetails;
};