prismarinejs / node-minecraft-wrap

Download and wrap the vanilla minecraft server and client in node.js

minecraft wrap

Download and wrap the vanilla minecraft server and client in node.js.

Install

To install a downloadMinecraft and a runMinecraft command line programs, run:

npm install -g minecraft-wrap

Usage

downloadMinecraft 1.8.8 1.8.8.jar server
runMinecraft [<minecraft dir>] [<version>] [<username>] [<password>] [<stop>]

See examples

API

download(minecraftVersion,filename,done)

download the vanilla server of version minecraftVersion jar file at filename.

It checks with a md5 hash that the file downloaded is correct and it doesn't download it if the destination file is already the correct file.

downloadClient(minecraftVersion,filename,done)

download the vanilla client of version minecraftVersion jar file at filename.

downloadBedrockServer(os, version, outputPath, suffixVersion)

os: 'win' | 'linux' version: valid bedrock version (ie: '1.16.220') outputPath: name of folder to extract server to suffixVersion: the name of the outputFolder will be suffixed to the end of the folder name, ie: output to output1.16.220

download + unzip the bedrock server

new WrapServer(MC_SERVER_JAR,MC_SERVER_PATH[,OPTIONS])

initialize a wrapper with jar MC_SERVER_JAR, store mc server file at MC_SERVER_PATH

OPTIONS is an object containing the following optional properties:

• minMem : the minimum memory allocated to the minecraft server, default to 512
• maxMem : the maximum memory allocated to the minecraft server, default to 512
• doneRegex : the regex to check for the server message announcing the server has started, default to new RegExp(/\[Server thread\/INFO\]: Done/)
• noOverride : don't override config files
• javaPath : specify path to a java executable to use, by default it's just java

WrapServer.startServer(propOverrides, done)

start the minecraft server with properties overrides propOverrides. Calls done when the server is started.

WrapServer.stopServer(done)

stop the minecraft server, calls done when the server is stopped.

WrapServer.deleteServerData(done)

delete the minecraft server data.

WrapServer.writeServer(line)

write line to the server.

"line" (line)

the Wrap instance emit that event when the server write a line

new WrapClient(clientPath,version)

create a client wrapper instance

• using clientPath as minecraft directory (or the default os specific path if undefined)
• with minecraft version version (or the version of the selected profile if undefined)

WrapClient.prepare()

prepare all the files requires for the minecraft client in the minecraft directory.

return a promise

WrapClient.auth(username,password)

authenticate the user using username and password. If these parameters are undefined, the selected user in the profile is used

return a promise

WrapClient.setAuthInfo(playerName,uuid,accessToken,userProperties)

set the authentication information directly without contacting the mojang servers. playerName, uuid, accessToken and userProperties need to be provided.

WrapClient.start()

start the client

return a promise that is resolved when the client is properly started

WrapClient.stop()

stop the client

return a promise that is resolved when the client is stopped

new LauncherDownload(mcPath,os="linux")

create a launcher downloader with mcPath as minecraft directory path

LauncherDownload.getWholeClient(version)

get the client jar, the assets, the libraries and extract the native libraries for the version version. return an object of arrays of the paths of the downloaded files

LauncherDownload.getVersionsList()

get and return a promise of the version list

LauncherDownload.getVersionInfos(version)

get and save the version infos and return a promise of it

LauncherDownload.getAssetIndex(version)

get and save the asset index and return a promise of it

LauncherDownload.getAllAssets(version)

get all the assets, save them and return a promise of an array of the paths

LauncherDownload.getAsset(assetFile,version)

get the asset assetFile, save it and return a promise of its path

LauncherDownload.getClient(version, [path])

get the client jar, save it and return return a promise of its path

LauncherDownload.getServer(version, [path])

get the server jar, save it and return return a promise of its path

LauncherDownload.extractNatives(version)

extract the natives files and return a promise to the path of the dir

LauncherDownload.getLibraries(version)

get all the libraries, save them and return a promise of an array of the paths

Testing

The MC_SERVER_JAR environment variable must be defined and point the .jar location before calling npm test.

node-minecraft-wrap's Issues

stop server error

