Updated Forge compilation to ForgeGradle.

This commit is contained in:
sk89q 2014-04-05 19:33:05 -07:00
parent e0a2873c99
commit 69797cfbea
11 changed files with 467 additions and 66 deletions

17
.gitignore vendored
View File

@ -1,10 +1,19 @@
/.classpath /.classpath
/.project /.project
/.settings /.settings
/target /eclipse
/bin
/dependency-reduced-pom.xml
/*.iml
/.idea /.idea
/*.iml
/*.ipr
/*.iws
/bin
/build
/target
/gradle
/.gradle
/forge-download /forge-download
/out
/dependency-reduced-pom.xml
*-private.sh *-private.sh

82
COMPILING.md Normal file
View File

@ -0,0 +1,82 @@
Compiling
=========
You can (most easily) compile WorldEdit using one of the build scripts.
* **Maven** is for compiling **API**, **Bukkit**, and **Spout** versions
* **Gradle** is for the **Forge** version
The Java Development Kit is required.
* [Get JDK 7 and 8](http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html)
* [Get JDK 6](http://www.oracle.com/technetwork/java/javasebusiness/downloads/java-archive-downloads-javase6-419409.html)
WorldEdit is written and targetted for Java 6, though you can use newer
versions (with warnings). If you plan on compiling for Forge, you **need**
at least Java 7 to be your "default" Java. (You can install several versions
of the JDK.)
Dependencies
------------
Both build scripts will download dependencies automatically. If, for some
reason, compilation fails due to a missing dependency, please notify us.
Folder Structure
----------------
Two source directories are required for compilation:
* The main source files are *src/main/java*
* Files marked for deprecation and future removal are in *src/legacy/java*
Otheriwse, files for each platform are available in different folders:
* The Bukkit implementation is located in *src/bukkit/java*
* The Spout implementation is located in *src/spout/java*
* The Forge implementation is located in *src/forge/java*
Maven
-----
**Don't have Maven?** [Download Maven](http://maven.apache.org/download.cgi)
from the Maven website.
From WorldEdit's directory, execute the following command to compile a
Bukkit version:
mvn clean package
Once done, the *target/* folder will contain a .jar file and release .zip
files.
### Other Variations
* `mvn clean package -P !bukkit` for just the API
* `mvn clean package -P !bukkit -Pspout` for the Spout version
Gradle
------
**Note:** As mentioned previously, you need Java 7 (a recent version) to
execute the following steps successfully. Your `JAVA_HOME` environment
variable needs to be set to the path of JDK 7+.
**Don't have Gradle?** Replace `gradle` with `gradlew` below, which will
automatically download a copy of Gradle for you.
From WorldEdit's directory, clean the cache first with the following
command:
gradle cleancache --refresh-dependencies
Build WorldEdit for Forge with:
gradle build
Once complete, you will find the release .jar in the folder *build/libs*.
### Other Tasks
* `gradle setupDecompWorkspace idea` will generate an [IntelliJ IDEA](http://www.jetbrains.com/idea/) workspace
* `gradle setupDecompWorkspace eclipse` will generate an [https://www.eclipse.org/downloads/](Eclipse) workspace

View File

@ -13,7 +13,7 @@ ask that you make note of the following guidelines.
methods of interfaces (Java 6+). methods of interfaces (Java 6+).
* **Use only spaces for indentation.** Our indents are 4-spaces long, and tabs * **Use only spaces for indentation.** Our indents are 4-spaces long, and tabs
are unacceptable. are unacceptable.
* **Wrap code to a 89 column limit.** We do this to make side by side diffs * **Wrap code to a 120 column limit.** We do this to make side by side diffs
and other such tasks easier. Ignore this guideline if it makes the code and other such tasks easier. Ignore this guideline if it makes the code
too unreadable. too unreadable.
* **Write complete Javadocs.** Do so only for public methods, and make sure * **Write complete Javadocs.** Do so only for public methods, and make sure

View File

@ -1,8 +1,8 @@
![WorldEdit](http://static.sk89q.com/readme/worldedit.png) ![WorldEdit](http://static.sk89q.com/readme/worldedit.png)
========= =========
WorldEdit is an easy-to-use in-game world editor for Minecraft, supporting both single WorldEdit is an easy-to-use in-game world editor for Minecraft, supporting both
player and multiplayer, that lets you: single player and multiplayer, that lets you:
* Change thousands of blocks in an area at once by selecting regions. * Change thousands of blocks in an area at once by selecting regions.
* Use over 100 functions to modify the world or remove problems. * Use over 100 functions to modify the world or remove problems.
@ -10,24 +10,25 @@ player and multiplayer, that lets you:
* Sculpt the world and build mountains with brushes. * Sculpt the world and build mountains with brushes.
* Fix annoyances such as broken water, missing snow, raging fires, and more. * Fix annoyances such as broken water, missing snow, raging fires, and more.
WorldEdit is open source and is available under the GNU General Public License v3. WorldEdit is open source and is available under the GNU Lesser General Public
License v3.
Compiling Compiling
--------- ---------
The project is written for Java 6 and our build process makes use of [Maven](http://maven.apache.org). Detailed compilation information [can be found on the wiki](http://wiki.sk89q.com/wiki/WorldEdit/Development#Compiling). See [COMPILING.md](COMPILING.md) for a guide on compiling WorldEdit.
Dependencies are automatically handled by Maven.
Contributing Contributing
------------ ------------
We happily accept contributions, especially through pull requests on GitHub. Submissions We happily accept contributions, especially through pull requests on GitHub.
must be licensed under the GNU Lesser General Public License v3. Submissions must be licensed under the GNU Lesser General Public License v3.
Please read CONTRIBUTING.md for important guidelines to follow. Please read CONTRIBUTING.md for important guidelines to follow.
We recommend following our [mailing list](https://groups.google.com/d/forum/sk-dev-discuss), especially if you have some big ideas that you want to implement. We recommend following our
[mailing list](https://groups.google.com/d/forum/sk-dev-discuss), especially if
you have some big ideas that you want to implement.
Links Links
----- -----

76
build.gradle Normal file
View File

@ -0,0 +1,76 @@
/*
* Build script for the Forge version of WorldEdit
*/
// Add ForgeGradle as a dependency for the build script
buildscript {
repositories {
mavenCentral()
maven { url = "http://files.minecraftforge.net/maven" }
}
dependencies {
classpath 'net.minecraftforge.gradle:ForgeGradle:1.0-SNAPSHOT'
}
}
apply plugin: 'java'
apply plugin: 'maven'
apply plugin: 'forge'
group = 'com.sk89q'
version = '6.0.0-SNAPSHOT'
archivesBaseName = "worldedit-forge"
description = "An in-game voxel map editor for Minecraft."
sourceCompatibility = 1.6
targetCompatibility = 1.6
repositories {
mavenCentral()
maven { url "http://repo.bukkit.org/content/groups/public" }
maven { url "http://maven.sk89q.com/repo/" }
maven { url "http://repo.maven.apache.org/maven2" }
}
dependencies {
compile group: 'de.schlichtherle', name: 'truezip', version:'6.8.3'
compile group: 'rhino', name: 'js', version:'1.7R2'
compile group: 'org.yaml', name: 'snakeyaml', version:'1.9'
compile group: 'com.google.guava', name: 'guava', version:'10.0.1'
compile group: 'com.sk89q', name: 'jchronic', version:'0.2.4a'
compile group: 'com.google.code.findbugs', name: 'jsr305', version: '1.3.9'
testCompile group: 'org.mockito', name: 'mockito-core', version:'1.9.0-rc1'
}
sourceSets {
main {
java {
srcDir 'src/main/java'
srcDir 'src/legacy/java'
srcDir 'src/forge/java'
}
resources {
srcDir 'src/main/resources'
srcDir 'src/forge/resources'
}
}
}
minecraft {
version = "1.6.4-9.11.1.964"
forgeVersion = "9.11.1.964"
}
processResources {
from (sourceSets.main.resources.srcDirs) {
expand 'version': project.version, 'mcVersion': project.minecraft.version,
'forgeVersion': project.minecraft.forgeVersion
include 'mcmod.info'
}
from (sourceSets.main.resources.srcDirs) {
exclude 'mcmod.info'
}
}

