WorldEdit/COMPILING.md
2021-08-14 20:04:47 -07:00

48 lines
1.7 KiB
Markdown

Compiling
=========
You can compile WorldEdit as long as you have some version of Java greater than or equal to 16 installed. Gradle will download JDK 16 specifically if needed,
but it needs some version of Java to bootstrap from.
Note that if you have JRE 16 installed, Gradle will currently attempt to use that to compile, which will not work. It is easiest to uninstall JRE 16 and
replace it with JDK 16.
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
* `worldedit-fabric` is the Fabric mod
## To compile...
### On Windows
1. Shift + right click the folder with WorldEdit's files and click "Open command prompt".
2. `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 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**
* WorldEdit for Fabric in **worldedit-fabric/build/libs**
If you want to use WorldEdit, use the `-dist` version.
(The -dist version includes WorldEdit + necessary libraries.)
## 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.