Skip to content

Building a release file

Tyler Flowers edited this page Jun 16, 2019 · 6 revisions

If you want to use the latest version, you can build a file yourself using an IDE of your choice. These builds are not guaranteed to be bug-proof or complete, however.

Table of Contents

Downloading prerequisites

How to build

How to convert to EXE

How to launch

Downloading prerequisites

Download the latest commit by going to the home page of the github, pressing the green button that says "Clone or download", and press "Download ZIP"

An image showing how to download the latest commit.

You'll also need the SwingX library, which can be downloaded here. Make sure you download the jar.

NOTE: The specific version used is 1.6.4

NOTE: You do not need this if you're building in IntelliJ IDEA.

An image showing how to download SwingX

If you don't already have Java, you'll also need to download the JDK and JRE. The version used by KAaNE [JE] is version 1.8.0.

How to build

The specific method differs between IDE's. Click on the IDE you're using to get specific instructions.

BlueJ

WIP

DrJava

WIP

Eclipse JDT

WIP

Geany

WIP

Greenfoot

WIP

IntelliJ IDEA

  1. Extract the ZIP file to a folder

  2. Open the folder in IntelliJ

An image showing the open option.

  1. Select Build artifacts...

An image showing the "Build Artifacts" option.

  1. Select KAaNE.jar > Build

An image showing the build option

  1. Wait for a bit for it to build

  2. You're done! The output is in out/artifacts/KAaNE_jar

JBuilder

WIP

JCreator

WIP

JDeveloper

WIP

jGRASP

WIP

MyEclipse

WIP

Netbeans

WIP

Rational Application Builder

WIP

Servoy

WIP

SlickEdit

WIP

Understand

WIP

XCode

WIP

How to convert to EXE

If you prefer to have an EXE file instead of a JAR file, download Launch4j here.

If you don't know how to use Launch4j, follow these instructions:

  1. Select the path where your jar file is.

  2. Select a folder to place your exe file in and make a filename.

  3. Label the bundled JRE path as 'jre'

It should now look like the following:

Click to show

An image showing how the "Basic" panel in Launch4J should look like.

An image showing how the "JRE" panel in Launch4J should look like.

  1. Press the gear button.

  2. If you get a prompt to save a file, save it to wherever (This is your configuration file if you ever need it)

  3. If it says Successfully created (path name), then you've done it correctly and you now have an EXE file.

How to launch

You can launch the EXE or JAR file by itself, however it will most likely break (It depends on the config file and images)

In order to get the dependencies, follow this:

  1. Move the EXE/JAR file to a different location (this will be your release folder)

  2. From the project folder, copy the "imgs" folder and "config.properties" file

  3. Paste them into your release folder

If your folder looks like this, you've done it correctly.

An image showing how a release folder should look like.

If you're also bundling a JRE with the EXE file, make sure to copy and paste your JRE to the release folder. You can find it at C:\Program Files\Java\jre(version#) on Windows. You'll also need to rename that folder to "jre".

An image showing a full release folder, including a bundled JRE and EXE file.

General Usage


Installation and Proper Usage

Building a release file

Bomb Settings

Vanilla Modules


Click to show

Wires

The Button

Keypads

Simon Says

Who's on First

Modded Modules


Click to show

Currently, no mod pages are done. Come back later, or help make them.

Custom Mods


Modloading: Simple Usage

Modloading: Layout

Modloading: Edgework

Modloading: Compiling and Releasing

How to help


On the Wiki

On coding

Legal information


Credits

Licensing

Clone this wiki locally