Browse Source

Made setting up workspaces easier.

1.8
Collin Soares 5 years ago
parent
commit
f7e7446290
14 changed files with 386 additions and 56 deletions
  1. +3
    -3
      .gitignore
  2. +42
    -0
      CONTRIBUTING.md
  3. +6
    -40
      README.md
  4. +6
    -4
      build.gradle
  5. +1
    -1
      gilded-games-util
  6. BIN
      gradle/wrapper/gradle-wrapper.jar
  7. +6
    -0
      gradle/wrapper/gradle-wrapper.properties
  8. +164
    -0
      gradlew
  9. +90
    -0
      gradlew.bat
  10. +21
    -0
      scripts/build.bat
  11. +19
    -0
      scripts/setup_multi_project.bat
  12. +28
    -0
      scripts/setup_simple_workspace.bat
  13. +0
    -6
      setup.bat
  14. +0
    -2
      start.bat

+ 3
- 3
.gitignore View File

@@ -12,9 +12,9 @@ bin
/.gradle/
/build/
/bin/
gradle
gradlew.bat
gradlew
# Gradle Wrapper
/gradle/wrapper/dists

# Windows image file caches
Thumbs.db


+ 42
- 0
CONTRIBUTING.md View File

@@ -0,0 +1,42 @@
## Contributing

Before you begin, you need to install the _Gradle Intergration for Eclipse (4.4)_. You can install it through the Eclipse Marketplace, which is found in _Help > Eclipse Marketplace_.

1. Run the _setup_multi_project.bat_ inside the scripts directory. It might take a while to run the first time.