........Server Started !
...[11:42:07] [Server thread/INFO]: Stopping the server
.[11:42:07] [Server thread/INFO]: Stopping server
.[11:42:07] [Server thread/INFO]: Saving players
.[11:42:07] [Server thread/INFO]: Saving worlds
.[11:42:07] [Server thread/INFO]: Saving chunks for level 'world'/Overworld
.[11:42:07] [Server thread/INFO]: Saving chunks for level 'world'/Nether
.[11:42:07] [Server thread/INFO]: Saving chunks for level 'world'/The End
.[11:42:07] [Server Shutdown Thread/INFO]: Stopping server
.[11:42:07] [Server Shutdown Thread/INFO]: Saving players
.2015-09-25 11:42:07,354 ERROR Attempted to append to non-started appender ServerGuiConsole
.Exception in thread "Server Shutdown Thread" org.apache.logging.log4j.core.appender.AppenderLoggingException: Attempted to append to non-started appender ServerGuiConsole
. at org.apache.logging.log4j.core.config.AppenderControl.callAppender(AppenderControl.java:89)
. at org.apache.logging.log4j.core.config.LoggerConfig.callAppenders(LoggerConfig.java:425)
. at org.apache.logging.log4j.core.config.LoggerConfig.log(LoggerConfig.java:406)
. at org.apache.logging.log4j.core.config.LoggerConfig.log(LoggerConfig.java:367)
. at org.apache.logging.log4j.core.Logger.log(Logger.java:110)
. at org.apache.logging.log4j.spi.AbstractLogger.info(AbstractLogger.java:1011)
. at net.minecraft.server.MinecraftServer.t(SourceFile:381)
. at net.minecraft.server.MinecraftServer$2.run(SourceFile:715)
Server Stopped !
Server data deleted !

Server JAR file check is in wrong location

In lib/wrap_server.js on line 95, it checks to see if the server JAR file exists, but it is checking in the directory that this Node application is running from. On line 109, you set the CWD to the directory where the rest of the server files are, so it needs the JAR file to be there. The check on line 95 should check to see if it exists in that directory instead.

Internal issue

I keep on getting this error:
events.js:291
throw er; // Unhandled 'error' event
^
Error: spawn java ENOENT
at Process.ChildProcess._handle.onexit (internal/child_process.js:268:19)
at onErrorNT (internal/child_process.js:464:16)
at processTicksAndRejections (internal/process/task_queues.js:80:21)
Emitted 'error' event on ChildProcess instance at:
at Process.ChildProcess._handle.onexit (internal/child_process.js:274:12)
at onErrorNT (internal/child_process.js:464:16)
at processTicksAndRejections (internal/process/task_queues.js:80:21) {
errno: -2,
code: 'ENOENT',
syscall: 'spawn java',
path: 'java',
spawnargs: [
'-jar',
'-Xms1024M',
'-Xmx1024M',
'./minecraft/Server.jar',
'nogui'
]
}

Add an option to not overwrite config files if they exist ?

https://github.com/rom1504/node-minecraft-wrap/blob/master/lib/wrap.js#L113

Spigot support

Working with spigot should be quite similar to working with the vanilla client. Adding support for this can be done by downloading the latest BuildTools.jar file for the given Minecraft version, and running that file to do the download process. Afterwhich, running the server should be nearly identical to vanilla, correct?

wrap.writeServer() not working

I'm trying to use the writeServer() method but it doesn't seem to be working. mc.writeServer('list'); for example set on an interval does nothing.

http protocol causing failed downloads for 1.19.4

node-minecraft-wrap/lib/launcher_download.js

Line 86 in 39941e7

const url = 'http://resources.download.minecraft.net/' + subPath

Need to replace this with https. 1.19.4 fails to download assets files otherwise
Example of bad request:
http://resources.download.minecraft.net/cc/ccd7a059aeb60357337dfcc69b9434a977e5e9a8

Easy way to deal with logins (Access Tokens?)

Hey guys,

