Skip to content

Installation

Tyler Bucher edited this page Sep 5, 2018 · 1 revision

Installing the WebGL Map (GLM) plugin

Note: The GLM plugin is currently only compatible with SpongeForge and SpongeVanilla.

Download or build the plugin jar

Downloading the plugin

  • You can download the latest pre-built plugin jar file form the sponge ore repository here

Building the plugin from source

Prerequisites: In order to build the plugin you need to have git and Java 8 installed, the stated applications might also need to be on the system path.
Note: If you do not have Gradle installed then use ./gradlew for Unix systems or Git Bash and gradlew.bat for Windows systems in place of any 'gradle' command.

  • Clone the project by use the git clone command in a terminal window. git clone https://github.com/WebGL-Map/Glm-Sponge.git or git clone git@github.com:WebGL-Map/Glm-Sponge.git
  • while in the terminal window change directories to the newly create directory. Should be called glm-sponge.
  • To build Glm-Sponge run the gradle shadowJar command from the same terminal window. The plugin jar will be outputted into the ./build/libs folder and will be labeled glm-x.x.x.jar

Installing the plugin

  • Drag and drop the plugin into the mods directory.
  • Initialize the plugin configuration file by starting then stopping the server.
  • Finish up by configuring the plugin to your needs.
    • The configuration file comments are still be a bit lacking at this point. Please visit the configuration section of the wiki to get more information about a specific section does.