2. Open Eclipse (if it isn't already), and navigate to _File > Import..._ In the dialog, search for "Gradle Project", then click _Next_.

3. Fill in the _Root folder_ field by clicking _Browse_ and navigating to the location you cloned the repository, then click "Build Model".

4. If all goes well, two projects will be shown. Checkmark _both_ of them if they aren't already.

5. Once done, go to the "Launch" button and click the dropdown, then click "Run Configurations". Create the following configurations below by double clicking on "Java Application" in the left pane.

a. Aether Client
```
[Main tab]
Project: (the Aether project)
Main class: GradleStart

[Arguments tab]
Program arguments: --username MY_USERNAME
Working directory: {WORKSPACE_LOC}\eclipse
```

Replace `MY_USERNAME` with your Minecraft character's username and `{WORKSPACE_LOC}` with the default working directory's text.

b. Aether Server
```
[Main tab]
Project: (the Aether project)
Main class: net.minecraftforge.fml.relauncher.ServerLaunchWrapper

[Arguments tab]
Working directory: {WORKSPACE_LOC}\eclipse
```

Be sure to replace `{WORKSPACE_LOC}` with the default working directory's text.

6. Choose which configuration you want to run and simply press the "Run" button. After you run it, it'll be added to your launch history and will be accessible from the Launch dropdown menu.

If the Gradle configurations have changed since the last time you used it (Forge gets updated, etc), you'll need to run _setup_multi_project.bat_ again. After the setup script has run, right click both the Aether 1.8 and Gilded-Games-Util projects, and then click _Gradle > Refresh All..._

+ 6
- 40
README.md View File

@@ -3,47 +3,13 @@ Aether II 1.8

In development by Gilded Games, the Aether II is an extensive mod for Minecraft which implements a remarkable world in the skies. Adventure, danger, and mystery awaits in the depths of the Aether.

### Setting up your Workspace
## Contributors
Please see CONTRIBUTING.md instead of following the below.

Before you begin, you need to install the _Gradle Intergration for Eclipse (4.4)_. You can install it through the Eclipse Marketplace, which is found in _Help > Eclipse Marketplace_.
### Setting up your Workspace (for non-developers)

1. Open the Import dialog by clicking _File > Import..._ and search for "Gradle Project", then click _Next_.
1. Run the _setup_simple_workspace.bat_ file found inside the repo's root folder. This may take a bit, so be patient!

2. Fill in the _Root folder_ field by clicking _Browse_ and navigating to the location you cloned the repository, then click "Build Model".
2. Open Eclipse and navigate to _File > Switch Workspace..._, then choose _Other..._ and browse for the eclipse folder found inside the repo.

3. If all goes well, two projects will be shown. Checkmark _both_ of them if they aren't already. In the "Import options" section, checkmark "Run before" and set it's contents to: `setupDecompWorkspace cleanEclipse eclipse`.

4. Click "Finish" and wait for Eclipse to setup your projects. This may take 10 or so minutes.

5. If the imported projects have errors, try right clicking each one and going to _Gradle > Refresh All..._

6. Once done, go to the "Launch" button and click the dropdown, then click "Run Configurations". Create the following configurations below by double clicking on "Java Application" in the left pane.

a. Aether Client
```
[Main tab]
Project: (the Aether project)
Main class: GradleStart

[Arguments tab]
Program arguments: --username MY_USERNAME
Working directory: {WORKSPACE_LOC}\eclipse
```

Replace `MY_USERNAME` with your Minecraft character's username and `{WORKSPACE_LOC}` with the default working directory's text.

b. Aether Server
```
[Main tab]
Project: (the Aether project)
Main class: net.minecraftforge.fml.relauncher.ServerLaunchWrapper

[Arguments tab]
Working directory: {WORKSPACE_LOC}\eclipse
```

Be sure to replace `{WORKSPACE_LOC}` with the default working directory's text.

7. Choose which configuration you want to run and simply press the "Run" button. After you run it, it'll be added to your launch history and will be accessible from the Launch dropdown menu.

If the gradle configurations have changed since the last time you used it, you'll need to go to each imported project, right click, and run _Gradle > Refresh All..._
3. You now have a very basic workspace!

+ 6
- 4
build.gradle View File

@@ -1,15 +1,18 @@
buildscript {
repositories {
mavenCentral()

maven {
name = "forge"
url = "http://files.minecraftforge.net/maven"
}

maven {
name = "sonatype"
url = "https://oss.sonatype.org/content/repositories/snapshots/"
}
}

dependencies {
classpath 'net.minecraftforge.gradle:ForgeGradle:1.2-SNAPSHOT'
}
@@ -18,7 +21,7 @@ buildscript {
apply plugin: 'forge'

version = "1.8-1.0"
group= "net.aetherteam.aether"
group = "net.aetherteam.aether"
archivesBaseName = "aether"

minecraft {
@@ -29,11 +32,10 @@ minecraft {
}

dependencies {
compile project(':gilded-games-util')
compile project('gilded-games-util')
}

processResources
{
processResources {
inputs.property "version", project.version
inputs.property "mcversion", project.minecraft.version



+ 1
- 1
gilded-games-util

@@ -1 +1 @@
Subproject commit 8843e2d72758ead146154a4e0e28bddbc1669ed4
Subproject commit 27e2befcb6dff05d49586ba05fb4d9bc3547e1f7

BIN
gradle/wrapper/gradle-wrapper.jar View File


+ 6
- 0
gradle/wrapper/gradle-wrapper.properties View File

@@ -0,0 +1,6 @@
#Wed Jul 02 15:54:47 CDT 2014
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-2.0-bin.zip

+ 164
- 0
gradlew 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
- 0
gradlew.bat 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

+ 21
- 0
scripts/build.bat View File

@@ -0,0 +1,21 @@
@echo off
title Building the Aether II...

:: Push in to the root folder
pushd ..

:: Call Gradle Setup
call gradlew.bat build

:: Pop back into the scripts folder
popd

echo.
echo Finished. The compiled jars can be found in the following locations:
echo.
echo Aether II : %CD%\build\libs
echo.
echo Gilded Games Util : %CD%\gilded-games-util\build\libs
echo.
pause
exit

+ 19
- 0
scripts/setup_multi_project.bat View File

@@ -0,0 +1,19 @@
@echo off
title Aether II Multi-Project Workspace Setup

:: Push in to the root folder
pushd ..

:: Configure Aether-1.8
call gradlew.bat setupDecompWorkspace

:: Pop back to the scripts folder
popd

echo.
echo Finished. You can now change your workspace in Eclipse to:
echo %cd%\eclipse\
echo.

pause
exit

+ 28
- 0
scripts/setup_simple_workspace.bat View File

@@ -0,0 +1,28 @@
@echo off
title Aether II Simple Workspace Setup

echo.
echo ! WARNING !
echo.
echo Developers: You shouldn't be using this script to setup your workspace. Please see
echo CONTRIBUTING.md to setup your workspace.
echo.
echo - Press [ENTER] to continue, or press [CTRL+C] to cancel. -
pause > nul

:: Push in to the root folder
pushd ..

:: Configure Aether-1.8
call gradlew setupDecompWorkspace eclipse

:: Pop back into the scripts directoy
popd

echo.
echo Finished. You can now change your workspace in Eclipse to:
echo %cd%\eclipse\
echo.

pause
exit

+ 0
- 6
setup.bat View File

@@ -1,6 +0,0 @@
@echo off
title Aether II Development Workspace Setup

:: Call Gradle Setup
call gradlew setupDecompWorkspace eclipse
pause

+ 0
- 2
start.bat View File

@@ -1,2 +0,0 @@
@echo off
gradlew build

Loading…
Cancel
Save