Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.2 KB

INSTALL.adoc

File metadata and controls

40 lines (25 loc) · 1.2 KB

Installing

This file includes instructions on how to compile and install this tool.

Prerequisites

  • Java SDK version 15 or higher.

I can highly recommend Jabba for downloading and/or managing your java version.

You can also add the JDKs into your Toolchain file if you do not want to switch back and forth between JDKs.

Note: This is just a compile time dependency. The bytecode will be Java 15 compatible due to the use of the -release=15 switch.

Installing to your local repository

  • On Linux and MacOS:
    ./mvnw clean install

  • On Windows:
    mvnw.cmd clean install

If the installation was successful, you can now use this tool as described in the README.

Dependencies

Compile & Runtime dependencies

  • javafx

  • javafx metro theme

  • picocli for the CLI option parsing

  • Jackson for parsing the sprite library.

  • (soon): alttpj-library for creating your own sprites.

Test dependencies

This tool needs junit-jupiter and hamcrest-library for executing tests. Thus, you need those libraries installed or a working internet connection.