Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2024-11-22 02:25:34 +01:00
Code Issues Projects Releases Wiki Activity

Updated Project Setup (markdown)

Rsl1122 2018-02-19 18:51:49 +02:00
parent f5dd0c0095
commit eac5278597
1 changed files with 5 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Project-Setup.md

@ -3,13 +3,11 @@
> AbstractPluginFramework 3.1.1 has not been deployed to Maven Central yet, but will in a couple days.
## After 4.2.0
### Fork the Plan repository & Clone that repository to your workstation.
## 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
## 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.
@ -17,20 +15,14 @@ Here is a [Tutorial](https://help.github.com/articles/fork-a-repo/).
> 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)
## Possible Help
- [PlanPluginBridge](https://github.com/Rsl1122/Plan-PlayerAnalytics/tree/master/PlanPluginBridge) (jar Included in the Github repo)
- [Abstract Plugin Framework](https://github.com/Rsl1122/Abstract-Plugin-Framework/releases/)
- [Abstract Plugin Framework](https://github.com/Rsl1122/Abstract-Plugin-Framework/) (If not in Maven Central APF can be compiled with no extra dependencies)
[Installing 3rd party Maven artifacts manually](https://maven.apache.org/guides/mini/guide-3rd-party-jars-local.html)
Other artifacts should exist in either Maven Central Repository or BungeeCord repository and will be downloaded automatically.
If you're having issues join the discord and I'll try to help you out.
If you're having issues join [Discord](discord.gg/yXKmjzT) and I'll try to help you out.