Building PCGen - Revision history

Eax: remove some wrong info; update some info

2017-03-06T05:25:07Z

remove some wrong info; update some info

Javydreamercsw: Add netBeans set up instructions.

2016-09-28T19:03:05Z

Add netBeans set up instructions.

Johnstonian at 21:54, 17 November 2015

2015-11-17T21:54:19Z

LegacyKing: Add Mac homebrew instructions

2015-11-02T17:00:46Z

Add Mac homebrew instructions

James: Update info to reflect move to gradle wrapper

2014-12-20T10:32:41Z

Update info to reflect move to gradle wrapper

James: Indicate gradle 2 does not work

2014-09-07T07:36:54Z

Indicate gradle 2 does not work

James: Migrate to the Gradle build

2014-07-05T06:42:12Z

Migrate to the Gradle build

James at 04:59, 20 October 2013

2013-10-20T04:59:48Z

James: Update to Java 6

2011-11-29T08:40:45Z

Update to Java 6

Karianna: /* Running and debugging */

2010-04-09T08:24:13Z

‎Running and debugging

@@ Line 11: / Line 11: @@
 Open a command window and change to the root directory/folder where you installed the PCGen source code. There should be a file called build.gradle there.
-Type '''gradlew''' at the command prompt. This will make sure you have a clean start and then build the pcgen.jar file. You can start pcgen.jar, pcgen.exe or pcgendev.sh to run it or manually run the jar file using a command line like
+Type '''gradlew''' at the command prompt. This will make sure you have a clean start and then build the pcgen.jar file. You can start pcgen.jar, pcgen.exe to run it or manually run the jar file using a command line like
-<pre>java -Xmx1024M -jar pcgen.jar</pre>
+<code>./pcgen.sh</code>
 To generate the JavaDocs use gradlew javadoc. To run all the tests use gradlew slowtest (which can take a while).
@@ Line 62: / Line 62: @@
 You can now run PCGen with the green right-pointing triangle on the toolbar and debug with the green right-facing beetle on a blue diamond. Or just use the Run menu.
 =Using NetBeans to build PCGen=

