Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2025-02-16 12:21:39 +01:00
Code Issues Projects Releases Wiki Activity

Updated Project Setup (markdown)

Rsl1122 2018-01-22 12:19:33 +02:00
parent cf767eb1d9
commit bfcb121730
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Project-Setup.md

@ -1,8 +1,26 @@
![Plan Header](https://puu.sh/vQyow.jpg)
# Project Set-Up
## 1. Clone the github repository.
## 2. Install some artifacts manually
> Changes are underway to allow easier set up for the project, as currently the set up can get tricky. These changes will be merged to `master`-branch when 4.2.0 comes live.
## After 4.2.0
### Fork the Plan repository & Clone that repository to your workstation.
Here is a [Tutorial](https://help.github.com/articles/fork-a-repo/).
### 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.
- 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.
## Before 4.2.0
### 1. Fork & Clone the github repository.
### 2. Install some artifacts manually
Currently no Private Maven Repository is available so some artifacts need to be installed manually.
- [Latest PaperSpigot](https://yivesmirror.com/downloads/paperspigot)