Skip to content

Latest commit

 

History

History
73 lines (42 loc) · 3.5 KB

PACKAGING.md

File metadata and controls

73 lines (42 loc) · 3.5 KB

🎁 Santulator Packaging

If you'd like to build an installable bundle of Santulator for Mac, Linux or Windows, just like those you can find on the Santulator download page then follow these instructions. These installers are self-contained files that have everything the user will need to run Santulator without the need to, for example, install Java separately.

Preparing your Build Environment

JDK 11

You will need to install JDK 11 to build the installable bundle of Santulator. The version provided by AdoptOpenJDK is an excellent choice for this.

Java Packager

Download the Java Packager. Choose the right link for your platform from those listed on this page. Note that this is an early access version of the Java Packager, made available for JDK 11 while JEP 343 is being developed.

For Mac and Linux, unpack the zip file store the directory somewhere on your system. For Windows, copy the two files into the following directories:

File Destination Directory
jpackager.exe %JAVA_HOME%\bin
jdk.packager.jar %JAVA_HOME%\jmods

Windows: Inno Setup

The Windows build procedure requires Inno Setup. Download and install this software on your PC.

Windows: Extra DLLs

You need the files MSVCP140.dll & VCRUNTIME140.dll installed in C:\Windows\System32. To do this, simply download and install vc_redist.x64.exe from Microsoft.

For some background on this, see issue #5.

Creating the Installable Bundle

Mac & Linux: Creating the Bundle

Assuming that you have installed the Java Packager into /opt/jpackager-11/, you can run the following command to create the installable bundle:

$ ./gradlew clean createBundle -PjavaPackagerPath=/opt/jpackager-11

You will find the created installable bundle in the directory package/build/bundle.

Windows: Creating the Bundle

Windows: Running the Java Packager

You can run the following command to create the installable bundle:

gradlew clean createBundle

Windows: Running Inno Setup

When you run Java Packager as described in the previous step, you will see a line such as the following near the end of the console output:

Inno Setup file: C:\repositories\Santulator\package\build\resources\main\application.iss

Open this file in Inno Setup. Go to the "Build" menu and select "Compile". Once this has completed you will find a directory Output at the same level as the application.iss file containing the Windows Installation bundle.

Using the Java Packager with JDK 11

Using the Java Packager with JDK 11

For more general information about the approach taken to building the installable bundles for Mac, Linux and Windows and how you could apply this in your own project, see the article Using the Java Packager with JDK 11.

Return to Santulator README

Click here to return to the main Santulator README file for more information about the project.