← Older revision		Revision as of 19:03, 28 September 2016
Line 73:		Line 73:
	4. Run PCGen from terminal		4. Run PCGen from terminal
	<pre>java -Xmx1024M -jar pcgen.jar</pre>		<pre>java -Xmx1024M -jar pcgen.jar</pre>
		+
		+	=Using NetBeans to build PCGen=
		+
		+	You can build PCGen from within NetBeans. It is configured by default to use the gradle dependencies however you will need the "Gradle Support" plugin which can be installed free from the [http://plugins.netbeans.org/plugin/44510/gradle-support NetBeans Plugin portal].
		+
		+	Once installed, NetBeans will share the jars as specified in build.gradle. You can also accesa gradle tasks from within NetBeans using the "Right Click > Task".
		+
		+	==Running and debugging==
		+
		+	The Gradle Support plugin allows to use all the IDE's features normally. You can right click on a Java class with a proper main method and just click "Run File".
		+
		+	You can now run PCGen with the green right-pointing triangle on the toolbar and debug with the green right-pointing triangle on top of a piece of a file. Or just use the Run menu.

@@ Line 11: / Line 11: @@
 Open a command window and change to the root directory/folder where you installed the PCGen source code. There should be a file called build.gradle there.
-Type gradlew at the command prompt. This will make sure you have a clean start and then build the pcgen.jar file. You can start pcgen.jar, pcgen.exe or pcgendev.sh to run it or manually run the jar file using a command line like
+Type '''gradlew''' at the command prompt. This will make sure you have a clean start and then build the pcgen.jar file. You can start pcgen.jar, pcgen.exe or pcgendev.sh to run it or manually run the jar file using a command line like
 <pre>java -Xmx1024M -jar pcgen.jar</pre>
@@ Line 64: / Line 64: @@
 ==Building for Mac==
-# install gradle via homebrew - ‘brew install gradle'
+. install gradle via homebrew [http://brew.sh/]
-# run ‘gradle clean’ in pcgen directory
+<pre>brew install gradle</pre>
-# run ‘gradle build’ in pcgen directory
+. Clean the pcgen directory using Gradle
-# run 'java -Xmx1024M -jar pcgen.jar'
+<pre>gradle clean</pre>

← Older revision		Revision as of 17:00, 2 November 2015
Line 62:		Line 62:

	You can now run PCGen with the green right-pointing triangle on the toolbar and debug with the green right-facing beetle on a blue diamond. Or just use the Run menu.		You can now run PCGen with the green right-pointing triangle on the toolbar and debug with the green right-facing beetle on a blue diamond. Or just use the Run menu.
		+
		+	==Building for Mac==
		+	User submitted these instructions:
		+
		+	# install gradle via homebrew - ‘brew install gradle'
		+	# run ‘gradle clean’ in pcgen directory
		+	# run ‘gradle build’ in pcgen directory
		+	# run 'java -Xmx1024M -jar pcgen.jar'

@@ Line 7: / Line 7: @@
 * Java Development Kit (aka Java SDK or JDK). You should use the latest version (update) of the JDK 6.0 available for download from [http://www.oracle.com/technetwork/java/javase/downloads/index.html here]. At the time of writing this was Java SE 6 Update 45. Java 7 will also work, but no 1.7 specific features should be used in the code just yet. Other JDKs might work, but no one has tried.
 * You will also need the latest version of the PCGen source code available from SVN. See [[Subversion Setup]] for details.
 Open a command window and change to the root directory/folder where you installed the PCGen source code. There should be a file called build.gradle there.
-Type gradle at the command prompt. This will make sure you have a clean start and then build the pcgen.jar file. You can start pcgen.jar, pcgen.exe or pcgendev.sh to run it or manually run the jar file using a command line like
+Type gradlew at the command prompt. This will make sure you have a clean start and then build the pcgen.jar file. You can start pcgen.jar, pcgen.exe or pcgendev.sh to run it or manually run the jar file using a command line like
 <pre>java -Xmx1024M -jar pcgen.jar</pre>
-To generate the JavaDocs use gradle javadoc. To run all the tests use gradle slowtest (which can take a while).
+To generate the JavaDocs use gradlew javadoc. To run all the tests use gradlew slowtest (which can take a while).
-Typing the command <pre>gradle</pre> will clean the project, build the code and run a small selection of tests.
+Typing the command <pre>gradlew</pre> will clean the project, build the code and run a small selection of tests.
-Typing the command <pre>gradle slowtest</pre> will build the code and run the full test suite and produce a report.
+Typing the command <pre>gradlew slowtest</pre> will build the code and run the full test suite and produce a report.
 =Using Eclipse to build PCGen=
@@ Line 25: / Line 24: @@
 You can build PCGen from within Eclipse. It is configured by default to use the gradle dependencies however you will need the "Gradle Integration for Eclipse" plugin which can be installed free from the Eclipse Marketplace.
-Once installed, Eclipse will share the jars as specified in build.gradle. You can also acces gradle tasks from within Eclipse using the "Window > Show View > Other" menu and then selecting "Gradle Tasks".
+Once installed, Eclipse will share the jars as specified in build.gradle. You can also accesa gradle tasks from within Eclipse using the "Window > Show View > Other" menu and then selecting "Gradle Tasks".
 ==Running and debugging==
@@ Line 45: / Line 44: @@
 =Using IDEA to build PCGen=
-You can build PCGen from within IDEA. You will need to do a little bit of setup first though:
+You can build PCGen from within IntelliJ IDEA. Intellij will recognize the Gradle build for the project and provide access to the tasks.
 ==Running and debugging==

@@ Line 4: / Line 4: @@
 =Building PCGen from the command line=
-This process uses the [[ANT]] tool, you need the following software packages:
+This process uses the [[Gradle]] tool, you need the following software packages:
-* Java Development Kit (aka Java SDK or JDK). You should use the latest version (update) of the JDK 6.0 available for download from [http://www.oracle.com/technetwork/java/javase/downloads/index.html here]. At the time of writing this was Java SE 6 Update 29. Java 7 will also work for the new UI, but no 1.7 specific features should be used in the code. Other JDKs might work, but no one has tried.
+* Java Development Kit (aka Java SDK or JDK). You should use the latest version (update) of the JDK 6.0 available for download from [http://www.oracle.com/technetwork/java/javase/downloads/index.html here]. At the time of writing this was Java SE 6 Update 45. Java 7 will also work, but no 1.7 specific features should be used in the code just yet. Other JDKs might work, but no one has tried.
-* Ant 1.7.0 (or later) from [http://jakarta.apache.org/ant/ here]. Ant is an all-Java replacement for make, and is fully cross-platform. Note: You will also need to download the jakarta-ant optional.jar file if using certain versions of Ant. See [[ANT]] section for further details
+* Gradle 1.12 (or later) from [http://www.gradle.org/ here]. Gradle is fully cross-platform Java based build tool. See [[Gradle]] section for further details
 * You will also need the latest version of the PCGen source code available from SVN. See [[Subversion Setup]] for details.
-Open a command window and change to the root directory/folder where you installed the PCGen source code. There should be a file called build.xml there.
+Open a command window and change to the root directory/folder where you installed the PCGen source code. There should be a file called build.gradle there.
-Type ant clean at the command prompt. This will make sure you have a clean start. Then run ant. This will build the pcgen.jar file. The jar file will be in ./bin. You can run pcgendev.bat or pcgendev.sh to run it or manually copy the jar file to the PCGen root directory.
+Type gradle at the command prompt. This will make sure you have a clean start and then build the pcgen.jar file. You can start pcgen.jar, pcgen.exe or pcgendev.sh to run it or manually run the jar file using a command line like
-'''NOTE'''
+To generate the JavaDocs use gradle javadoc. To run all the tests use gradle slowtest (which can take a while).
-To generate the JavaDocs use ant docs, and for deployments you can use ant deploy, and finally ant all does all of the above (clean, build, docs, deploy), and ant complete does everything including a full testing cycle (which can take a while).
+Typing the command <pre>gradle</pre> will clean the project, build the code and run a small selection of tests.
-Typing the command <pre>ant</pre> will build the code and run a small selection of tests.
+Typing the command <pre>gradle slowtest</pre> will build the code and run the full test suite and produce a report.
-Typing the command <pre>ant dotest</pre> will build the code and run the full test suite.
+=Using Eclipse to build PCGen=
-Typing the command <pre>ant reporttest</pre> after running the tests will generate a test report.  The xml result files are generated while running the tests, they can be found in ./code/build/test-results/xml/ after making the reporttest target, a browsable set of html reports can be found in ./code/build/rpt/test-results/
+You can build PCGen from within Eclipse. It is configured by default to use the gradle dependencies however you will need the "Gradle Integration for Eclipse" plugin which can be installed free from the Eclipse Marketplace.
-=Using Eclipse to build PCGen=
+Once installed, Eclipse will share the jars as specified in build.gradle. You can also acces gradle tasks from within Eclipse using the "Window > Show View > Other" menu and then selecting "Gradle Tasks".
 ==Running and debugging==
@@ Line 73: / Line 66: @@
 You can now run PCGen with the green right-pointing triangle on the toolbar and debug with the green right-facing beetle on a blue diamond. Or just use the Run menu.

@@ Line 31: / Line 31: @@
 You can build PCGen from within Eclipse. You will need to do a little bit of setup first though:
 # Go to Window > Preferences, then Ant > Runtime then select Ant Home Entries under the Classpath tab.
-# Click Add Jars. Select the junit.jar under pcgen/lib/test.
+# Click Add Jars. Select the junit.jar under pcgen/lib.
 Now you should be able to select the build.xml, right click and hit Run > Ant Build and it should work.
@@ Line 37: / Line 37: @@
 # Open the PCGen project.
-# Open the Run dialog by right-clicking on the PCGen project and selecting Run > Run....
+# Open the Run dialog by right-clicking on the PCGen project and selecting Run As > Run Configurations
-# Select the Java Application nide.
+# Select the Java Application node.
 # Press the New button for a new configuration. Edit by field, thus:
 Name -> PCGen
-Main class -> pcgen.gui.pcGenGUI
+Main class -> pcgen.system.Main
 # Press Apply to save the configuration.
 # Press Run to start PCGen.
@@ Line 66: / Line 68: @@
 Name -> PCGen
-Main class -> pcgen.gui.pcGenGUI
+Main class -> pcgen.system.Main
 # Uncheck Display settings before running/debugging.
 # Press Ok.

@@ Line 71: / Line 71: @@
 You can now run PCGen with the green right-pointing triangle on the toolbar and debug with the green right-facing beetle on a blue diamond. Or just use the Run menu.
 =Using Maven to build PCGen=
 See [[MAVEN]]