Setup the project

Setup a Salty Engine project

To get a usable JAR of this library, you can whether download an existing release here or build one yourself following these instructions:

1. Clone (download) the git repository. To do so, open up the terminal or cmd, go to any directory and type in

   git clone https://github.com/edgelord314/salty-engine

   Of course, git has to be installed properly.

2. "cd" into the downloaded directory. Type

   cd salty-engine

   into the cmd or terminal

3. Build the project using the maven wrapper (no installation required). For windows, type the following into the cmd

   mvnw clean install

   For Linux/macOs type the following into the terminal:

   ./mvnw clean install

4. You can now whether use maven to get the lib into the build path of your project (recommended) or use the built JAR directly. For maven, add the following to your pom.xml:

   <dependencies>
        <dependency>
            <groupId>de.edgelord.salty-engine</groupId>
            <artifactId>salty-engine</artifactId>
            <version>[the version you built in step 3]</version>
        </dependency>
    </dependencies>

   When you build the project as described in step 3, something like this should appear somewhere at the beggining of the output:

   [INFO] ---------------< de.edgelord.salty-engine:salty-engine >----------------
   [INFO] Building Salty Engine [the version is here ("-SNAPSHOT" is important!)]
   [INFO] --------------------------------[ jar ]---------------------------------
   

   Or you copy the JAR target/salty-engine-[version]-jar-with-dependencies.jar relative to the directory of the cloned project and add it to the buildpath manually using e.g. your IDE.