WorldEdit/COMPILING.md

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 8 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 four modules:

* `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...

### On Windows

1. Shift + right click the folder with WorldEdit's files and click "Open command prompt".
2. `gradlew clean setupDecompWorkspace`
3. `gradlew build`

### On Linux, BSD, or Mac OS X

1. In your terminal, navigate to the folder with WorldEdit's files (`cd /folder/of/worldedit/files`)
2. `./gradlew clean setupDecompWorkspace`
3. `./gradlew build`

## Then you will find...

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 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.
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00			`Compiling`
			`=========`

Updated changelog, contributing info, gradle, etc 2018-10-04 14:15:35 +08:00			`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 8 or newer.`
Update some notes in the compiling doc 2016-12-03 12:21:03 +08:00			`You only need one version of the JDK installed.`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Update some notes in the compiling doc 2016-12-03 12:21:03 +08:00			`The build process uses Gradle, which you do not need to download. WorldEdit is a multi-module project with four modules:`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Update some notes in the compiling doc 2016-12-03 12:21:03 +08:00			* `worldedit-core` contains the WorldEdit API
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			* `worldedit-bukkit` is the Bukkit plugin
Update some notes in the compiling doc 2016-12-03 12:21:03 +08:00			* `worldedit-sponge` is the Sponge plugin
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			* `worldedit-forge` is the Forge mod
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`## To compile...`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`### On Windows`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`1. Shift + right click the folder with WorldEdit's files and click "Open command prompt".`
Revert "Tell people to use setupDevWorkspace rather than setupDecompWorkspace" Issue was fixed in commit 173f83235277e262033ba27b3c3978b7b99a0ee2 This reverts commit 121d77ccf6b479922ad2ef0eaba8b93b46a623c5. 2015-09-16 09:07:56 +08:00			2. `gradlew clean setupDecompWorkspace`
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			3. `gradlew build`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`### On Linux, BSD, or Mac OS X`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			1. In your terminal, navigate to the folder with WorldEdit's files (`cd /folder/of/worldedit/files`)
Align windows and linux directions 2015-09-16 09:10:22 +08:00			2. `./gradlew clean setupDecompWorkspace`
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			3. `./gradlew build`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`## Then you will find...`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`You will find:`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`* The core WorldEdit API in worldedit-core/build/libs`
			`* WorldEdit for Bukkit in worldedit-bukkit/build/libs`
Update some notes in the compiling doc 2016-12-03 12:21:03 +08:00			`* WorldEdit for Sponge in worldedit-sponge/build/libs`
Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`* WorldEdit for Forge in worldedit-forge/build/libs`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Fix classifier in compile guide 2016-12-01 20:55:39 +08:00			If you want to use WorldEdit, use the `-dist` version.
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Fix classifier in compile guide 2016-12-01 20:55:39 +08:00			`(The -dist version includes WorldEdit + necessary libraries.)`
Updated Forge compilation to ForgeGradle. 2014-04-06 10:33:05 +08:00
Update some notes in the compiling doc 2016-12-03 12:21:03 +08:00			### 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!`

Switch to Gradle. Use git log --follow for history. This converts the project into a multi-module Gradle build. By default, Git does not show history past a rename, so use git log --follow to see further history. 2014-11-15 03:27:39 +08:00			`## Other commands`
Made COMPILING.md easier to understand 2014-04-24 04:37:42 +08:00
Update some notes in the compiling doc 2016-12-03 12:21:03 +08:00			* `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.
Align windows and linux directions 2015-09-16 09:10:22 +08:00			* Use `setupCIWorkspace` instead of `setupDecompWorkspace` if you are doing this on a CI server.