Plexus/Plex-FAWE
1
0
Fork 0
mirror of https://github.com/plexusorg/Plex-FAWE.git synced 2024-12-23 01:37:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update some notes in the compiling doc

Browse Source
This commit is contained in:
Kenzie Togami 2016-12-02 20:21:03 -08:00
parent 387ccb299e
commit 9c32ba327f
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
COMPILING.md
View File

@ -1,12 +1,14 @@
Compiling Compiling
========= =========
You can compile WorldEdit as long as you have the [Java Development Kit (JDK)](http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html) for Java 7 or newer. You only need one version of JDK installed. You can compile WorldEdit as long as you have the [Java Development Kit (JDK)](http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html) for Java 7 or newer.
You only need one version of the JDK installed.
The build process uses Gradle, which you do *not* need to download. WorldEdit is a multi-module project with three modules: The build process uses Gradle, which you do *not* need to download. WorldEdit is a multi-module project with four modules:
* `worldedit-core` contains WorldEdit * `worldedit-core` contains the WorldEdit API
* `worldedit-bukkit` is the Bukkit plugin * `worldedit-bukkit` is the Bukkit plugin
* `worldedit-sponge` is the Sponge plugin
* `worldedit-forge` is the Forge mod * `worldedit-forge` is the Forge mod
## To compile... ## To compile...
@ -29,14 +31,20 @@ You will find:
* The core WorldEdit API in **worldedit-core/build/libs** * The core WorldEdit API in **worldedit-core/build/libs**
* WorldEdit for Bukkit in **worldedit-bukkit/build/libs** * WorldEdit for Bukkit in **worldedit-bukkit/build/libs**
* WorldEdit for Sponge in **worldedit-sponge/build/libs**
* WorldEdit for Forge in **worldedit-forge/build/libs** * WorldEdit for Forge in **worldedit-forge/build/libs**
If you want to use WorldEdit, use the `-dist` version. If you want to use WorldEdit, use the `-dist` version.
(The -dist version includes WorldEdit + necessary libraries.) (The -dist version includes WorldEdit + necessary libraries.)
### Note regarding `setupDecompWorkspace`
`setupDecompWorkspace` requires more memory than is usually given to Gradle by default.
If it fails, you should put `org.gradle.jvmargs=-Xmx3G` in `gradle.properties`.
Please don't commit this change!
## Other commands ## Other commands
* `gradlew idea` will generate an [IntelliJ IDEA](http://www.jetbrains.com/idea/) module for the Forge module. * `gradlew idea` will generate an [IntelliJ IDEA](http://www.jetbrains.com/idea/) module for each folder.
* `gradlew eclipse` will generate an [Eclipse](https://www.eclipse.org/downloads/) project for the Forge version. * `gradlew eclipse` will generate an [Eclipse](https://www.eclipse.org/downloads/) project for each folder.
* Use `setupCIWorkspace` instead of `setupDecompWorkspace` if you are doing this on a CI server. * Use `setupCIWorkspace` instead of `setupDecompWorkspace` if you are doing this on a CI server.