diff --git a/Project-Setup.md b/Project-Setup.md index 00000ea..0222610 100644 --- a/Project-Setup.md +++ b/Project-Setup.md @@ -1,7 +1,7 @@ ![Plan Header](http://puu.sh/AXSg7/5f2f78c06c.jpg) # Project Set-Up -Page version: **4.6.0** +Page version: **4.8.1** 1. Fork the Plan repository & Clone that repository to your workstation. Here is a [Tutorial](https://help.github.com/articles/fork-a-repo/). @@ -13,10 +13,12 @@ If you're having issues join [Discord](discord.gg/yXKmjzT) or open an issue and ## Building -The project is split into 6 modules. +The project is split into 8 modules. Module | Description -- | -- +`api` | Easily available API that is distributed via a maven repository +`extension` | Module for registering built in extensions that use DataExtension API `common` | System related abstractions and main logic is in this package. Most work is done here. `bukkit` | Bukkit/Spigot/Paper related classes `bungee` | BungeeCord related classes @@ -47,6 +49,10 @@ To run CheckStyle checks run gradle checkstyleMain checkstyleTest ``` +> **Maven Local Dependencies** +> `mavenLocal()` is not included in the repositories of main build.gradle. +> If you need locally installed dependencies, add it to the main build.gradle for test builds. + # PlanPluginBridge Project Setup > **IMPORTANT**