Installation

Installation - User guide

TODO

Installation - Developer guide

In order to install the UHCGDK to develop with, you can use the following command :

git clone https://github.com/Noradrenalin-Developement/Minecraft-UHCGDK

After this, you should be found with a new folder named Minecraft-UHCGDK where there’s the source code of the GDK

To check if the installation you’ve got works properly, try to run the following command :

cd Minecraft-UHCGDK         # Moving inside the source code folder
./gradlew :UHCGDK:shadowJar # Building the UHCGDK from source as a JAR file

You should find the built jar UHCGDK.jar in the artifacts/ folder at the root of the repository :

DirectoryMinecraft-UHCGDK/
- Directory.gradle/
  - …
- Directory.idea/
  - …
- Directory.kotlin/
  - …
- Directoryartifacts/
  - UHCGDK.jar — This is the built JAR file
- Directorybuild/
  - …
- DirectorybuildSrc/
  - …
- Directorydocs/
  - …
- Directoryexamples/
  - …
- Directorygradle/
  - …
- DirectoryUHCGDK/
  - …
- .env.template
- .gitattributes
- .gitignore
- gradle.properties
- gradlew
- gradlew.bat
- LICENSE.md
- README.md
- settings.gradle.kts

If this file is built properly, then you’re good to go !

You can change the build task output directory by copying the .env.template file to .env :

DirectoryMinecraft-UHCGDK/
- …
- .env
- .env.template
- …

And change the PLUGINS_DIRECTORY environment variable. For instance, on my machine, it’s configured as such :

PLUGINS_DIRECTORY="/home/altaks/Documents/dev/minecraft/servers/1.8.8/plugins"

To build the GDK, there are two options :

./gradlew :UHCGDK:shadowJar # Build FAT jar containing dependencies - recommended
./gradlew :UHCGDK:jar       # Build jar without packing dependencies

To format the source code, you can use the following command :

./gradlew :UHCGDK:ktlintFormat # Formats kotlin & gradle config files

To run unit & integration tests of the GDK :

./gradlew :UHCGDK:test