mirror of
https://github.com/dscalzi/HeliosLauncher.git
synced 2024-10-31 19:36:39 -07:00
d33476bcf9
Added new configuration option, launchDetached. Added validation function to ConfigManager to add missing keys (due to updates). Updated westeroscraft.json Game process can now be detached from the launcher.
376 lines
14 KiB
JavaScript
376 lines
14 KiB
JavaScript
/**
|
|
* The initial iteration of this file will not support optional submodules.
|
|
* Support will be added down the line, only top-level modules will recieve optional support.
|
|
*/
|
|
const AdmZip = require('adm-zip')
|
|
const {AssetGuard, Library} = require('./assetguard.js')
|
|
const child_process = require('child_process')
|
|
const ConfigManager = require('./configmanager.js')
|
|
const crypto = require('crypto')
|
|
const fs = require('fs')
|
|
const mkpath = require('mkdirp')
|
|
const os = require('os')
|
|
const path = require('path')
|
|
const rimraf = require('rimraf')
|
|
const {URL} = require('url')
|
|
|
|
class ProcessBuilder {
|
|
|
|
constructor(gameDirectory, distroServer, versionData, forgeData, authUser){
|
|
this.dir = gameDirectory
|
|
this.server = distroServer
|
|
this.versionData = versionData
|
|
this.forgeData = forgeData
|
|
this.authUser = authUser
|
|
this.fmlDir = path.join(this.dir, 'versions', this.server.id + '.json')
|
|
this.libPath = path.join(this.dir, 'libraries')
|
|
}
|
|
|
|
static shouldInclude(mdle){
|
|
//If the module should be included by default
|
|
return mdle.required == null || mdle.required.value == null || mdle.required.value === true || (mdle.required.value === false && (mdle.required.def == null || mdle.required.def === true))
|
|
}
|
|
|
|
/**
|
|
* Convienence method to run the functions typically used to build a process.
|
|
*/
|
|
build(){
|
|
const tempNativePath = path.join(os.tmpdir(), ConfigManager.getTempNativeFolder(), crypto.pseudoRandomBytes(16).toString('hex'))
|
|
process.throwDeprecation = true
|
|
const mods = this.resolveDefaultMods()
|
|
this.constructFMLModList(mods, true)
|
|
const args = this.constructJVMArguments(mods, tempNativePath)
|
|
|
|
console.log(args)
|
|
|
|
const child = child_process.spawn(ConfigManager.getJavaExecutable(), args, {
|
|
cwd: ConfigManager.getGameDirectory(),
|
|
detached: ConfigManager.isLaunchDetached()
|
|
})
|
|
|
|
if(ConfigManager.isLaunchDetached()){
|
|
child.unref()
|
|
}
|
|
|
|
child.stdout.on('data', (data) => {
|
|
console.log('Minecraft:', data.toString('utf8'))
|
|
})
|
|
child.stderr.on('data', (data) => {
|
|
console.log('Minecraft:', data.toString('utf8'))
|
|
})
|
|
child.on('close', (code, signal) => {
|
|
console.log('Exited with code', code)
|
|
rimraf(tempNativePath, (err) => {
|
|
if(err){
|
|
console.warn('Error while deleting temp dir', err)
|
|
} else {
|
|
console.log('Temp dir deleted successfully.')
|
|
}
|
|
})
|
|
})
|
|
|
|
return child
|
|
}
|
|
|
|
resolveDefaultMods(options = {type: 'forgemod'}){
|
|
//Returns array of default forge mods to load.
|
|
const mods = []
|
|
const mdles = this.server.modules
|
|
|
|
for(let i=0; i<mdles.length; ++i){
|
|
if(mdles[i].type != null && mdles[i].type === options.type){
|
|
if(ProcessBuilder.shouldInclude(mdles[i])){
|
|
mods.push(mdles[i])
|
|
}
|
|
}
|
|
}
|
|
|
|
return mods
|
|
}
|
|
|
|
constructFMLModList(mods, save = false){
|
|
const modList = {}
|
|
modList.repositoryRoot = path.join(this.dir, 'modstore')
|
|
const ids = []
|
|
for(let i=0; i<mods.length; ++i){
|
|
ids.push(mods[i].id)
|
|
}
|
|
modList.modRef = ids
|
|
|
|
if(save){
|
|
const json = JSON.stringify(modList, null, 4)
|
|
fs.writeFileSync(this.fmlDir, json, 'UTF-8')
|
|
}
|
|
|
|
return modList
|
|
}
|
|
|
|
/**
|
|
* Construct the argument array that will be passed to the JVM process.
|
|
*
|
|
* @param {Array.<Object>} mods An array of enabled mods which will be launched with this process.
|
|
* @param {string} tempNativePath The path to store the native libraries.
|
|
* @returns {Array.<string>} An array containing the full JVM arguments for this process.
|
|
*/
|
|
constructJVMArguments(mods, tempNativePath){
|
|
|
|
let args = ['-Xmx' + ConfigManager.getMaxRAM(),
|
|
'-Xms' + ConfigManager.getMinRAM(),
|
|
'-Djava.library.path=' + tempNativePath,
|
|
'-cp',
|
|
this.classpathArg(mods, tempNativePath).join(process.platform === 'win32' ? ';' : ':'),
|
|
this.forgeData.mainClass]
|
|
|
|
if(process.platform === 'darwin'){
|
|
args.unshift('-Xdock:name=WesterosCraft')
|
|
args.unshift('-Xdock:icon=' + path.join(__dirname, '..', 'images', 'minecraft.icns'))
|
|
}
|
|
|
|
args.splice(2, 0, ...ConfigManager.getJVMOptions())
|
|
|
|
args = args.concat(this._resolveForgeArgs())
|
|
|
|
return args
|
|
}
|
|
|
|
/**
|
|
* Resolve the arguments required by forge.
|
|
*
|
|
* @returns {Array.<string>} An array containing the arguments required by forge.
|
|
*/
|
|
_resolveForgeArgs(){
|
|
const mcArgs = this.forgeData.minecraftArguments.split(' ')
|
|
const argDiscovery = /\${*(.*)}/
|
|
|
|
// Replace the declared variables with their proper values.
|
|
for(let i=0; i<mcArgs.length; ++i){
|
|
if(argDiscovery.test(mcArgs[i])){
|
|
const identifier = mcArgs[i].match(argDiscovery)[1]
|
|
let val = null;
|
|
switch(identifier){
|
|
case 'auth_player_name':
|
|
val = this.authUser.displayName
|
|
break
|
|
case 'version_name':
|
|
//val = versionData.id
|
|
val = this.server.id
|
|
break
|
|
case 'game_directory':
|
|
val = this.dir
|
|
break
|
|
case 'assets_root':
|
|
val = path.join(this.dir, 'assets')
|
|
break
|
|
case 'assets_index_name':
|
|
val = this.versionData.assets
|
|
break
|
|
case 'auth_uuid':
|
|
val = this.authUser.uuid
|
|
break
|
|
case 'auth_access_token':
|
|
val = this.authUser.accessToken
|
|
break
|
|
case 'user_type':
|
|
val = 'MOJANG'
|
|
break
|
|
case 'version_type':
|
|
val = this.versionData.type
|
|
break
|
|
}
|
|
if(val != null){
|
|
mcArgs[i] = val;
|
|
}
|
|
}
|
|
}
|
|
mcArgs.push('--modListFile')
|
|
mcArgs.push('absolute:' + this.fmlDir)
|
|
|
|
// Prepare game resolution
|
|
if(ConfigManager.isFullscreen()){
|
|
mcArgs.unshift('--fullscreen')
|
|
} else {
|
|
mcArgs.unshift(ConfigManager.getGameWidth())
|
|
mcArgs.unshift('--width')
|
|
mcArgs.unshift(ConfigManager.getGameHeight())
|
|
mcArgs.unshift('--height')
|
|
}
|
|
|
|
// Prepare autoconnect
|
|
if(ConfigManager.isAutoConnect() && this.server.autoconnect){
|
|
const serverURL = new URL('my://' + this.server.server_ip)
|
|
mcArgs.unshift(serverURL.hostname)
|
|
mcArgs.unshift('--server')
|
|
if(serverURL.port){
|
|
mcArgs.unshift(serverURL.port)
|
|
mcArgs.unshift('--port')
|
|
}
|
|
}
|
|
|
|
return mcArgs
|
|
}
|
|
|
|
/**
|
|
* Resolve the full classpath argument list for this process. This method will resolve all Mojang-declared
|
|
* libraries as well as the libraries declared by the server. Since mods are permitted to declare libraries,
|
|
* this method requires all enabled mods as an input
|
|
*
|
|
* @param {Array.<Object>} mods An array of enabled mods which will be launched with this process.
|
|
* @param {string} tempNativePath The path to store the native libraries.
|
|
* @returns {Array.<string>} An array containing the paths of each library required by this process.
|
|
*/
|
|
classpathArg(mods, tempNativePath){
|
|
let cpArgs = []
|
|
|
|
// Add the version.jar to the classpath.
|
|
const version = this.versionData.id
|
|
cpArgs.push(path.join(this.dir, 'versions', version, version + '.jar'))
|
|
|
|
// Resolve the Mojang declared libraries.
|
|
const mojangLibs = this._resolveMojangLibraries(tempNativePath)
|
|
cpArgs = cpArgs.concat(mojangLibs)
|
|
|
|
// Resolve the server declared libraries.
|
|
const servLibs = this._resolveServerLibraries(mods)
|
|
cpArgs = cpArgs.concat(servLibs)
|
|
|
|
return cpArgs
|
|
}
|
|
|
|
/**
|
|
* Resolve the libraries defined by Mojang's version data. This method will also extract
|
|
* native libraries and point to the correct location for its classpath.
|
|
*
|
|
* TODO - clean up function
|
|
*
|
|
* @param {string} tempNativePath The path to store the native libraries.
|
|
* @returns {Array.<string>} An array containing the paths of each library mojang declares.
|
|
*/
|
|
_resolveMojangLibraries(tempNativePath){
|
|
const libs = []
|
|
|
|
const libArr = this.versionData.libraries
|
|
mkpath.sync(tempNativePath)
|
|
for(let i=0; i<libArr.length; i++){
|
|
const lib = libArr[i]
|
|
if(Library.validateRules(lib.rules)){
|
|
if(lib.natives == null){
|
|
const dlInfo = lib.downloads
|
|
const artifact = dlInfo.artifact
|
|
const to = path.join(this.libPath, artifact.path)
|
|
libs.push(to)
|
|
} else {
|
|
// Extract the native library.
|
|
const natives = lib.natives
|
|
const extractInst = lib.extract
|
|
const exclusionArr = extractInst.exclude
|
|
const opSys = Library.mojangFriendlyOS()
|
|
const indexId = natives[opSys]
|
|
const dlInfo = lib.downloads
|
|
const classifiers = dlInfo.classifiers
|
|
const artifact = classifiers[indexId]
|
|
|
|
// Location of native zip.
|
|
const to = path.join(this.libPath, artifact.path)
|
|
|
|
let zip = new AdmZip(to)
|
|
let zipEntries = zip.getEntries()
|
|
|
|
// Unzip the native zip.
|
|
for(let i=0; i<zipEntries.length; i++){
|
|
const fileName = zipEntries[i].entryName
|
|
|
|
let shouldExclude = false
|
|
|
|
// Exclude noted files.
|
|
exclusionArr.forEach(function(exclusion){
|
|
if(fileName.indexOf(exclusion) > -1){
|
|
shouldExclude = true
|
|
}
|
|
})
|
|
|
|
// Extract the file.
|
|
if(!shouldExclude){
|
|
fs.writeFile(path.join(tempNativePath, fileName), zipEntries[i].getData(), (err) => {
|
|
if(err){
|
|
console.error('Error while extracting native library:', err)
|
|
}
|
|
})
|
|
}
|
|
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return libs
|
|
}
|
|
|
|
/**
|
|
* Resolve the libraries declared by this server in order to add them to the classpath.
|
|
* This method will also check each enabled mod for libraries, as mods are permitted to
|
|
* declare libraries.
|
|
*
|
|
* @param {Array.<Object>} mods An array of enabled mods which will be launched with this process.
|
|
* @returns {Array.<string>} An array containing the paths of each library this server requires.
|
|
*/
|
|
_resolveServerLibraries(mods){
|
|
const mdles = this.server.modules
|
|
let libs = []
|
|
|
|
// Locate Forge/Libraries
|
|
for(let i=0; i<mdles.length; i++){
|
|
if(mdles[i].type != null && (mdles[i].type === 'forge-hosted' || mdles[i].type === 'library')){
|
|
let lib = mdles[i]
|
|
libs.push(path.join(this.libPath, lib.artifact.path == null ? AssetGuard._resolvePath(lib.id, lib.artifact.extension) : lib.artifact.path))
|
|
if(lib.sub_modules != null){
|
|
const res = this._resolveModuleLibraries(lib)
|
|
if(res.length > 0){
|
|
libs = libs.concat(res)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
//Check for any libraries in our mod list.
|
|
for(let i=0; i<mods.length; i++){
|
|
if(mods.sub_modules != null){
|
|
const res = this._resolveModuleLibraries(mods[i])
|
|
if(res.length > 0){
|
|
libs = libs.concat(res)
|
|
}
|
|
}
|
|
}
|
|
|
|
return libs
|
|
}
|
|
|
|
/**
|
|
* Recursively resolve the path of each library required by this module.
|
|
*
|
|
* @param {Object} mdle A module object from the server distro index.
|
|
* @returns {Array.<string>} An array containing the paths of each library this module requires.
|
|
*/
|
|
_resolveModuleLibraries(mdle){
|
|
if(mdle.sub_modules == null){
|
|
return []
|
|
}
|
|
let libs = []
|
|
for(let i=0; i<mdle.sub_modules.length; i++){
|
|
const sm = mdle.sub_modules[i]
|
|
if(sm.type != null && sm.type == 'library'){
|
|
libs.push(path.join(this.libPath, sm.artifact.path == null ? AssetGuard._resolvePath(sm.id, sm.artifact.extension) : sm.artifact.path))
|
|
}
|
|
// If this module has submodules, we need to resolve the libraries for those.
|
|
// To avoid unnecessary recursive calls, base case is checked here.
|
|
if(mdle.sub_modules != null){
|
|
const res = this._resolveModuleLibraries(sm)
|
|
if(res.length > 0){
|
|
libs = libs.concat(res)
|
|
}
|
|
}
|
|
}
|
|
return libs
|
|
}
|
|
}
|
|
|
|
module.exports = ProcessBuilder |