Skip to content
This repository was archived by the owner on Sep 11, 2019. It is now read-only.

How to build all this?

Shadow Raven edited this page Apr 23, 2016 · 7 revisions

How to build

Windows

What do I need?

The Java Development Kit

Building software means compiling. That means, you need a compiler. As for Java, this means you will need the Java Development Kit. You can get either The Oracle one or The OpenJDK

Which one you actually get doesn't really matter. It's more important to get one and only one of them. Install it. You may or may not want to set the JAVA_HOME variable. You do it like this:

  • Press WINDOWS + PAUSE (The "System" frame should open)
  • Click on "Advanced System Settings"
  • Open the "Environment Variables" window
  • Add a new variable called JAVA_HOME
  • As a value, put in the absolute path to your Java Development Kit (feel free to stop here and google what an absolute path is)
  • At this point, you will have to relog (i.e. log out of windows and log in again; And yes - you have to)
  • Well, you now have your Java Development Kit installed. Congratulations!

Maven

This project uses the wonderful Apache Maven project. This means:

  • No need to manage dependencies (yeah, like that's going to happen)
  • No need to take care of all that building and compile stuff (kinda happening) So, what do you have to do. There are the things:
  • Click this
  • Download the "Binary (zip/tar.gz) archive" - You don't want the source archive
  • Move the archive to some place where it can stay for a really long time.
  • Unpack the archive to that place
  • Open the new directory and enter the bin directory
  • Remember the exact location (i.e. the absolute path) of that place and/or copy and paste it somewhere.
  • Press WINDOWS + PAUSE (The "System" frame should open)
  • Click on "Advanced System Settings"
  • Open the "Environment Variables" window
  • There is a System variable called "path". It is very important that you get this right:
  • Click on the "Path" variable and click "Edit..."
  • Add a semicolon ( It's this: ; ) to the end of the value and paste the absolute path to the end of it.
  • Relog again (i.e. log out from windows and log in again)

All the Dependencies

The most important dependency is the spigot jar. Look at this: https://github.com/Static-Interface/Sink-Plugins/blob/master/SinkLibrary/pom.xml This is the pom.xml of the SinkLibrary project. Take a look at the dependencies. One of it says "<systemPath>${main.basedir}/libs/spigot-number.number.number.jar</systemPath>". This is the crucial part of what you are going to do.

  • Get the spigot build tools here
  • Follow the instructions of the build tool
  • Build the thing
  • Done.

What now???

  • Download the source zip of this plugin here
  • Put it somewhere you want
  • Unpack the zip
  • Open the Command Line in that place (SHIFT + Right Click in the directory -> open CMD [or something])
  • Enter dir
  • There must be a pom.xml
  • Copy the previously created spigot.jar
  • Copy it to the libs subdirectory
  • Rename it to the spigot-number.number.number.jar you have created before
  • Execute mvn clean compile package
  • Wait for it to end
  • Hope for it to end with a Build Success
  • If it doesn't, ask for help here
  • If it does, enter cd jars
  • Enter dir
  • The lucky one of you now has all the jars from SinkLibrary over SinkIRC to SinkChat

Linux

Hopefully soon to be

Mac

Probably never to be