MapZip Installer

Simplistic command-line map installer for Java Minecraft map-makers.

Last updated Febuary 4th, 2018 - Current application version 1.3.0.1

What's it for?

Alot of people would rather not mess around with moving files about, so in a effort to make their lives easier, I made this simple installer. Two clicks and installed! This also saves alot of troubleshooting time for mapmakers as well. Simply pack your map and resources, build, and bam, instant installer! Plus, it also offers basic plugging with options for multiple authors, custom version tagging and opening web links after install and uninstall. Wait...uninstall? Yes, it does that too (under development at this moment)! A two click uninstaller is customary with every install.

Use Instructions

Quick & Simple

Navigate to the Data\ directory of the solution.
Create or edit the existing data files as described below.
Double-click the batch file named BUILD.bat.
Your new installer will be in the Output\ folder.

Advanced

Navigate to the Data\ directory of the solution.
Create or edit the existing data files as described below.
Double-click the Visual Studio .sln solution file and open it.
If you want to edit the application, please first run nugetrestore.bat to redownload depencencies. The solution is laid out like so:
- mzinstaller - the installer that parses the data and extracts the map to the game directory.
- mzwrapper - the wrapping executable that contains the installer allowing for a one-executable installer file. Please note, the solution is setup to automatically wrap the installer when you build the solution, so you don't have to worry about it.
- If you want to translate the console messages, open the Properties page and click Settings.
Once any changes have been made, you can build the entire solution.
Your new installer will be in the Output\ folder.

Requirements

Map-maker requirements

Windows 7+
Microsoft .NET 4.5.2+ Redistributable package (download here).
Visual Studio Community 15.0+ (download here) with Visual C#.
A file archiver with .zip support.

End-user requirements

Windows 7+
Microsoft .NET 4.5.2+ Redistributable package (download page).
Has opened the Minecraft 2.0 launcher at least once (homepage).

Command-line arguments

Argument	Description	Value type
`-d, --debug`	Shows debug level output	Bool
`-s. --silent`	Bypass confirmation messages and do not print to console.	Bool
`-u, --uninstall`	Uninstall the associated world from the game. Not implemented	Bool
`-h, --help`	Argument usage message.	Bool

Installer data

The data files, by default, are template examples. Please view these for refrence.

config.txt - Global configuration of the installer. Configuration values:

Name	Description	Value Type
`layoutVersion`	You can ignore this. Simply layout version management.	Integer
`authors`	The names of the creators of the map.	Array
`friendlyName`	The pretty, formatted name of the map and profile.	String
`gameVersion`	What version of the game you want to be used for the map.	String
`mapVersion`	Add your own version control for your map.	String
`internalName`	The internal name of the map, no spaces or special characters.	String
`profileIcon`	The icon of the game. To view possible values, use the launcher.	String
`showWebpages`	If true, the installer will open the webpage specified after install.	Boolean
`webpageInstalled`	The webpage to open upon installation.	String
`webpageUninstalled`	The webpage to open upon uninstallation.	String

profile.zip - You create this part. Within it is the same folder layout as the .minecraft directory, place your maps resources within this zip.

Troubleshooting

Please report any build issues, or issues in general about this application to the author and/or the issue tracker.

Goals

Make the installer completely functional.
Make the solution easy to use for inexperienced users.
Make the installer one file.
Add command line support.
Make the command line messages easily translatable.
Add uninstaller to the installed profile path.!
Add log file capabilities.

Complete Changelog

Version	Date released	Changes
1.1.0.0 (Ext. Archive)	N/A	First stable (non-published) release.
1.2.0.0	N/A	Removed licence text system as it can be implemented within the map. Changed configuration to JSON syntaxing. Made two webpage definitions, one for install and one for uninstall. Fixed read-key continuing application instead of exiting. Fixed file overwriting exception by moving the temporary folder to the executing directory of the installer. Made the wrapper shell delete the temp directory. Moved all command-line message strings to project settings for easy translations. Removed other `.bat` files implace for internal pre/post-build events.
1.2.0.1	1/12/2018	Added error catch to wrapper if executable not found. Added error catch if configuration file is missing. Reformatted argument error message.
1.2.0.2	1/16/2018	Cleaned up unused methods in wrapper. Made temp folder hidden. Added a touch of coloring to the installer command line.
1.3.0.0	1/17/2018	Added manifest file in preparation for uninstaller. All message strings are translatable via the solutions Settings file. Added schema-type structure to the JSON file layouts. Fixed some misc. unhandled errors and batch files paths.
1.3.0.1	2/4/2018	Fixed manifest and launcher file profile duplication. Overhauled JSON serialization proccess. Overhauled logging system including new message levels. Abstracted argument parser. Fixed having more than one wrapper open crashing it.

Author & Legal Stuff

MapZip Installer created by Jacob Jewett (website, twitter).

THIS SOFTWARE IS DISTRIBUTED "AS IS" UNDER NO FORM OF WARENTY OR LIABILITY TO THE ORIGINAL AUTHOR.

This application and the author are NOT in any way affiliated with MOJANG AB. and their associates.

InstanceGaming/Mapzip