Skip to content

Getting started

Jump to bottom
Nico edited this page Oct 6, 2020 · 5 revisions

Getting started

In this page you will learn how you can start using Protocolize in your projects.

Installation

Installing Protocolize as a plugin on your BungeeCord server is as easy as installing other plugins. Just drop the protocolize-plugin.jar into your plugins folder.

Build Tools

At first you need to add the repository to your pom file (or your gradle build configuration).

<repository>
 <id>exceptionflug</id>  
 <url>https://mvn.exceptionflug.de/repository/exceptionflug-public/</url>  
</repository>

To get all available modules, you have to add all the following dependencies:

<dependency>
  <groupId>de.exceptionflug</groupId>
  <artifactId>protocolize-api</artifactId>
  <version>${protocolize.version}</version>
  <scope>provided</scope>
</dependency>
<dependency>
  <groupId>de.exceptionflug</groupId>
  <artifactId>protocolize-items</artifactId>
  <version>${protocolize.version}</version>
  <scope>provided</scope>
</dependency>
<dependency>
  <groupId>de.exceptionflug</groupId>
  <artifactId>protocolize-inventory</artifactId>
  <version>${protocolize.version}</version>
  <scope>provided</scope>
</dependency>
<dependency>
  <groupId>de.exceptionflug</groupId>
  <artifactId>protocolize-world</artifactId>
  <version>${protocolize.version}</version>
  <scope>provided</scope>
</dependency>

You can see the latest version on the README.md page.

plugin.yml

You have to add protocolize-plugin to the depends array in your plugin description file.

Clone this wiki locally