Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.84 KB

COMPILING.md

File metadata and controls

50 lines (34 loc) · 1.84 KB
Raw

Compiling

You can compile WorldEdit as long as you have the Java Development Kit (JDK) 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 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 module for each folder.
  • gradlew eclipse will generate an Eclipse project for each folder.
  • Use setupCIWorkspace instead of setupDecompWorkspace if you are doing this on a CI server.