PCGen Wiki - User contributions [en]

Building PCGen

2016-09-28T19:03:05Z

Javydreamercsw: Add netBeans set up instructions.

{| align="right"
| __TOC__
|}
=Building PCGen from the command line=

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 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 '''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 gradlew javadoc. To run all the tests use gradlew slowtest (which can take a while).

Typing the command <pre>gradlew</pre> will clean the project, build the code and run a small selection of tests.

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=

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 accesa gradle tasks from within Eclipse using the "Window > Show View > Other" menu and then selecting "Gradle Tasks".

==Running and debugging==

# Open the PCGen project.
# Open the Run dialog by right-clicking on the PCGen project and selecting Run As > Run Configurations
# Select the Java Application node.
# Press the New button for a new configuration. Edit by field, thus:
Name -> PCGen

Main class -> pcgen.system.Main

VM arguments (Arguments tab) -> -Xmx1024M
# Press Apply to save the configuration.
# Press Run to start PCGen.

You can also run a single test by right clicking on the test and selecting Debug > JUnit Test. This is a great way to track through a bug too.

=Using IDEA to build PCGen=

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==

NB - IDEA will build the software sufficient for running and debugging within the IDE automatically just by following these step. This is not the same as the build from the Building section, above, which builds the software suitable for command-line use.

# Open the PCGen.ipr project file.
# Get the Run/Debug Configurations dialog with Run > Edit Configurations from the menu bar.
# Select the Application tab.
# Press the [+] button for a new configuration. Edit by field, thus:
Name -> PCGen

Main class -> pcgen.system.Main
# Uncheck Display settings before running/debugging.
# Press Ok.

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==

1. install gradle via homebrew [http://brew.sh/]
<pre>brew install gradle</pre>
2. Clean the pcgen directory using Gradle
<pre>gradle clean</pre>
3. Build PCGen
<pre>gradle build</pre>
4. Run PCGen from terminal
<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.

Enhanced Networking Features

2016-09-14T21:18:10Z

Javydreamercsw:

Networking has been a forgotten feature of PCGen, but not any more! This page is for the proposal of new features to be implemented in this area.

The purpose of this page is to organize and decide features to be implemented on this area and incorporate those into the [[Roadmap]].

----

== Status ==

Currently, this forsaken feature within GMTool allows to host a server and/or connect to a server. The functionality was limited to the following:

* Chat
* Send initiative
* Assign Damage
* Revive/Kill Player
* Assign Experience

This are the basics, but I feel we could do much more than this.

== Proposal ==

* Use [https://sourceforge.net/projects/simple-marauroa Simple Marauroa Server], a server based on [https://sourceforge.net/projects/arianne Marauroa], to handle communication, security and storage of characters locally or over the internet.
* Add features like:
** Visual Component (show players, monsters, etc)
** Play over the internet (right now is limited to local network)
** Add more GM control (assign modifiers, request die rolls, assign experience and treasure)
** Dynamic campaigns where you load a D&D adventure for example, and players are ran visually thru it. With monsters, encounters, etc. Basically an automatic GM. [https://stendhalgame.org/ This] is an example of a game on top of the system.

Enhanced Networking Features

2016-09-14T20:31:26Z

Javydreamercsw:

Networking has been a forgotten feature of PCGen, but not any more! This page is for the proposal of new features to be implemented in this area.

The purpose of this page is to organize and decide features to be implemented on this area and incorporate those into the [[Roadmap]].

----

== Status ==

Currently, this forsaken feature within GMTool allows to host a server and/or connect to a server. The functionality was limited to the following:

* Chat
*

This are the basics, but I feel we could do much more than this.

== Proposal ==

* Use [https://sourceforge.net/projects/simple-marauroa Simple Marauroa Server], a server based on [https://sourceforge.net/projects/arianne Marauroa], to handle communication, security and storage of characters.
* Add features like:
** Visual Component (show players, monsters, etc)
** Play over the internet (right now is limited to local network)
** Add more GM control (assign modifiers, request die rolls, assign experience and treasure)
** Dynamic campaigns where you load a D&D adventure for example, and players are ran visually thru it. With monsters, encounters, etc. Basically an automatic GM. [https://stendhalgame.org/ This] is an example of a game on top of the system.

Enhanced Networking Features

2016-09-14T16:49:13Z

Javydreamercsw: Created page with "Networking has been a forgotten feature of PCGen, but not any more! This page is for the proposal of new features to be implemented in this area. The purpose of this page is..."

Networking has been a forgotten feature of PCGen, but not any more! This page is for the proposal of new features to be implemented in this area.

The purpose of this page is to organize and decide features to be implemented on this area and incorporate those into the [[Roadmap]].

----

== Status ==

Currently, this forsaken feature within GMTool allows to host a server and/or connect to a server. The functionality was limited to the following:

* Chat
*

This are the basics, but I feel we could do much more than this.

== Proposal ==

* Use [https://sourceforge.net/projects/simple-marauroa Simple Marauroa Server], a server based on [https://sourceforge.net/projects/arianne Marauroa], to handle communication, security and storage of characters.
* Add features like:
** Visual Component (show players, monsters, etc)
** Play over the internet (right now is limited to local network)
** Add more GM control (assign modifiers, request die rolls, assign experience and treasure)

Code

2016-09-14T13:57:13Z

Javydreamercsw: /* Open Sub Projects */

{| align="right"
| __TOC__
|}

=Introduction=
Welcome to the Wiki section for the Code Monkey team!

=Mission Statement=
'''TBA'''

=Resources=
* [[Developers Meeting]]
* [[Dev Meeting Log 20090429]]
* [[Dev Meeting Log 20090815]]
* [[Dev Meeting Log 20090911]]
* [[Dev Meeting Log 20091017]]
* [[Dev Meeting Log 20091114]]
* [[Dev Meeting Log 20120309]]
* [[Dev Meeting Log 20120429]]
* [[Dev Meeting Log 20121103]]
* [[Dev Meeting Log 20140627]]

==For New Starters==
* [[Joining the Code Team]] General steps to take to prepare yourself
* [[Code Monkey Introduction]]

==Developer Environment==
* [[Basic Developer Setup]]
* [[Git Setup]]
* [[Subversion Setup]]
* [[Merging]] with SVN
* [[Building PCGen]], also see [[Gradle]]
* [[Continuous Integration]]
* [[launch4j]]

==Coding==
* [[Coding Standards]]
* [[Deprecating a Token]]
* [[Explanation of the Code Base]]
* [[PCGen Code Exploration Almanac]]
* [[Graph Theory]]
* [[Logging in the Code Base]]
* [[Unit Testing]]
* [[Removing Libraries]]
* [[Unnecessary Code Detector]]

=Completed Sub Projects=
* [[Ability Object TODO List]]
* [[LST_Editor_Verification]]

=Open Sub Projects=
* [[Internationalization]]
* [[CDOM]]
* [[UI Overhaul]]
* [[LST_Editor]]
* [[Major Code Projects]]
* [[Template Engine]]
* [[Enhanced Networking Features]]

=Active Team Members=

===[[Explanation of Teams#Silverback|Silverback]]===
* Connor Petty

===[[Explanation of Teams#Second|2nd]]===
* TBA

===[[Explanation of Teams#Chimp|Chimp]]===
* [[Tom Parker]]
* [[Stefan Radermacher]]

===[[Explanation of Teams#Gibbon|Gibbon]]===
* Jayme Cox

===[[Explanation of Teams#Tamarin|Tamarin]]===
* [[Andrew Wilson]]
* [[Martijn Verburg]]
* [[Connor Petty]]

===[[Explanation of Teams#Lemur|Lemur]]===
* [[Eddy Anthony]]
* Per Christian Henden
* Thomas Cooper
* [[Tod Milam]] - Mac Developer
* [[Kim Winz]]

===[[X-Terminator Mark II]]===
* [[Greg Bingleman]] - [http://www.codemonkeypublishing.com Code Monkey Publishing]

===Other===
* Brad Stiles, SVN advice
* Jason Buchanan, Advice on old code
* [[Jonas Karlson]], Advice on old code

=Passive Team Members=

* B. K. Oxley (Provides IntelliJ licenses)

=Inactive Team Members=

===[[Explanation_of_Teams#2nd|2nd]]===
* Devon Jones

===[[Explanation_of_Teams#Chimp|Chimp]]===
* Aaron Divinsky

===[[Explanation_of_Teams#Tamarin|Tamarin]]===
* Andriy Sen
* [[Kevin Fernandes]]
* [[Koen Van Daele]]
* [[Joe Frazier, Jr.]]
* Per Christian Henden

===[[Explanation_of_Teams#Lemur|Lemur]]===
* Bill Neumann
* Dan Parks
* [[Eduard Martinescu]]
* Eric Jarman
* Jasper Spaans
* Julio Esslinger Viegas
* Peter Barker
* [[Rick Ryker]]
* Thomas Clegg
* Tony Lavalle
* Hades Lucifer [7/20/10]
* Josh Johnston [7/20/10]
* MotorViper [7/20/10]
* [[Steven West]] [7/20/10]
* [[Alec Ross]] [7/20/10]
* [[Tir Gwaith]] [7/20/10]

===Other===
* [[Andargor]], Suggestions
* [[Bryan McRoberts]], Advice on old code
* Kurt Wimmer, Suggestions
* Walter Duncan, Held the old pcgen_autobuild user