164
gradlew vendored Normal file
View File

@ -0,0 +1,164 @@
#!/usr/bin/env bash
##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
warn ( ) {
echo "$*"
}
die ( ) {
echo
echo "$*"
echo
exit 1
}
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
esac
# For Cygwin, ensure paths are in UNIX format before anything is touched.
if $cygwin ; then
[ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
fi
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >&-
APP_HOME="`pwd -P`"
cd "$SAVED" >&-
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi
# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
function splitJvmOpts() {
JVM_OPTS=("$@")
}
eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"

90
gradlew.bat vendored Normal file
View File

@ -0,0 +1,90 @@
@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@rem
@rem ##########################################################################
@rem Set local scope for the variables with windows NT shell
if "%OS%"=="Windows_NT" setlocal
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
set DEFAULT_JVM_OPTS=
set DIRNAME=%~dp0
if "%DIRNAME%" == "" set DIRNAME=.
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:findJavaFromJavaHome
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
echo.
echo Please set the JAVA_HOME variable in your environment to match the
echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windowz variants
if not "%OS%" == "Windows_NT" goto win9xME_args
if "%@eval[2+2]" == "4" goto 4NT_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
goto execute
:4NT_args
@rem Get arguments from the 4NT Shell from JP Software
set CMD_LINE_ARGS=%$
:execute
@rem Setup the command line
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
:end
@rem End local scope for the variables with windows NT shell
if "%ERRORLEVEL%"=="0" goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
exit /b 1
:mainEnd
if "%OS%"=="Windows_NT" endlocal
:omega

44
pom.xml
View File

@ -135,6 +135,13 @@
<type>jar</type> <type>jar</type>
</dependency> </dependency>
<!-- @Nullable etc. -->
<dependency>
<groupId>com.google.code.findbugs</groupId>
<artifactId>jsr305</artifactId>
<version>1.3.9</version>
</dependency>
<!-- Used for time operations --> <!-- Used for time operations -->
<dependency> <dependency>
<groupId>com.sk89q</groupId> <groupId>com.sk89q</groupId>
@ -539,43 +546,6 @@
</build> </build>
</profile> </profile>
<!--
=====================================
Forge
=====================================
-->
<profile>
<id>forge</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>1.7</version>
<executions>
<execution>
<phase>compile</phase>
<configuration>
<target>
<property name="maven.build.directory" value="${project.build.directory}" />
<property name="jchronic.path" value="${maven.dependency.com.sk89q.jchronic.jar.path}" />
<property name="truezip.path" value="${maven.dependency.de.schlichtherle.truezip.jar.path}" />
<property name="rhino.path" value="${maven.dependency.rhino.js.jar.path}" />
<property name="snakeyaml.path" value="${maven.dependency.org.yaml.snakeyaml.jar.path}" />
<property name="we.version" value="${project.version}" />
<ant antfile="src/forge/ant/build.xml" />
</target>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<!-- <!--
===================================== =====================================
Attach docs and source Attach docs and source

1
settings.gradle Normal file
View File

@ -0,0 +1 @@
rootProject.name = 'worldedit'

View File

@ -19,12 +19,14 @@
package com.sk89q.worldedit.forge; package com.sk89q.worldedit.forge;
import java.util.ArrayList; import com.sk89q.minecraft.util.commands.Command;
import java.util.Arrays; import com.sk89q.worldedit.BiomeTypes;
import java.util.List;
import com.sk89q.worldedit.LocalConfiguration; import com.sk89q.worldedit.LocalConfiguration;
import com.sk89q.worldedit.LocalWorld;
import com.sk89q.worldedit.ServerInterface;
import cpw.mods.fml.common.FMLCommonHandler;
import net.minecraft.command.CommandBase; import net.minecraft.command.CommandBase;
import net.minecraft.command.ICommand;
import net.minecraft.command.ICommandSender; import net.minecraft.command.ICommandSender;
import net.minecraft.command.ServerCommandManager; import net.minecraft.command.ServerCommandManager;
import net.minecraft.entity.EntityList; import net.minecraft.entity.EntityList;
@ -33,12 +35,9 @@ import net.minecraft.server.MinecraftServer;
import net.minecraft.world.WorldServer; import net.minecraft.world.WorldServer;
import net.minecraftforge.common.DimensionManager; import net.minecraftforge.common.DimensionManager;
import com.sk89q.minecraft.util.commands.Command; import java.util.ArrayList;
import com.sk89q.worldedit.BiomeTypes; import java.util.Arrays;
import com.sk89q.worldedit.LocalWorld; import java.util.List;
import com.sk89q.worldedit.ServerInterface;
import cpw.mods.fml.common.FMLCommonHandler;
public class ForgeServerInterface extends ServerInterface { public class ForgeServerInterface extends ServerInterface {
private final WorldEditMod mod; private final WorldEditMod mod;
@ -114,6 +113,15 @@ public class ForgeServerInterface extends ServerInterface {
public String getCommandUsage(ICommandSender icommandsender) { public String getCommandUsage(ICommandSender icommandsender) {
return "/" + cmd.aliases()[0] + " " + cmd.usage(); return "/" + cmd.aliases()[0] + " " + cmd.usage();
} }
@Override
public int compareTo(Object o) {
if (o instanceof ICommand) {
return super.compareTo((ICommand) o);
} else {
return -1;
}
}
}); });
} }
} }

View File

@ -4,19 +4,19 @@
"modid": "WorldEdit", "modid": "WorldEdit",
"name": "WorldEdit", "name": "WorldEdit",
"description": "WorldEdit is an easy-to-use in-game world editor for Minecraft, supporting both single player and multiplayer.", "description": "WorldEdit is an easy-to-use in-game world editor for Minecraft, supporting both single player and multiplayer.",
"version": "%VERSION%", "version": "${version}",
"mcversion": "%MCVERSION%", "mcversion": "${mcVersion}",
"url": "http://wiki.sk89q.com/wiki/WorldEdit", "url": "http://wiki.sk89q.com/wiki/WorldEdit",
"updateUrl": "", "updateUrl": "",
"authors": [ "sk89q" ], "authors": [ "sk89q", "wizjany", "TomyLobo" ],
"credits": "", "credits": "",
"logoFile": "", "logoFile": "",
"screenshots": [], "screenshots": [],
"requiredMods": [ "requiredMods": [
"Forge@[9.10.1.850,)" "Forge@[${forgeVersion},)"
], ],
"dependencies": [ "dependencies": [
"Forge@[9.10.1.850,)" "Forge@[${forgeVersion},)"
], ],
"dependants": [] "dependants": []
}] }]