mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2024-11-22 02:25:34 +01:00
Updated Project Setup (markdown)
parent
81f2e9a481
commit
cecc8c800d
@ -1,7 +1,9 @@
|
||||
![Plan Header](http://puu.sh/AXSg7/5f2f78c06c.jpg)
|
||||
# Project Set-Up
|
||||
|
||||
Page version: **5.1 build 791**
|
||||
Page version: **5.4 build 1390**
|
||||
|
||||
0. Install JDK for Java 16 so that you can compile the project. Note that language level is still Java 8 on most of the project.
|
||||
|
||||
1. Fork the Plan repository & Clone that repository to your workstation.
|
||||
Here is a [Tutorial](https://help.github.com/articles/fork-a-repo/).
|
||||
@ -25,6 +27,7 @@ Module | Description
|
||||
`sponge` | Sponge related classes
|
||||
`velocity` | Velocity related classes
|
||||
`plugin` | Module for shading all other modules into a single jar
|
||||
`fabric` | Fabric related classes, independent jar from other platforms
|
||||
|
||||
Plan uses [Dagger](https://google.github.io/dagger/) for dependency injection.
|
||||
|
||||
@ -35,18 +38,18 @@ Make sure that `/<module>/build/generated/` is included as a Generated Sources r
|
||||
|
||||
To build a new plugin artifact to use on servers, use
|
||||
```
|
||||
gradle build
|
||||
./gradlew build
|
||||
```
|
||||
The artifact will be placed in `/repo_root/Plan/builds/`
|
||||
|
||||
To run tests, use
|
||||
```
|
||||
gradle test
|
||||
./gradlew test
|
||||
```
|
||||
|
||||
To run CheckStyle checks run
|
||||
```
|
||||
gradle checkstyleMain checkstyleTest
|
||||
./gradlew checkstyleMain checkstyleTest
|
||||
```
|
||||
|
||||
> **Maven Local Dependencies**
|
||||
@ -65,7 +68,7 @@ Some tests need additional resources to be run, such as MySQL test or Selenium t
|
||||
|
||||
The resource information is set using environmental variables. Those can be found from https://github.com/plan-player-analytics/Plan/blob/master/Plan/common/src/test/java/utilities/CIProperties.java
|
||||
|
||||
## Bintray publish set-up
|
||||
## ~~Bintray publish set-up~~ (Bintray has shut down)
|
||||
|
||||
In order to publish artifacts to Bintray, following environmental variables need to be set
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user