Skip to content

Getting started

Jump to bottom
Nico edited this page Aug 31, 2021 · 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 or Velocity server is as easy as installing other plugins. Just drop the protocolize-.jar into your plugins folder.

Build Tools

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

<repository>
 <id>exceptionflug</id>  
 <url>https://mvn.exceptionflug.de/repository/exceptionflug-public/</url>  
</repository>
<dependency>
  <groupId>dev.simplix</groupId>
  <artifactId>protocolize-api</artifactId>
  <version>${protocolize.version}</version>
  <scope>provided</scope>
</dependency>

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

Plugin dependency

On BungeeCord, you have to add Protocolize to the depends array in your plugin description file. If you are using Velocity, be sure to add protocolize as dependency property to the @Plugin annotation.

Clone this wiki locally