aboutsummaryrefslogtreecommitdiff
path: root/libmultimc
diff options
context:
space:
mode:
Diffstat (limited to 'libmultimc')
-rw-r--r--libmultimc/CMakeLists.txt96
-rw-r--r--libmultimc/include/appsettings.h32
-rw-r--r--libmultimc/include/gameupdatetask.h52
-rw-r--r--libmultimc/include/instance.h297
-rw-r--r--libmultimc/include/instancelist.h59
-rw-r--r--libmultimc/include/instanceloader.h140
-rw-r--r--libmultimc/include/instancetypeinterface.h86
-rw-r--r--libmultimc/include/instversion.h53
-rw-r--r--libmultimc/include/instversionlist.h45
-rw-r--r--libmultimc/include/libmmc_config.h27
-rw-r--r--libmultimc/include/loginresponse.h96
-rw-r--r--libmultimc/include/logintask.h50
-rw-r--r--libmultimc/include/minecraftprocess.h97
-rw-r--r--libmultimc/include/pluginmanager.h74
-rw-r--r--libmultimc/include/task.h56
-rw-r--r--libmultimc/include/userinfo.h41
-rw-r--r--libmultimc/include/version.h69
-rw-r--r--libmultimc/src/appsettings.cpp68
-rw-r--r--libmultimc/src/gameupdatetask.cpp22
-rw-r--r--libmultimc/src/instance.cpp131
-rw-r--r--libmultimc/src/instancelist.cpp87
-rw-r--r--libmultimc/src/instanceloader.cpp109
-rw-r--r--libmultimc/src/instversion.cpp32
-rw-r--r--libmultimc/src/instversionlist.cpp21
-rw-r--r--libmultimc/src/loginresponse.cpp69
-rw-r--r--libmultimc/src/logintask.cpp121
-rw-r--r--libmultimc/src/minecraftprocess.cpp248
-rw-r--r--libmultimc/src/pluginmanager.cpp105
-rw-r--r--libmultimc/src/task.cpp56
-rw-r--r--libmultimc/src/userinfo.cpp49
-rw-r--r--libmultimc/src/version.cpp46
31 files changed, 2534 insertions, 0 deletions
diff --git a/libmultimc/CMakeLists.txt b/libmultimc/CMakeLists.txt
new file mode 100644
index 00000000..06102d9f
--- /dev/null
+++ b/libmultimc/CMakeLists.txt
@@ -0,0 +1,96 @@
+project(libMultiMC)
+
+set(CMAKE_AUTOMOC ON)
+
+# Find Qt
+find_package(Qt5Core REQUIRED)
+find_package(Qt5Network REQUIRED)
+
+# Include Qt headers.
+include_directories(${Qt5Base_INCLUDE_DIRS})
+include_directories(${Qt5Network_INCLUDE_DIRS})
+
+# Include utility library.
+include_directories(${CMAKE_SOURCE_DIR}/libutil/include)
+
+# Include settings library.
+include_directories(${CMAKE_SOURCE_DIR}/libsettings/include)
+
+SET(LIBINST_HEADERS
+include/libmmc_config.h
+
+
+# Instance Stuff
+include/instance.h
+include/instancelist.h
+include/instanceloader.h
+
+include/instversion.h
+include/instversionlist.h
+
+
+# Plugin Stuff
+include/pluginmanager.h
+include/instancetypeinterface.h
+
+
+# Tasks
+include/task.h
+include/logintask.h
+include/gameupdatetask.h
+
+
+# Login Data
+include/userinfo.h
+include/loginresponse.h
+
+
+# Misc Data
+include/version.h
+include/appsettings.h
+include/minecraftprocess.h
+)
+
+SET(LIBINST_SOURCES
+# Instance Stuff
+src/instance.cpp
+src/instancelist.cpp
+src/instanceloader.cpp
+
+src/instversion.cpp
+src/instversionlist.cpp
+
+
+# Plugin Stuff
+src/pluginmanager.cpp
+
+
+# Tasks
+src/task.cpp
+src/logintask.cpp
+src/gameupdatetask.cpp
+
+
+# Login Data
+src/userinfo.cpp
+src/loginresponse.cpp
+
+
+# Misc Data
+src/version.cpp
+src/appsettings.cpp
+src/minecraftprocess.cpp
+)
+
+# Set the include dir path.
+SET(LIBMULTIMC_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/include" PARENT_SCOPE)
+
+# Include self.
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
+include_directories(${CMAKE_BINARY_DIR}/include)
+
+add_definitions(-DLIBMULTIMC_LIBRARY)
+
+add_library(libMultiMC SHARED ${LIBINST_SOURCES} ${LIBINST_HEADERS})
+qt5_use_modules(libMultiMC Core Network)
+target_link_libraries(libMultiMC libUtil libSettings)
diff --git a/libmultimc/include/appsettings.h b/libmultimc/include/appsettings.h
new file mode 100644
index 00000000..66ffb7b5
--- /dev/null
+++ b/libmultimc/include/appsettings.h
@@ -0,0 +1,32 @@
+/* Copyright 2013 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.
+ */
+
+#ifndef APPSETTINGS_H
+#define APPSETTINGS_H
+
+#include <QObject>
+
+#include <basicsettingsobject.h>
+
+#include "libmmc_config.h"
+
+class LIBMULTIMC_EXPORT AppSettings : public BasicSettingsObject
+{
+ Q_OBJECT
+public:
+ explicit AppSettings(QObject *parent = 0);
+};
+
+#endif // APPSETTINGS_H
diff --git a/libmultimc/include/gameupdatetask.h b/libmultimc/include/gameupdatetask.h
new file mode 100644
index 00000000..eabfbd1f
--- /dev/null
+++ b/libmultimc/include/gameupdatetask.h
@@ -0,0 +1,52 @@
+/* Copyright 2013 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.
+ */
+
+#ifndef GAMEUPDATETASK_H
+#define GAMEUPDATETASK_H
+
+#include <QObject>
+
+#include "loginresponse.h"
+
+#include "libmmc_config.h"
+
+/*!
+ * \brief The game update task is the task that handles downloading instances.
+ * Each instance type has its own class inheriting from this base game update task.
+ */
+class LIBMULTIMC_EXPORT GameUpdateTask : public QObject
+{
+ Q_OBJECT
+public:
+ explicit GameUpdateTask(const LoginResponse &response, QObject *parent = 0);
+
+signals:
+ /*!
+ * \brief Signal emitted when the game update is complete.
+ * \param response The login response received from login task.
+ */
+ void gameUpdateComplete(const LoginResponse &response);
+
+ /*!
+ * \brief Signal emitted if the game update fails.
+ * \param errorMsg An error message to be displayed to the user.
+ */
+ void gameUpdateFailed(const QString &errorMsg);
+
+private:
+ LoginResponse m_response;
+};
+
+#endif // GAMEUPDATETASK_H
diff --git a/libmultimc/include/instance.h b/libmultimc/include/instance.h
new file mode 100644
index 00000000..7de61343
--- /dev/null
+++ b/libmultimc/include/instance.h
@@ -0,0 +1,297 @@
+/* Copyright 2013 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.
+ */
+
+#ifndef INSTANCE_H
+#define INSTANCE_H
+
+#include <QObject>
+#include <QDateTime>
+
+#include <settingsobject.h>
+
+#include "inifile.h"
+
+#include "libmmc_config.h"
+
+class InstanceList;
+
+/*!
+ * \brief Base class for instances.
+ * This class implements many functions that are common between instances and
+ * provides a standard interface for all instances.
+ *
+ * To create a new instance type, create a new class inheriting from this class
+ * and implement the pure virtual functions.
+ */
+class LIBMULTIMC_EXPORT Instance : public QObject
+{
+ Q_OBJECT
+public:
+ explicit Instance(const QString &rootDir, QObject *parent = 0);
+
+ // Please, for the sake of my (and everyone else's) sanity, at least keep this shit
+ // *somewhat* organized. Also, documentation is semi-important here. Please don't
+ // leave undocumented stuff behind.
+
+
+ //////// STUFF ////////
+
+ /*!
+ * \brief Get the instance's ID.
+ * This is a unique identifier string that is, by default, set to the
+ * instance's folder name. It's not always the instance's folder name,
+ * however, as any class deriving from Instance can override the id()
+ * method and change how the ID is determined. The instance's ID
+ * should always remain constant. Undefined behavior results if an
+ * already loaded instance's ID changes.
+ *
+ * \return The instance's ID.
+ */
+ virtual QString id() const;
+
+ /*!
+ * \brief Gets the path to the instance's root directory.
+ * \return The path to the instance's root directory.
+ */
+ virtual QString rootDir() const;
+
+ /*!
+ * \brief Gets the instance list that this instance is a part of.
+ * Returns NULL if this instance is not in a list
+ * (the parent is not an InstanceList).
+ * \return A pointer to the InstanceList containing this instance.
+ */
+ virtual InstanceList *instList() const;
+
+
+ //////// INSTANCE INFO ////////
+
+ //// General Info ////
+
+ /*!
+ * \brief Gets this instance's name.
+ * This is the name that will be displayed to the user.
+ * \return The instance's name.
+ * \sa setName
+ */
+ virtual QString name() { return settings().get("name").toString(); }
+
+ /*!
+ * \brief Sets the instance's name
+ * \param val The instance's new name.
+ */
+ virtual void setName(QString val) { settings().set("name", val); }
+
+ /*!
+ * \brief Gets the instance's icon key.
+ * \return The instance's icon key.
+ * \sa setIconKey()
+ */
+ virtual QString iconKey() const { return settings().get("iconKey").toString(); }
+
+ /*!
+ * \brief Sets the instance's icon key.
+ * \param val The new icon key.
+ */
+ virtual void setIconKey(QString val) { settings().set("iconKey", val); }
+
+
+ /*!
+ * \brief Gets the instance's notes.
+ * \return The instances notes.
+ */
+ virtual QString notes() const { return settings().get("notes").toString(); }
+
+ /*!
+ * \brief Sets the instance's notes.
+ * \param val The instance's new notes.
+ */
+ virtual void setNotes(QString val) { settings().set("notes", val); }
+
+
+ /*!
+ * \brief Checks if the instance's minecraft.jar needs to be rebuilt.
+ * If this is true, the instance's mods will be reinstalled to its
+ * minecraft.jar file. This value is automatically set to true when
+ * the jar mod list changes.
+ * \return Whether or not the instance's jar file should be rebuilt.
+ */
+ virtual bool shouldRebuild() const { return settings().get("NeedsRebuild").toBool(); }
+
+ /*!
+ * \brief Sets whether or not the instance's minecraft.jar needs to be rebuilt.
+ * \param val Whether the instance's minecraft needs to be rebuilt or not.
+ */
+ virtual void setShouldRebuild(bool val) { settings().set("NeedsRebuild", val); }
+
+
+ //// Version Stuff ////
+
+ /*!
+ * \brief Sets the instance's current version.
+ * This value represents the instance's current version. If this value
+ * is different from intendedVersion(), the instance should be updated.
+ * This value is updated by the updateCurrentVersion() function.
+ * \return A string representing the instance's current version.
+ */
+ virtual QString currentVersion() { return settings().get("JarVersion").toString(); }
+
+ /*!
+ * \brief Sets the instance's current version.
+ * This is used to keep track of the instance's current version. Don't
+ * mess with this unless you know what you're doing.
+ * \param val The new value.
+ */
+ virtual void setCurrentVersion(QString val) { settings().set("JarVersion", val); }
+
+
+ /*!
+ * \brief Gets the version of LWJGL that this instance should use.
+ * If no LWJGL version is specified in the instance's config file,
+ * defaults to "Mojang"
+ * \return The instance's LWJGL version.
+ */
+ virtual QString lwjglVersion() { return settings().get("LwjglVersion").toString(); }
+
+ /*!
+ * \brief Sets the version of LWJGL that this instance should use.
+ * \param val The LWJGL version to use
+ */
+ virtual void setLWJGLVersion(QString val) { settings().set("LwjglVersion", val); }
+
+
+ /*!
+ * \brief Gets the version that this instance should try to update to.
+ * If this value differs from currentVersion(), the instance will
+ * download the intended version when it launches.
+ * \return The instance's intended version.
+ */
+ virtual QString intendedVersion() { return settings().get("IntendedJarVersion").toString(); }
+
+ /*!
+ * \brief Sets the version that this instance should try to update to.
+ * \param val The instance's new intended version.
+ */
+ virtual void setIntendedVersion(QString val) { settings().set("IntendedJarVersion", val); }
+
+
+
+ //// Timestamps ////
+
+ /*!
+ * \brief Gets the time that the instance was last launched.
+ * Measured in milliseconds since epoch. QDateTime::currentMSecsSinceEpoch()
+ * \return The time that the instance was last launched.
+ */
+ virtual qint64 lastLaunch() { return settings().get("lastLaunchTime").value<qint64>(); }
+
+ /*!
+ * \brief Sets the time that the instance was last launched.
+ * \param val The time to set. Defaults to QDateTime::currentMSecsSinceEpoch()
+ */
+ virtual void setLastLaunch(qint64 val = QDateTime::currentMSecsSinceEpoch())
+ { settings().set("lastLaunchTime", val); }
+
+
+ ////// Directories //////
+ //! Gets the path to the instance's minecraft folder.
+ QString minecraftDir() const;
+
+ /*!
+ * \brief Gets the path to the instance's instance mods folder.
+ * This is the folder where the jar mods are kept.
+ */
+ QString instModsDir() const;
+
+ //! Gets the path to the instance's bin folder.
+ QString binDir() const;
+
+ //! Gets the path to the instance's saves folder.
+ QString savesDir() const;
+
+ //! Gets the path to the instance's mods folder. (.minecraft/mods)
+ QString mlModsDir() const;
+
+ //! Gets the path to the instance's coremods folder.
+ QString coreModsDir() const;
+
+ //! Gets the path to the instance's resources folder.
+ QString resourceDir() const;
+
+ //! Gets the path to the instance's screenshots folder.
+ QString screenshotsDir() const;
+
+ //! Gets the path to the instance's texture packs folder.
+ QString texturePacksDir() const;
+
+
+ ////// Files //////
+ //! Gets the path to the instance's minecraft.jar
+ QString mcJar() const;
+
+ //! Gets the path to the instance's mcbackup.jar.
+ QString mcBackup() const;
+
+ //! Gets the path to the instance's config file.
+ QString configFile() const;
+
+ //! Gets the path to the instance's modlist file.
+ QString modListFile() const;
+
+
+ //////// OTHER FUNCTIONS ////////
+
+ //// Version System ////
+
+ /*!
+ * \brief Checks whether or not the currentVersion of the instance needs to be updated.
+ * If this returns true, updateCurrentVersion is called. In the
+ * standard instance, this is determined by checking a timestamp
+ * stored in the instance config file against the last modified time of Minecraft.jar.
+ * \return True if updateCurrentVersion() should be called.
+ */
+ virtual bool shouldUpdateCurrentVersion() = 0;
+
+ /*!
+ * \brief Updates the current version.
+ * This function should first set the current version timestamp
+ * (setCurrentVersionTimestamp()) to the current time. Next, if
+ * keepCurrent is false, this function should check what the
+ * instance's current version is and call setCurrentVersion() to
+ * update it. This function will automatically be called when the
+ * instance is loaded if shouldUpdateCurrentVersion returns true.
+ * \param keepCurrent If true, only the version timestamp will be updated.
+ */
+ virtual void updateCurrentVersion(bool keepCurrent = false) = 0;
+
+
+ //// Settings System ////
+
+ /*!
+ * \brief Gets this instance's settings object.
+ * This settings object stores instance-specific settings.
+ * \return A pointer to this instance's settings object.
+ */
+ virtual SettingsObject &settings() const;
+
+private:
+ QString m_rootDir;
+ SettingsObject *m_settings;
+};
+
+// pointer for lazy people
+typedef QSharedPointer<Instance> InstancePtr;
+
+#endif // INSTANCE_H
diff --git a/libmultimc/include/instancelist.h b/libmultimc/include/instancelist.h
new file mode 100644
index 00000000..d4e7556a
--- /dev/null
+++ b/libmultimc/include/instancelist.h
@@ -0,0 +1,59 @@
+/* Copyright 2013 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.
+ */
+
+#ifndef INSTANCELIST_H
+#define INSTANCELIST_H
+
+#include <QObject>
+
+#include <QSharedPointer>
+
+#include "siglist.h"
+
+#include "libmmc_config.h"
+
+class Instance;
+
+class LIBMULTIMC_EXPORT InstanceList : public QObject, public SigList< QSharedPointer<Instance> >
+{
+ Q_OBJECT
+public:
+ explicit InstanceList(const QString &instDir, QObject *parent = 0);
+
+ /*!
+ * \brief Error codes returned by functions in the InstanceList class.
+ * NoError Indicates that no error occurred.
+ * UnknownError indicates that an unspecified error occurred.
+ */
+ enum InstListError
+ {
+ NoError = 0,
+ UnknownError
+ };
+
+ QString instDir() const { return m_instDir; }
+
+ /*!
+ * \brief Loads the instance list.
+ */
+ InstListError loadList();
+
+ DEFINE_SIGLIST_SIGNALS(QSharedPointer<Instance>);
+ SETUP_SIGLIST_SIGNALS(QSharedPointer<Instance>);
+protected:
+ QString m_instDir;
+};
+
+#endif // INSTANCELIST_H
diff --git a/libmultimc/include/instanceloader.h b/libmultimc/include/instanceloader.h
new file mode 100644
index 00000000..3326d7d0
--- /dev/null
+++ b/libmultimc/include/instanceloader.h
@@ -0,0 +1,140 @@
+/* Copyright 2013 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.
+ */
+
+#ifndef INSTANCELOADER_H
+#define INSTANCELOADER_H
+
+#include <QObject>
+#include <QMap>
+#include <QList>
+
+#include "libmmc_config.h"
+
+class InstanceTypeInterface;
+class Instance;
+
+typedef QList<const InstanceTypeInterface *> InstTypeList;
+
+/*!
+ * \brief The InstanceLoader is a singleton that manages all of the instance types and handles loading and creating instances.
+ * Instance types are registered with the instance loader through its registerInstType() function.
+ * Creating instances is done through the InstanceLoader's createInstance() function. This function takes
+ */
+class LIBMULTIMC_EXPORT InstanceLoader : public QObject
+{
+ Q_OBJECT
+public:
+ /*!
+ * \brief Gets a reference to the instance loader.
+ */
+ static InstanceLoader &get() { return loader; }
+
+ /*!
+ * \brief Error codes returned by functions in the InstanceLoader and InstanceType classes.
+ *
+ * - NoError indicates that no error occurred.
+ * - OtherError indicates that an unspecified error occurred.
+ * - TypeIDExists is returned by registerInstanceType() if the ID of the type being registered already exists.
+ * - TypeNotRegistered is returned by createInstance() and loadInstance() when the given type is not registered.
+ * - InstExists is returned by createInstance() if the given instance directory is already an instance.
+ * - NotAnInstance is returned by loadInstance() if the given instance directory is not a valid instance.
+ * - WrongInstType is returned by loadInstance() if the given instance directory's type doesn't match the given type.
+ * - CantCreateDir is returned by createInstance( if the given instance directory can't be created.)
+ */
+ enum InstTypeError
+ {
+ NoError = 0,
+ OtherError,
+
+ TypeIDExists,
+
+ TypeNotRegistered,
+ InstExists,
+ NotAnInstance,
+ WrongInstType,
+ CantCreateDir
+ };
+
+ /*!
+ * \brief Registers the given InstanceType with the instance loader.
+ *
+ * \param type The InstanceType to register.
+ * \return An InstTypeError error code.
+ * - TypeIDExists if the given type's is already registered to another instance type.
+ */
+ InstTypeError registerInstanceType(InstanceTypeInterface *type);
+
+ /*!
+ * \brief Creates an instance with the given type and stores it in inst.
+ *
+ * \param inst Pointer to store the created instance in.
+ * \param type The type of instance to create.
+ * \param instDir The instance's directory.
+ * \return An InstTypeError error code.
+ * - TypeNotRegistered if the given type is not registered with the InstanceLoader.
+ * - InstExists if the given instance directory is already an instance.
+ * - CantCreateDir if the given instance directory cannot be created.
+ */
+ InstTypeError createInstance(Instance *&inst, const InstanceTypeInterface *type, const QString &instDir);
+
+ /*!
+ * \brief Loads an instance from the given directory.
+ *
+ * \param inst Pointer to store the loaded instance in.
+ * \param type The type of instance to load.
+ * \param instDir The instance's directory.
+ * \return An InstTypeError error code.
+ * - TypeNotRegistered if the given type is not registered with the InstanceLoader.
+ * - NotAnInstance if the given instance directory isn't a valid instance.
+ * - WrongInstType if the given instance directory's type isn't the same as the given type.
+ */
+ InstTypeError loadInstance(Instance *&inst, const InstanceTypeInterface *type, const QString &instDir);
+
+ /*!
+ * \brief Loads an instance from the given directory.
+ * Checks the instance's INI file to figure out what the instance's type is first.
+ * \param inst Pointer to store the loaded instance in.
+ * \param instDir The instance's directory.
+ * \return An InstTypeError error code.
+ * - TypeNotRegistered if the instance's type is not registered with the InstanceLoader.
+ * - NotAnInstance if the given instance directory isn't a valid instance.
+ */
+ InstTypeError loadInstance(Instance *&inst, const QString &instDir);
+
+ /*!
+ * \brief Finds an instance type with the given ID.
+ * If one cannot be found, returns NULL.
+ *
+ * \param id The ID of the type to find.
+ * \return The type with the given ID. NULL if none were found.
+ */
+ const InstanceTypeInterface *findType(const QString &id);
+
+ /*!
+ * \brief Gets a list of the registered instance types.
+ *
+ * \return A list of instance types.
+ */
+ InstTypeList typeList();
+
+private:
+ InstanceLoader();
+
+ QMap<QString, InstanceTypeInterface *> m_typeMap;
+
+ static InstanceLoader loader;
+};
+
+#endif // INSTANCELOADER_H
diff --git a/libmultimc/include/instancetypeinterface.h b/libmultimc/include/instancetypeinterface.h
new file mode 100644
index 00000000..30a12d99
--- /dev/null
+++ b/libmultimc/include/instancetypeinterface.h
@@ -0,0 +1,86 @@
+/* Copyright 2013 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.
+ */
+
+#ifndef INSTANCETYPE_H
+#define INSTANCETYPE_H
+
+#include <QObject>
+
+#include "instanceloader.h"
+
+//! The InstanceTypeInterface's interface ID.
+#define InstanceTypeInterface_IID "net.forkk.MultiMC.InstanceTypeInterface/0.1"
+
+/*!
+ * \brief The InstanceType class is an interface for all instance types.
+ * InstanceTypes are usually provided by plugins.
+ * It handles loading and creating instances of a certain type. There should be
+ * one of these for each type of instance and they should be registered with the
+ * InstanceLoader.
+ * To create an instance, the InstanceLoader calls the type's createInstance()
+ * function. Loading is done through the loadInstance() function.
+ */
+class InstanceTypeInterface
+{
+public:
+ friend class InstanceLoader;
+
+ /*!
+ * \brief Gets the ID for this instance type.
+ * The type ID should be unique as it is used to identify the type
+ * of instances when they are loaded.
+ * Changing this value at runtime results in undefined behavior.
+ * \return This instance type's ID string.
+ */
+ virtual QString typeID() const = 0;
+
+ /*!
+ * \brief Gets the name of this instance type as it is displayed to the user.
+ * \return The instance type's display name.
+ */
+ virtual QString displayName() const = 0;
+
+ /*!
+ * \brief Gets a longer, more detailed description of this instance type.
+ * \return The instance type's description.
+ */
+ virtual QString description() const = 0;
+
+protected:
+ /*!
+ * \brief Creates an instance and stores it in inst.
+ * \param inst Pointer to store the created instance in.
+ * \param instDir The instance's directory.
+ * \return An InstTypeError error code.
+ * TypeNotRegistered if the given type is not registered with the InstanceLoader.
+ * InstExists if the given instance directory is already an instance.
+ */
+ virtual InstanceLoader::InstTypeError createInstance(Instance *&inst, const QString &instDir) const = 0;
+
+ /*!
+ * \brief Loads an instance from the given directory.
+ * \param inst Pointer to store the loaded instance in.
+ * \param instDir The instance's directory.
+ * \return An InstTypeError error code.
+ * TypeNotRegistered if the given type is not registered with the InstanceLoader.
+ * NotAnInstance if the given instance directory isn't a valid instance.
+ * WrongInstType if the given instance directory's type isn't an instance of this type.
+ */
+ virtual InstanceLoader::InstTypeError loadInstance(Instance *&inst, const QString &instDir) const = 0;
+};
+
+Q_DECLARE_INTERFACE(InstanceTypeInterface, InstanceTypeInterface_IID)
+
+#endif // INSTANCETYPE_H
diff --git a/libmultimc/include/instversion.h b/libmultimc/include/instversion.h
new file mode 100644
index 00000000..3c6b7ac9
--- /dev/null
+++ b/libmultimc/include/instversion.h
@@ -0,0 +1,53 @@
+/* Copyright 2013 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.
+ */
+
+#ifndef INSTVERSION_H
+#define INSTVERSION_H
+
+#include <QObject>
+
+#include "libmmc_config.h"
+
+class InstVersionList;
+
+class LIBMULTIMC_EXPORT InstVersion : public QObject
+{
+ Q_OBJECT
+public:
+ // Constructs a new InstVersion with the given parent. The parent *must*
+ // be the InstVersionList that contains this InstVersion. The InstVersion
+ // should be added to the list immediately after being created as any calls
+ // to id() will likely fail unless the InstVersion is in a list.
+ explicit InstVersion(InstVersionList *parent = 0);
+
+ // Returns this InstVersion's ID. This is usually just the InstVersion's index
+ // within its InstVersionList, but not always.
+ // If this InstVersion is not in an InstVersionList, returns -1.
+ virtual int id() const = 0;
+
+ // Returns this InstVersion's name. This is displayed to the user in the GUI
+ // and is usually just the version number ("1.4.7"), for example.
+ virtual QString name() const = 0;
+
+ // Returns this InstVersion's name. This is usually displayed to the user
+ // in the GUI and specifies what kind of version this is. For example: it
+ // could be "Snapshot", "Latest Version", "MCNostalgia", etc.
+ virtual QString type() const = 0;
+
+ // Returns the version list that this InstVersion is a part of.
+ virtual InstVersionList *versionList() const;
+};