[Project Tutorial] How to build the project yourself

How to build the project yourself

This a free and open-source software; This GitHub. You can download, make changes, build the project yourself and either use privately or publish it to the public. You're free.

Requirements

• First, install the JDK 8 from the official Oracle site.
• Second, install the latest git version from the official Git site.
• Third, install the latest maven 3 from the official Apache Maven site.

Maven does not have an installer for Windows. Download the binary zip archive and extract it to C:/Program Files/apache-maven-VERSION folder. The VERSION should be like 3.6.0 or 3.6.1 etc.

After extraction, set up environment variables. Refer to this article for how to setup the environment variables for the apache maven.

Make sure to set up the environment variables correctly by entering "mvn -version" (without quotes) to the command prompt. If it gives an error like "... is not recognized as an internal or external command, operable program or batch file" you are not correctly setup maven.

Cloning the project

First, select a directory that the project contains. Do not create a special folder for the project; it already creates a folder named "LifeSkript", so you can even use the desktop.

Second, Right-click to air in selected folder (or desktop) and select "Git Bash Here" or open an elevated command prompt.

Third, enter the command "git clone https://github.com/LifeMC/LifeSkript.git" and wait for it to complete. After it's complete, close the command prompt.

Making changes and building the project

If you don't plan to make your local changes or using an unreleased nightly build from recent commits; we recommend you to download a pre-built JAR file from the releases page.

If you are sure; then just make your local changes or if you just want to build the project yourself (e.g: for building - and using - an unreleased nightly build from recent commits) then continue to next step without changing anything.

For building the project and get the final JAR file, you can run the build project shortcut on the LifeSkript project root folder. Click two times to file for starting the build. If you set up the maven correctly, the build will start. Unless some of the repositories are down or the project is heavily abandoned, the build will complete successfully after a short period of time.

After the completion of the build, press enter to close the window. Then just open the target folder in the LifeSkript project root folder and copy the Skript.jar JAR file to your servers plugins directory and you should be fine.

If you are failing in some step

If you're failing (e.g getting errors) with exactly following this tutorial, then this tutorial is probably outdated or you're just downloaded wrong versions, setup the maven incorrectly, or the repositories are down.

If you're reading this from the future, or just failing many times trying to build the project yourself via exactly following this tutorial:

• First, check the status of the project. I might decide to abandon or not continue to this project or simply I don't have time for it.

• Second, search the error you get in Google. Since we're using popular libraries, it should be others having your problem.

• Third, unless you are stick to old versions like 1.7 or 1.8, decide to use another Skript fork, like bensku's fork.