QGettingStarted
An open-source library for launching and downloading 'Minecraft'.
- 启动全版本Minecraft
- 可拓展登录系统
- 支持Offline（离线） * 支持Yggdrasil（正版）
- 下载Minecraft
- 下载Forge/Liteloader/Optifine * 支持Liteloader的快照版本 * 支持自定义下载源（已内置BMCLAPI） * 支持多线程下载 * 支持断点下载
- Natives解压
- 网络代理
- Java信息查找（Windows Only）
编译
Visual Studio 2015/Qt Creator 4.5.0|Qt 5.10.0 下编译通过。
警告
正式版本已开始推送！
开发文档
QGSDocument 使用完整功能请查阅开发文档
快速开始
使用启动核心
1.下载源码自行编译或下载已编译好的静态库（首个为最新版本）：
- 0.2.0：
- 0.1.1：
- Pre 2.0.0：
- Beta 1.4.0：
- Beta 1.3.0：
- Beta 1.2.0：
- Beta 1.1.0：
- Beta 1.0.0：
2.将静态库，如"QGettingStarted.lib，zlib.lib"，添加进工程，包含头文件"QGettingStarted.h"即可。
启动游戏
QString launchCommand;
QGSLauncher launcher;
QGSGameDirectory gameDirectory(QDir("./minecraft"));
QGSLaunchOptionsBuilder launchOptionsBuilder;
launchOptionsBuilder.setJavaPath("C:/Program Files/Java/jre1.8.0_162/bin/javaw.exe");
launchOptionsBuilder.setMaxMemory(1024);
launchOptionsBuilder.setMinMemory(128);
QGSAuthInfo authInfo;
QEventLoop eventLoop;
//正版登录替换为QGSYggdrasilAccountFactory
QGSIAccount * account(QGSOfflineAccountFactory().createAccount());
QObject::connect(account, &QGSIAccount::finished, &eventLoop, &QEventLoop::quit);
QObject::connect(account, &QGSIAccount::finished, [&authInfo](QGSAuthInfo _authInfo)
{
authInfo = _authInfo;
});
/*正版登录的错误检查
QObject::connect(account, &QGSIAccount::error, [](QGSNetworkError networkError)
{
qDebug() << "QGSNetworkError:" << networkError.getCode() << networkError.getErrorString();
});
*/
account->authenticate("player");
//account->authenticate("[email protected]","123456"); 正版登录
eventLoop.exec();
launchOptionsBuilder.setAuthInfo(authInfo);
launchOptionsBuilder.setJVMArguments("-XX:+UseG1GC -XX:-UseAdaptiveSizePolicy -XX:-OmitStackTraceInFastThrow");
launcher.generateLaunchCommand(gameDirectory.getVersion("1.11.2"), gameDirectory, launchOptionsBuilder.getLaunchOptions(), launchCommand);获取游戏版本列表
//下载任务工厂
QGSDownloadTaskFactory downloadTaskFactory(new QGSBMCLAPIDownloadSource);
//下载到当前目录
QGSDownloadTask * downloadTask = downloadTaskFactory.generateGameVersionInfoJsonDownloadTask(new QFile("./version_manifest.json"));
//下载进程
QObject::connect(downloadTask, &QGSDownloadTask::downloadProgress, [=](qint64 bytesReceived, qint64 bytesTotal, QGSTask * task)
{
qDebug() << "version manifest:" << bytesReceived << ";" << bytesTotal;
});
//下载完成
QObject::connect(downloadTask, &QGSDownloadTask::finished, [=](QGSTask * task)
{
qDebug() << "version manifest prase test";
QGSGameVersionInfoListFactory versionInfoFactory;
downloadTask->getTargetFile()->open(QIODevice::ReadOnly);
QGSGameVersionInfoList versionInfoList(versionInfoFactory.createGameVersionInfoList(downloadTask->getTargetFile()->readAll()));
for (int i = 0; i < versionInfoList.size(); i++)
{
qDebug() << "id:" << versionInfoList[i].getId()
<< "type:" << versionInfoList[i].getType()
<< "time:" << versionInfoList[i].getTime()
<< "releasetime:" << versionInfoList[i].getReleaseTime()
<< "url:" << versionInfoList[i].getUrl().toString();
}
downloadTask->deleteLater();
});
//下载错误
QObject::connect(downloadTask, &QGSDownloadTask::downloadError, [=](QGSNetworkError error, QGSTask * task)
{
qDebug() << "version manifest:" << "Code:" << error.getCode() << "Message:" << error.getErrorString();
});
downloadTask->start();//也可以加入线程池中，threadPoolManager->addTaskBack(downloadTask);获取Forge列表
QGSDownloadTaskFactory * downloadTaskFactory(new QGSDownloadTaskFactory(new QGSOfficialDownloadSource));
QGSDownloadTask * downloadTask = nullptr;
downloadTask = downloadTaskFactory->generateForgeVersionInfoJsonDownloadTask(new QFile(QString("./forge_manifest.json")), 100, 50);
QObject::connect(downloadTask, &QGSDownloadTask::downloadProgress, [=](qint64 bytesReceived, qint64 bytesTotal, QGSTask * task)
{
qDebug() << "forge version info json:" << bytesReceived << ";" << bytesTotal;
});
QObject::connect(downloadTask, &QGSDownloadTask::finished, [=](QGSTask * task)
{
qDebug() << "forge version info json finished!";
QGSForgeVersionInfoListFactory versionInfoFactory;
downloadTask->getTargetFile()->open(QIODevice::ReadOnly);
//因forge版本较多，为了照顾性能与资源，需要设置偏移量与上限。示例中：1为偏移量，1000为上限。
QGSForgeVersionInfoList versionInfoList(versionInfoFactory.createForgeVersionInfoList(downloadTask->getTargetFile()->readAll(), 1, 1000));
versionInfoList.merge(versionInfoList);
for (int i = 0; i < versionInfoList.size(); i++)
{
qDebug() << "branch" << versionInfoList[i].getBranch()
<< "build" << versionInfoList[i].getBuild()
<< "mcversion" << versionInfoList[i].getMcversion()
<< "modified" << versionInfoList[i].getModified()
<< "version" << versionInfoList[i].getVersion()
<< "_id" << versionInfoList[i].getId();
}
task->deleteLater();
});
QObject::connect(downloadTask, &QGSDownloadTask::downloadError, [=](QGSNetworkError error, QGSTask * task)
{
qDebug() << "forge version info json:" << "Code:" << error.getCode() << "Message:" << error.getErrorString();
});
downloadTask->start();//也可以加入线程池中，threadPoolManager->addTaskBack(downloadTask);获取LiteLoader列表
QGSDownloadTaskFactory * downloadTaskFactory(new QGSDownloadTaskFactory(new QGSOfficialDownloadSource));
QGSDownloadTask * downloadTask = nullptr;
downloadTask = downloadTaskFactory->generateLiteLoaderVersionInfoJsonDownloadTask(new QFile(QString("./liteloader_manifest.json")));
QObject::connect(downloadTask, &QGSDownloadTask::downloadProgress, [=](qint64 bytesReceived, qint64 bytesTotal, QGSTask * task)
{
qDebug() << "liteloader version info json:" << bytesReceived << ";" << bytesTotal;
});
QObject::connect(downloadTask, &QGSDownloadTask::finished, [=](QGSTask * task)
{
qDebug() << "liteloader version info json finished!";
QGSLiteLoaderVersionInfoListFactory versionInfoFactory;
downloadTask->getTargetFile()->open(QIODevice::ReadOnly);
QGSLiteLoaderVersionInfoList versionInfoList(versionInfoFactory.createLiteLoaderVersionInfoList(downloadTask->getTargetFile()->readAll()));
for (int i = 0; i < versionInfoList.size(); i++)
{
/*相关操作*/
}
task->deleteLater();
});
QObject::connect(downloadTask, &QGSDownloadTask::downloadError, [=](QGSNetworkError error, QGSTask * task)
{
qDebug() << "liteloader version info json:" << "Code:" << error.getCode() << "Message:" << error.getErrorString();
});
downloadTask->start();//也可以加入线程池中，threadPoolManager->addTaskBack(downloadTask);#获取Optifine列表
QGSDownloadTaskFactory * downloadTaskFactory(new QGSDownloadTaskFactory(new QGSOfficialDownloadSource));
QGSDownloadTask * downloadTask = nullptr;
downloadTask = downloadTaskFactory->generateOptifineVersionInfoJsonDownloadTask(new QFile(QString("./optifine_manifest.json")));
QObject::connect(downloadTask, &QGSDownloadTask::downloadProgress, [=](qint64 bytesReceived, qint64 bytesTotal, QGSTask * task)
{
qDebug() << "optifine version info json:" << bytesReceived << ";" << bytesTotal;
});
QObject::connect(downloadTask, &QGSDownloadTask::finished, [=](QGSTask * task)
{
qDebug() << "optifine version info json finished!";
QGSOptifineVersionInfoListFactory versionInfoFactory;
downloadTask->getTargetFile()->open(QIODevice::ReadOnly);
QGSOptifineVersionInfoList versionInfoList(versionInfoFactory.createOptifineVersionInfoList(downloadTask->getTargetFile()->readAll()));
for (int i = 0; i < versionInfoList.size(); i++)
{
/*相关操作*/
}
task->deleteLater();
});
QObject::connect(downloadTask, &QGSDownloadTask::downloadError, [=](QGSNetworkError error, QGSTask * task)
{
qDebug() << "optifine manifest:" << "Code:" << error.getCode() << "Message:" << error.getErrorString();
});
downloadTask->start();//也可以加入线程池中，threadPoolManager->addTaskBack(downloadTask);下载游戏（库、资源补全）
//"version_manifest.json"文件需要自行下载，详见"获取版本列表"
QFile manifestFile("./version_manifest.json");
manifestFile.open(QIODevice::ReadOnly);
QGSGameVersionInfoListFactory versionInfoFactory;
QGSGameVersionInfoList versionInfoList(versionInfoFactory.createGameVersionInfoList(manifestFile.readAll()));
QGSIDownloadSource * downloadSource = new QGSBMCLAPIDownloadSource;//BMCL
QGSGameVersionInfo versionInfo = versionInfoList.getVersionInfo("1.11.2");
QGSDownloadTaskFactory * downloadTaskFactory(new QGSDownloadTaskFactory(downloadSource));
//游戏目录
QGSGameDirectory * gameDirectory(new QGSGameDirectory(QDir("./.minecraft")));
//线程池。线程池数最小为8，最大为512。
QGSThreadPoolManager * threadPoolManager(new QGSThreadPoolManager(8, 512));
//建造者工厂，用于创建游戏各部分的建造者。
QGSBuilderFactory * builderFactory(new QGSBuilderFactory(threadPoolManager));
//游戏本体建造者。
QGSGameVersionBuilder * gameVersionBuilder = builderFactory->createGameVersionBuilder(versionInfo, gameDirectory, downloadTaskFactory);
//库建造者
QGSLibraryBuilder * libraryBuilder = builderFactory->createLibraryBuilder(versionInfo, gameDirectory, downloadTaskFactory);
//资源建造者
QGSAssetBuilder * assetBuilder = builderFactory->createAssetBuilder(versionInfo, gameDirectory, downloadTaskFactory);
//前一个任务发出finished(）（完成）信号后即刻执行下一个任务。
gameVersionBuilder->setNextTask(libraryBuilder).setNextTask(assetBuilder);
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::started, [=]()//建造者开始
{
qDebug() << "gameVersionBuilder started!";
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::downloadTaskStarted, [=](QGSDownloadTask * task)//任务开始
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " started!";
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::downloadTaskFinished, [=](QGSDownloadTask * task)//任务完成
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " finished!" << gameVersionBuilder->getTaskListSize() << "left!";
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::downloadTaskStoped, [=](QGSDownloadTask * task)//任务暂停
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " stoped!";
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::downloadTaskCanceled, [=](QGSDownloadTask * task)//任务取消
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " canceled!";
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::downloadTaskDownloadProgress, [](qint64 bytesReceived, qint64 bytesTotal, QGSDownloadTask * task)//任务进程
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " download progress:" << "bytes received:" << bytesReceived << "bytes total:" << bytesTotal;
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::downloadTaskDownloadError, [=](QGSNetworkError error, QGSDownloadTask * task)//任务错误（同时发出downloadTaskError()）
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " download error!" << gameVersionBuilder->getTaskListSize() << "left!" << "Error code:" << error.getCode();
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::downloadTaskError, [=](QGSDownloadTask * task)//任务错误
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " error!" << gameVersionBuilder->getTaskListSize() << "left!";
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::error, [=]()//建造者错误
{
qDebug() << "gameVersionBuilder error!";
});
QObject::connect(gameVersionBuilder, &QGSGameVersionBuilder::finished, [=]()//建造者完成
{
qDebug() << "gameVersionBuilder finished!";
});
//
QObject::connect(libraryBuilder, &QGSLibraryBuilder::started, [=]()
{
qDebug() << "libraryBuilder started!";
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::downloadTaskStarted, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " started!";
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::downloadTaskFinished, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " finished!" << libraryBuilder->getTaskListSize() << "left!";
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::downloadTaskStoped, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " stoped!";
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::downloadTaskCanceled, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " canceled!";
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::downloadTaskDownloadProgress, [](qint64 bytesReceived, qint64 bytesTotal, QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " download progress:" << "bytes received:" << bytesReceived << "bytes total:" << bytesTotal;
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::downloadTaskDownloadError, [=](QGSNetworkError error, QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " download error!" << libraryBuilder->getTaskListSize() << "left!" << "Error code:" << error.getCode();
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::downloadTaskError, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " error!" << libraryBuilder->getTaskListSize() << "left!";
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::error, [=]()
{
qDebug() << "libraryBuilder error!";
});
QObject::connect(libraryBuilder, &QGSLibraryBuilder::finished, [=]()
{
qDebug() << "libraryBuilder finished!";
});
//
QObject::connect(assetBuilder, &QGSLibraryBuilder::started, [=]()
{
qDebug() << "assetBuilder started!";
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::downloadTaskStarted, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " started!";
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::downloadTaskFinished, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " finished!" << assetBuilder->getTaskListSize() << "left!";
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::downloadTaskStoped, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " stoped!";
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::downloadTaskCanceled, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " canceled!";
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::downloadTaskDownloadProgress, [](qint64 bytesReceived, qint64 bytesTotal, QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " download progress:" << "bytes received:" << bytesReceived << "bytes total:" << bytesTotal;
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::downloadTaskDownloadError, [=](QGSNetworkError error, QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " download error!" << assetBuilder->getTaskListSize() << "left!" << "Error code:" << error.getCode();
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::downloadTaskError, [=](QGSDownloadTask * task)
{
qDebug() << "download:" << task->getDownloadInfo().getUrl() << " error!" << assetBuilder->getTaskListSize() << "left!";
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::error, [=]()
{
qDebug() << "assetBuilder error!";
});
QObject::connect(assetBuilder, &QGSLibraryBuilder::finished, [=]()
{
qDebug() << "assetBuilder finished!";
});
//将建造者加入线程池
threadPoolManager->addTaskBack(gameVersionBuilder);下载Forge（需要自行安装）
QGSDownloadTaskFactory * downloadTaskFactory(new QGSDownloadTaskFactory(new QGSOfficialDownloadSource));
QGSDownloadTask * downloadTask = nullptr;
//forge download test
downloadTask = downloadTaskFactory->generateForgeDownloadTask(new QFile(QString("./forge-installer.jar")), "1.11.2", "13.20.0.2200", "installer", "jar");
QObject::connect(downloadTask, &QGSDownloadTask::downloadProgress, [=](qint64 bytesReceived, qint64 bytesTotal, QGSTask * task)
{
qDebug() << "Forge:" << bytesReceived << ";" << bytesTotal;
});
QObject::connect(downloadTask, &QGSDownloadTask::finished, [=](QGSTask * task)
{
qDebug() << "Forge:finished!";
task->deleteLater();
});
QObject::connect(downloadTask, &QGSDownloadTask::downloadError, [=](QGSNetworkError error, QGSTask * task)
{
qDebug() << "Forge:" << "Code:" << error.getCode();
});
downloadTask->start();//也可以加入线程池中，threadPoolManager->addTaskBack(downloadTask);下载LiteLoader（需要自行安装）
QGSDownloadTaskFactory * downloadTaskFactory(new QGSDownloadTaskFactory(new QGSOfficialDownloadSource));
QGSDownloadTask * downloadTask = nullptr;
//liteloader download test
downloadTask = downloadTaskFactory->generateLiteLoaderDownloadTask(new QFile(QString("./liteloader.jar")), "1.11.2", "1.11.2-SNAPSHOT", "installer");
QObject::connect(downloadTask, &QGSDownloadTask::downloadProgress, [=](qint64 bytesReceived, qint64 bytesTotal, QGSTask * task)
{
qDebug() << "LiteLoader:" << bytesReceived << ";" << bytesTotal;
});
QObject::connect(downloadTask, &QGSDownloadTask::finished, [=](QGSTask * task)
{
qDebug() << "LiteLoader:finished!";
task->deleteLater();
});
QObject::connect(downloadTask, &QGSDownloadTask::downloadError, [=](QGSNetworkError error, QGSTask * task)
{
qDebug() << "LiteLoader:" << "Code:" << error.getCode();
});
downloadTask->start();//也可以加入线程池中，threadPoolManager->addTaskBack(downloadTask);下载Optifine（需要自行安装）
QGSDownloadTaskFactory * downloadTaskFactory(new QGSDownloadTaskFactory(new QGSOfficialDownloadSource));
QGSDownloadTask * downloadTask = nullptr;
//optifine download test
downloadTask = downloadTaskFactory->generateOptifineDownloadTask(new QFile(QString("./optifine.zip")), "1.9.2", "HD_U", "D7");
QObject::connect(downloadTask, &QGSDownloadTask::downloadProgress, [=](qint64 bytesReceived, qint64 bytesTotal, QGSTask * task)
{
qDebug() << "Optifine:" << bytesReceived << ";" << bytesTotal;
});
QObject::connect(downloadTask, &QGSDownloadTask::finished, [=](QGSTask * task)
{
qDebug() << "Optifine:finished!";
task->deleteLater();
});
QObject::connect(downloadTask, &QGSDownloadTask::downloadError, [=](QGSNetworkError error, QGSTask * task)
{
qDebug() << "Optifine:" << "Code:" << error.getCode();
});
downloadTask->start();//也可以加入线程池中，threadPoolManager->addTaskBack(downloadTask);