mirror/HMCL
2
0
Fork 0
mirror of https://github.com/HMCL-dev/HMCL.git synced 2025-01-24 14:34:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove HMCLCore usage instructions

Browse Source
This commit is contained in:
yushijinhun 2018-12-08 19:14:56 +08:00
parent b78f9c8cd5
commit cf28b27d50
No known key found for this signature in database
GPG Key ID: 5BC167F73EA558E4
2 changed files with 2 additions and 154 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
HMCLCore/src/main/java/org/jackhuang/hmcl/auth/AccountBuilder.java
View File

@ -1,54 +0,0 @@
/*
* Hello Minecraft! Launcher.
* Copyright (C) 2017 huangyuhui <huanghongxun2008@126.com>
*
* 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 {http://www.gnu.org/licenses/}.
*/
package org.jackhuang.hmcl.auth;
import java.util.Objects;
public final class AccountBuilder<T extends Account> {
private CharacterSelector selector = CharacterSelector.DEFAULT;
private String username;
private String password = null;
private Object additionalData = null;
public AccountBuilder() {
}
public AccountBuilder<T> setSelector(CharacterSelector selector) {
this.selector = Objects.requireNonNull(selector);
return this;
}
public AccountBuilder<T> setUsername(String username) {
this.username = Objects.requireNonNull(username);
return this;
}
public AccountBuilder<T> setPassword(String password) {
this.password = password;
return this;
}
public AccountBuilder<T> setAdditionalData(Object additionalData) {
this.additionalData = additionalData;
return this;
}
public T create(AccountFactory<T> factory) throws AuthenticationException {
return factory.create(selector, Objects.requireNonNull(username), password, additionalData);
}
}

102
README.md
View File

@ -5,6 +5,8 @@ GPL v3, see http://www.gnu.org/licenses/gpl.html
HMCL is a Minecraft launcher which supports Mod management, game customizing, auto installing(Forge, LiteLoader and OptiFine), modpack creating, UI customizing and so on.
No plugin API is provided.
## Contribution
If you want to submit a pull request, there're some requirements:
@ -12,106 +14,6 @@ If you want to submit a pull request, there're some requirements:
* Compiler: Java 1.8.
* Do NOT modify `gradle` files.
## HMCLCore
Now HMCLCore is independent and you can use HMCLCore as a library to launch your game.
### GameRepository
Create a game repository `repository` to manage a minecraft installation. Like this.
```java
DefaultGameRepository repository = new DefaultGameRepository(new File(".minecraft").getAbsoluteFile());
```
You should put where your minecraft installation is to the only argument of the constructor of `DefaultGameRepository`.
### Launching
Now you can launch game by constructing a `DefaultLauncher`.
```java
DefaultLauncher launcher = new DefaultLauncher(
repository, // GameRepository
"test", // Your minecraft version name
new AccountBuilder.Builder()
.setUsername("playerId")
.setProxy(Proxy.NO_PROXY) // Optional
.create(OfflineAccountFactory.INSTANCE)
.logIn(), // account
// or new AccountBuilder.Builder()
// .setUsername("someone@xxx.com")
// .setPassword("someone's password")
// // for Mojang account
// .create(new YggdrasilAccountFactory(MojangYggdrasilProvider.INSTANCE))
// // for Authlib Injector account
// .create(new AuthlibInjectorAccountFactory(
// new AuthlibInjectorDownloader(new File("path to save executables of authlib injector"),
// () -> MojangYggdrasilProvider.INSTANCE)::getArtifactInfo,
// () -> AuthlibInjectorServer.fetchServerInfo("Your authlib injector auth server")))
// .logIn()
new LaunchOptions.Builder()
.setGameDir(repository.getBaseDirectory()) // directory that the game saves settings to
.setMaxMemory(...)
.setJava(...) // executable of JVM
.setJavaArgs(...) // additional Java VM arguments
.setMinecraftArgs(...) // additional Minecraft arguments
.setHeight(...) // height of game window
.setWidth(...) // width of game window
...
.create(),
new ProcessListener() { // listening the process state.
@Override
public void onLog(String log, Log4jLevel level) { // new console log
System.out.println(log);
}
@Override
public void onExit(int exitCode, ExitType exitType) { // process exited
System.out.println("Process exited then exit code " + exitCode);
}
},
false // true if launcher process exits, listening threads exit too.
);
```
Now you can simply call `launcher.launch()` to launch the game.
If you want the command line, just call `launcher.getRawCommandLine`. Also, `StringUtils.makeCommand` might be useful.
### Downloading
HMCLCore just owns a simple way to download a new game.
```java
DefaultDependencyManager dependency = new DefaultDependencyManager(repository, new MojangDownloadProvider(), proxy);
```
`repository` is your `GameRepository`. `MojangDownloadProvider.INSTANCE` means that we download files from mojang servers. If you want BMCLAPI, `BMCLAPIDownloadProvider.INSTANCE` is just for you. `proxy` is `java.net.Proxy`, if you have a proxy, put it here, or `Proxy.NO_PROXY`.
Now `GameBuilder` can build a game.
```java
Task gameBuildingTask = dependency.gameBuilder()
.name("test")
.gameVersion("1.12") // Minecraft version
.version("forge", "14.21.1.2426") // Forge version
.version("liteloader", "1.12-SNAPSHOT-4") // LiteLoader version
.version("optifine", "HD_U_C4") // OptiFine version
.buildAsync();
```
Nowadays HMCLCore only supports Forge, LiteLoader and OptiFine auto-installing.
`buildAsync` will return a `Task`, you can call `Task.executor()::start` or simply `Task::start` to start this task. If you want to monitor the execution of tasks, you should see `TaskExecutor` and `Task::executor`.
### Modpack installing
HMCLCore supports Curse, MultiMC modpack.
```java
// Installing curse modpack
new CurseInstallTask(dependency, modpackZipFile, CurseManifest.readCurseForgeModpackManifest(modpackZipFile), "name of the new game");
// Installing MultiMC modpack
new MultiMCModpackInstallTask(dependency, modpackZipFile, MultiMCInstanceConfiguration.readMultiMCModpackManifest(modpackZipFile), "name of the new game");
// ** IMPORTANT **: You should read game settings from MultiMCInstanceConfiguration
```
## HMCL
No plugin API.
## JVM Options (for debugging)
|Parameter|Description|
|---------|-----------|