Project Setup

Project Set-Up

Fork the Plan repository & Clone that repository to your workstation.

Here is a Tutorial.

Run Maven install goal for PlanPluginBridge

• Locate PlanPluginBridge.jar in the repository you just cloned. It is in <repository-root>/PlanPluginBridge/-folder.
• Run a Maven goal: mvn install:install-file -Dfile=<path-to-PlanPluginBridge.jar>
  This will install the plugin bridge into your local maven repository. The PluginBridge is a separate jar in order to reduce the dependencies that are required to work on the project.
  You can check .travis.yml for up to date install command
• Rest of the dependencies should be downloaded automatically and you can start working on the project.

Depending on your IDE there might be additional requirements to work on a Maven project. Check the IDE documentation on how to open a Maven project if you're having trouble.

Possible Help

• PlanPluginBridge (jar Included in the Github repo)

• Abstract Plugin Framework (If not in Maven Central APF can be compiled with no extra dependencies)

Installing 3rd party Maven artifacts manually

Other artifacts should exist in either Maven Central Repository or BungeeCord repository and will be downloaded automatically.

If you're having issues join Discord and I'll try to help you out.

PlanPluginBridge Project Setup

IMPORTANT

This is not required to work on Plan, and is only required if you want to change things inside PlanPluginBridge

Since PlanPluginBridge uses a collection of other plugins, some of them can not be found in any maven repositories.

I have made a .bat script (Windows) for installing the required dependencies once you have obtained them.

• install_dependencies.bat

Here is a list of dependencies required to run the install script - The install script uses the names listed (with a .jar file format) in the same folder the script is located in.

x--------------------------------------------------x
|                                                  |
|   Plan Plugin Bridge Dependency download links   |
|                     4.4.5                        |
x--------------------------------------------------x

AAC-3.5.0-b1
Requires a copy of AAC.
https://www.spigotmc.org/resources/aac-advanced-anti-cheat-hack-kill-aura-blocker.6442/

AdvancedAchievements
In Maven Repository

AdvancedBan-2.1.5
https://www.spigotmc.org/resources/advancedban.8695/

ASkyBlock-3.0.9.4
https://www.spigotmc.org/resources/askyblock.1220/

BanManager-5.15.4
https://www.spigotmc.org/resources/banmanager.21927/

EssentialsX-2.15.0.1
https://www.spigotmc.org/resources/essentialsx.9089/

Factions-2.14.0
MassiveCore-2.14.0
https://www.spigotmc.org/resources/factions.1900/

GriefPrevention-16.8
In Maven Repository
https://github.com/TechFortress/GriefPrevention/releases/

GriefPreventionPlus-13.3
https://github.com/KaiKikuchi/GriefPreventionPlus/releases

Jobs4.7.4
https://www.spigotmc.org/resources/jobs-reborn.4216/

Kingdoms-13.3.40 (Demo)
https://www.spigotmc.org/resources/kingdoms-plugin-demo.6392/

LiteBansAPI-0.3
https://github.com/ruany/LiteBansAPI/releases

mcMMO-1.6.0-SNAPSHOT
https://popicraft.net/jenkins/job/mcMMO/

PlaceholderAPI
In Maven repository

ProtocolSupport-4.28
https://www.spigotmc.org/resources/protocolsupport.7201/

RedProtect-7.6.3
In Maven Repository

SuperbVote-0.5.3
https://www.spigotmc.org/resources/superbvote.11626/

Towny-0.92.0.0
http://towny.palmergames.com/

Vault-1.5.6
In Maven Repository
https://www.spigotmc.org/resources/vault.34315/updates

ViaVersion-1.5.0
In Maven Repository

React-6.573
Requires a copy of React
https://www.spigotmc.org/resources/react-smart-server-performance.21057/