I've been building a client, but constantly logging in causes mojang to ban your account.
Is there a simple and easy way to do this via access tokens (which I read about at https://wiki.vg/Authentication).

I'm new to Node and JS in general, so a bit extra help would be extremely great.

Thanks in advance

How can I type command into server?

How can I type command into server CLI?
I try to type command directly or even use "writeServer" method but it doesn't seem to work.

Check the checksum in download.js

16:20 < unascribed> S3 itself supplies MD5 checksums in the ETag header IIRC, let me check
16:21 < unascribed> yep, ETag of 1.8.3 matches the md5sum of the file
16:22 < unascribed> so you can just pull it from the HTTP headers, make sure to strip the surrounding quotes

That way we can fix interrupted download.

Better find a standard node module to handle reading the ETag / checking it matches with the file.

Add errors when things are missing for the example wrap client

and consider named arguments (see minimist for example) instead of positional ones.

For example if no user is available, ask for user and password
if no profile is available, ask for version

and have a --help

Java classpath libraries are joined wrong for windows

node-minecraft-wrap/lib/wrap_client.js

Line 136 in 39941e7

const allLibrariesJar = this.libraries.join(':')

Java libraries for -cp arguments should be joined with ";" for windows

use launchermeta.mojang.com instead of s3

https://launchermeta.mojang.com/mc/game/version_manifest.json

see PrismarineJS/minecraft-data#185 (comment)

test client wrapper with more version

I only tested with 1.12
1.9 seems to work

however it seems 1.8 requires a user_properties parameter which the wrapper is not providing

tester with older versions too.

Add a test for the client wrapper

Will probably take at least 5 minute (to download all the assets)

Might require xvfb

Ram-Option

Right now it seems for me that this module has no way to select how much ram a client should use.
Could you add that?

Use robotjs to automate some more of the minecraft client

• log in to a given server automatically
• move around ?

See if 17w18b needs special support

or if it's just broken (likely) in the vanilla server like 17w15a

Downloading versions pre-1.2.5?

tmp $ downloadMinecraft 1.2.4
[Error: download failed : server responds with status 403]

is the error I get when I try to download anything before 1.2.5.

http://minecraft.gamepedia.com/Version_history

1.2.4, 1.2.3, 1.2.2, 1.2.1, 1.1, 1.0.1, 1.0.0, 1.0 also cannot download. Appears that 1.2.5 is the earlier version available through their AmazonAWS download site, so maybe not much node-minecraft-wrap can do here, short of some kind of patching service ala MCNostalgia. Curious how the official Minecraft launcher does it..

Make sure downloading the assets is as fast as it can be

Maybe the number of concurrent connections should be 1.
@timmyRS launcher takes 90s to get the assets

Can't find or load main class

I installed the module globally via yarn and executed:
downloadMinecraft 1.13.2 1.13.2.jar client
This worked just fine. Now I tried
runMinecraft ./ 1.13.2 <my username> <my password>
But after that the first time i get something like:

User logged in !
{ AssertionError [ERR_ASSERTION]: wrong size for C:\Users\derPi\Desktop\WrapTest\/assets/objects/d8/d859c9c5be04ffc41479b306814a933983eaa2     35
    at fs.stat.then.stats (C:\Users\derPi\AppData\Local\Yarn\Data\global\node_modules\minecraft-wrap\lib\launcher_download.js:182:45)
  generatedMessage: false,
  name: 'AssertionError [ERR_ASSERTION]',
  code: 'ERR_ASSERTION',
  actual: 23232,
  expected: 27101,
  operator: '==' }

And the second attempt:

User logged in !
Client prepared !
.Error: Could not find or load main class net.minecraft.client.main.Main
.Java HotSpot(TM) 64-Bit Server VM warning: Using incremental CMS is deprecated and will likely be removed in a future release

I don't know whats wrong here

named parameters for runMinecraft

--version --dir , ...
and a --help so I don't have to guess the name of parameters

Handle the vanilla client too

PrismarineJS/node-minecraft-protocol#281

move this to prismarinejs ?

Not sure why I didn't put it there.

WrapServer.writeServer(line) does not work on windows

Title. The java server does not seam to be able to receive any text written to it when using writeServer or when using the process.stdin.write directly.

Starting The Server

Hi. What is the "MC_SERVER_JAR" in new WrapServer(MC_SERVER_JAR,MC_SERVER_PATH[,OPTIONS]). I tried the path of the of the .jar file but it does not work. I also tried requiring the jar file but that also does not work. The error is:
/home/container/node_modules/minecraft-wrap/lib/wrap_server.js:80
Object.keys(propOverrides).forEach(prop => { props[prop] = propOverrides[prop] })
^
TypeError: Cannot convert undefined or null to object
at Function.keys (<anonymous>)
at WrapServer.startServer (/home/container/node_modules/minecraft-wrap/lib/wrap_server.js:80:12)
at Object.<anonymous> (/home/container/server.js:56:8)
So I am assuming it is an json object but where do you get it?

Why are we writing periods to stderr?

process.stderr.write('.'); appears on line 131 of lib/wrap_server.js. Why?

Error downloading 1.19 jar

When downloading the 1.19 jar file I'm running into the following error:

Error: download failed : wrong or partial file downloaded https://piston-meta.mojang.com/v1/packages/b03af5eb291163f7acc042d1553f2d212b220ecc/1.19.json <path>/minecraft-jar-extractor/versions/1.19/1.19.json
    at <path>/minecraft-jar-extractor/node_modules/minecraft-wrap/lib/etag_download.js:39:30
    at<path>/minecraft-jar-extractor/node_modules/minecraft-wrap/lib/etag_download.js:58:5
    at Hash.<anonymous> (<path>/minecraft-jar-extractor/node_modules/md5-file/index.js:38:5)
    at Object.onceWrapper (node:events:641:28)
    at Hash.emit (node:events:527:28)
    at emitReadable_ (node:internal/streams/readable:601:12)
    at onEofChunk (node:internal/streams/readable:579:5)
    at readableAddChunk (node:internal/streams/readable:275:5)
    at Hash.Readable.push (node:internal/streams/readable:234:10)
    at node:internal/streams/transform:126:12

Appears to be an issue with an updated etag headers that differs from the parsed md5 sum