From 9c32ba327fc387864fa93628d99368384a79a306 Mon Sep 17 00:00:00 2001 From: Kenzie Togami Date: Fri, 2 Dec 2016 20:21:03 -0800 Subject: [PATCH] Update some notes in the compiling doc --- COMPILING.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/COMPILING.md b/COMPILING.md index 0adfe6645..53518b0c9 100644 --- a/COMPILING.md +++ b/COMPILING.md @@ -1,12 +1,14 @@ 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-sponge` is the Sponge plugin * `worldedit-forge` is the Forge mod ## To compile... @@ -29,14 +31,20 @@ You will find: * The core WorldEdit API in **worldedit-core/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** If you want to use WorldEdit, use the `-dist` version. (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 -* `gradlew idea` will generate an [IntelliJ IDEA](http://www.jetbrains.com/idea/) module for the Forge module. -* `gradlew eclipse` will generate an [Eclipse](https://www.eclipse.org/downloads/) project for the Forge version. +* `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 each folder. * Use `setupCIWorkspace` instead of `setupDecompWorkspace` if you are doing this on a CI server.