Getting_started

Getting started

The base of the game is The Patrician and its successor Patrician 2 with its Add-on. The Add-on was sold on the international market as Patrician 3. To avoid confusion we will use international terminology and call the Add-on Patrician 3. Last year (fall 2010) Kalypso Media started selling Patrician 4. This game is currently not the focus of this development.

The development of the game is planned to follow these three stages of continuously improved games.

Here is a review of The Patrician with some screen shots. The game can be downloaded. Review of the Patrician 2 at Gamespot as well as Patrician 3.

Valuable hints on how the internals on Patrician 3 work can be found in this German tip collection.

Java Developer

I develop the project with Eclipse, however it should be possible to use other IDEs as well.

with Eclipse

Check out the project into your Eclipse workspace (import svn) using this subversion URL: svn+ssh://svn.code.sf.net/p/openpatrician/code/trunk This will get you four projects:

• OpenPatrician
• OpenPatricianWeb
• OpenPatricianGameArt
• OpenPatrician-assembly

The second project contains the projects web data. The first is the actual source of the game. The project is set up as a Maven module project. Therefore you will need to install the M2Eclipse plug-in. I have maven also installed on my system so I can execute commands from the shell. The OpenPatrician projects contains multiple folders, that are the modules. Now you import these projects (File / Import / General / Existing project). Alternativly you can checkout the project as Maven Project. This will automatically scan for modules and set up the appropriate projects.

with NetBeans

To check out the projects under NetBeans go to Team->Subversion->Checkout with the following URL: svn+ssh://svn.code.sf.net/p/openpatrician/code/trunk This will get you four projects:

• OpenPatrician
• OpenPatricianWeb
• OpenPatricianGameArt
• OpenPatrician-assembly

Since these are Eclipse project you will not find the needed properties to set the projects up. For development you only need to check out the OpenPatrician folder which contains the code. The other folders hold data for the web, game image production and the assembly project is used to create one runnable jar file. To get the projects from the checked out code you need to have the Maven plugin installed. Then you can File->Open Project and select the folder where your code lies. This will create a root folder with the parent project. All children are in the 'folder' modules. Double clicking on a module will extract it as a project that can be used.

General

Contact me so you can be added as a developer to the project to gain write access to the repository.

If you have never used Maven I suggest Sonatypes Getting started guide and the more complete version.

An important address may be the German Patrician Forum.

Compiling

Producing a runnable jar is fairly easy, all that you have to do is issue the following on the command line (if maven 3 and svn are installed and in the executable search path):

Checkout:

svn co svn+ssh://svn.code.sf.net/p/openpatrician/code/trunk/OpenPatrician-assembly OpenPatrician-assembly
svn co svn+ssh://svn.code.sf.net/p/openpatrician/code/trunk/OpenPatrician OpenPatrician

or update an existing project:

svn up OpenPatrician-assembly
svn up OpenPatrician

Build all the components (inclusive running all tests):

cd OpenPatrician
mvn install

Build an executable jar file:

cd ../OpenPatrician-assemby
mvn package

Run the game:

java -jar target/OpenPatrician-0.0.1-SNAPSHOT-jar-with-dependencies.jar

The version number (in the above example 0.0.1-SNAPSHOT) may be adjusted, based on the version built (see output of the mvn package command).

Graphic Designer

Game art can be found on OpenGameArt. I intend to publish the game art there.

Sound Engineer

Sounds and music can be found on OpenGameArt. I intend to publish the sounds there.