Menu
▾
▴
[pcgen-commit-svn] SF.net SVN: pcgen:[7736] Trunk/pcgen/installers/mac-installer/instructions. html
|
From: <mar...@us...> - 2008-09-15 20:22:31
|
Revision: 7736
http://pcgen.svn.sourceforge.net/pcgen/?rev=7736&view=rev
Author: maredudd800
Date: 2008-09-15 19:31:12 +0000 (Mon, 15 Sep 2008)
Log Message:
-----------
Mac-Installer Build Instructions HTMLized.
Added Paths:
-----------
Trunk/pcgen/installers/mac-installer/instructions.html
Added: Trunk/pcgen/installers/mac-installer/instructions.html
===================================================================
--- Trunk/pcgen/installers/mac-installer/instructions.html (rev 0)
+++ Trunk/pcgen/installers/mac-installer/instructions.html 2008-09-15 19:31:12 UTC (rev 7736)
@@ -0,0 +1,260 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+
+<html>
+ <!--
+
+ PCGen Documentation Project
+
+ $Author: maredudd800 $
+ $Date: 2008-08-20 16:07:26 -0400 (Wed, 20 Aug 2008) $
+ $Revision: 7526 $
+
+ Contributors:
+ Eddy Anthony - eddybaATmindspringDOTcom
+ Eric C. Smith - mareduddATblackrootDOTorg
+
+ Description:
+ Provides instructions for building PGen's Mac-Installer.
+ -->
+
+ <head>
+
+ <title>PCGen Mac-Installer Instructions</title>
+
+ <link rel="stylesheet" type="text/css" href="../../docs/pcgen.css" >
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+
+ </head>
+
+ <body>
+
+ <h1>PCGen Mac-Installer InstructionsAbility Files</h1>
+
+ <p class="indent0"><strong>Written by:</strong> Conor Schutzman</p>
+ <p class="indent0"><strong>Updated by:</strong> Eddy Anthony</p>
+
+ <p class="indent0">Here is a fairly complete set of instructions on how to bundle PCGen for OS X.</p>
+
+
+ <h2>Step 1: Get Everything You Need</h2>
+
+ <ol style="list-style-type: upper-alpha">
+ <li>So, first off, you will need the OS X developer tools installed. If they didn't
+ come with your computer/OS then you can setup a free Apple Developer Connection
+ account (http://www.apple.com/developer) and download them from there. The version
+ I'm currently using is XCode Tools 2.2 which runs in Tiger.</li>
+ <li>You will also need to make sure that you have all of your OS updates installed. </li>
+ <li>Lastly, you will need the support files in this module of the PCGen project at:
+ https://svn.sourceforge.net/pcgen/Trunk/installers/mac-installer.</li>
+ <li>Oh, and of course you will need to download the full version of PCGen from SF.
+ </ol>
+
+ <p class="indent0">Now that we have all the parts and pieces, we can start to assemble.</p>
+
+
+ <h2>Step 2: Converting PCGen to an OS X App</h2>
+
+ <ol style="list-style-type: upper-alpha">
+ <li>Launch /Developer/Applications/Java Tools/Jar Bundler</li>
+ <li>On the first tab (Build Information), click on the choose button to the right of the
+ Main Class field. Navigate to pcgen.jar for the version we are building and select it.</li>
+ <li>Make sure the "Use Macintosh Menu Bar" is not checked, in OS 10.4 Apple changed the way
+ the menu bar in java is handled and checking this will cause the app to crash on launch in Tiger.</li>
+ <li>Make sure the "Anti-Alias Text", "Anti-alias Graphics", and "Growbox Intrudes" checkboxs are all checked.</li>
+ <li>Make sure the JVM version is 1.4+</li>
+ <li>Switch to the Properties tab.</li>
+ <li>In the Type field, verify that it is APPL.</li>
+ <li>In the Signature Field Enter "PCGn" (without the quotes).</li>
+ <li>In the Identifier field, enter: com.codemonkey.pcgen </li>
+ <li>In the Get-Info String field, enter the full version of the release (PCGen 5.16.1 for example)</li>
+ <li>In the Short Version field, enter just the version number of the release (5.16.1 for example)</li>
+ <li>In the VM Options field enter: -Xms128m -Xmx512m (this is the memory defaults for the build)</li>
+ <li>In the Bundle Name field, enter: PCGen <version number> (this is the name of the app)</li>
+ <li>Make sure that "Set Working Directory to Inside Application Package" is checked.</li>
+ <li>Switch back to the Build Information tab and click Choose Icon, navigate to "PCGenApp.icns"
+ in the mac-installer/graphics/icon folder. You may have to paste it on the app after it is built
+ anyway, I've found that it does not always stick for some reason.</li>
+ <li>Click the Create Application button. Save the application as PCGen <version number>.app into
+ the folder you downloaded off of SF.</li>
+ </ol>
+
+ <p class="indent0">This will encapsulate the PCGen jar file into an OS X application. We then need to
+ add the applications sub folders into the PCGen application package.</p>
+
+ <h2>Step 3: Adding All Sub-Folders to the Application</h2>
+
+ <ol style="list-style-type: upper-alpha">
+ <li>Navigate (in Finder) to the folder where you put PCGen.app</li>
+ <li>Right click on the application icon, and choose Show Package Contents from the contextual menu.</li>
+ <li>Navigate to ./Contents/Resources/Java within the application package.</li>
+ <li>Move the sub folders from the PCGen folder into the Java folder listed above (and keep a
+ clean copy of the filepaths.ini file). You should end up with the following files and
+ folders in the Java directory:
+ <ul>
+ <li>characters/</li>
+ <li>data/</li>
+ <li>docs/</li>
+ <li>filepaths.ini</li>
+ <li>lib/</li>
+ <li>logging.properties</li>
+ <li>outputsheets/</li>
+ <li>pcgen.jar</li>
+ <li>plugins/</li>
+ <li>system/</li>
+ </ul>
+ </li>
+ <li>Close the application package window. Launch PCGen, verify that basic functionality is there.
+ If you did not check "Set Working Directory to Inside Application Package" in the Jar Bundler
+ things will appear terribly wrong at this point.</li>
+ </ol>
+
+ <p class="sidebar1">Note: Once you have verified that PCGen is working as it should, quit the program
+ and go back into /Contents/Resources/Java and remove the .ini preference files that may have been
+ created when you ran the program and replace the filepaths.ini file with a clean copy as your testing
+ will have changed it's contents.</p>
+
+
+ <h2>Step 4: Disk Image Creation</h2>
+
+ <p class="indent0">The Mac build of PCGen is delivered on a .dmg disc image, you can either create a
+ new disc image or you can use one of the existing installer images (recommended).</p>
+
+ <p class="indent0">To create a new disc image:</p>
+ <ol style="list-style-type: upper-alpha">
+ <li>Launch /Applications/Utilities/Disk Utility.</li>
+ <li>Click on the New Image button in the toolbar of the main window.</li>
+ <li>Name this image "Install PCGen.dmg" (without the quotes). </li>
+ <li>Make the size 100 MB.</li>
+ <li>Set the Encryption to "none".</li>
+ <li>Set the Format to "read/write disc image".</li>
+ </ol>
+
+ <p class="indent0">To use an existing Mac build disc image:</p>
+ <ol style="list-style-type: upper-alpha">
+ <li>Launch /Applications/Utilities/Disk Utility.</li>
+ <li>Click on the Convert button in the toolbar of the main window.</li>
+ <li>Select the disc image you want to convert</li>
+ <li>Name the new image "Install PCGen.dmg" (without the quotes).</li>
+ <li>Set the Image Format to "read/write"</li>
+ <li>Set the Encryption to "none"</li>
+ </ol>
+
+ <p class="indent0">Now you have an uncompressed read/write disc image to work with. I reuse this
+ same image each time I put the Mac build together so you may only need to do step 4 once.</p>
+
+
+ <h2>Step 5: Disk Image Preparation</h2>
+
+ <p class="indent0">Next we'll place the new version on the image:</p>
+ <ol style="list-style-type: upper-alpha">
+ <li>Mount the Install PCGen.dmg disk image.</li>
+ <li>Delete the previous app (if you are reusing a disc image) and empty the trash.</li>
+ <li>Copy the PCGen_folder_background.png file to the image, in the finder with the disc
+ image window selected choose menu: View > Show View Options (Command J). For Background
+ click Picture and Select PCGen_folder_background.png (you won't need to do this if you
+ are reusing a disc image which already has the background image in place.</li>
+ <li>Copy the new version of PCGen to the disc image.</li>
+ <li>Open the Release Notes.rtfd file on the disc image with Text Edit. Open the html release
+ notes that came with the the pcgen.jar file also with Text Edit, Select all and Copy. Go to
+ the Release Notes.rtfd, Select All and Paste, save the file.</li>
+ <li>When you save the release notes the icon will revert to the default icon, Get Info in the
+ Release Notes.rtfd and Read Me.rtfd files and copy the custom icon from Read Me.rtfd to the
+ Release Notes.rtfd file.</li>
+ <li>Unmount/Eject the Image.</li>
+ </ol>
+ <p class="indent0">You now need to create the final, compressed disc image. In Disk Utility click
+ on the Convert button in the toolbar of the main window.</p>
+ <ol style="list-style-type: upper-alpha">
+ <li>Select "Install PCGen.dmg" disc image.</li>
+ <li>In the Save As: Field, enter a file name of pcgenXXX_mac_install.dmg
+ <li>Set the Image Format to "compressed"
+ <li>Set the Encryption to "none"
+ </ol>
+
+ <h2>Step 6: Upload to SourceForge</h2>
+
+ <p class="indent0">You'll need to have admin access for this part so if you don't you may just need
+ to send to disk image file to James, Andrew or who ever is handling the release to put it up.</p>
+ <ol style="list-style-type: upper-alpha">
+ <li>Upload the disc image. I use SFTP (other methods are available), SourceForge has recently
+ changed things so now each project has it's own upload space. The server address is:
+ <ul style="list-style-type: none">
+ <li>frs.sourceforge.net</li>
+ <li>The user name and password are the same as your SourceForge account.</li>
+ </ul>
+ </li>
+ <li>Go to the PCGen SourceForge summary page and login (http://sourceforge.net/projects/pcgen).
+ In the Admin menu select File Releases</li>
+ <li>Click [Edit Release] for the package you want</li>
+ <li>Click [Edit This Release] for the Release Name you want</li>
+ <li>In step 2 on that page you should see the file you uploaded with a check box on it's left,
+ check it and click "Add Files and/or refresh View". The file should now appear in the file list</li>
+ <li>Set the pop up menu under "Processor" to "Platform-Independant".</li>
+ <li>Set the pop up menu under "File Type" to ".dmg".</li>
+ <li>Click "Update/Refresh"</li>
+ </ol>
+
+ <p class="indent0">Grab a beer, you're done!</p>
+
+<hr>
+
+ <h1>Creating an Installation Package</h1>
+
+ <p class="indent0">In the past we created an installer for the PCGen app but when Tiger became
+ available some user had problems with it. Because all it did was to put a copy of the program
+ in the Applications folder we discontinued this in favor of placing the program directly on
+ the disc image. This allows the user to copy the program where they want it and there is no
+ installer program to potentially fail. The installer notes are simply included on the disc
+ image as well.</p>
+
+ <p class="indent0">Although we no longer use this method I've left the instructions on how to
+ create the installation package here for those interested:</p>
+ <ol style="list-style-type: upper-alpha">
+ <li>Launch /Developer/Applications/Utilities/PackageMaker</li>
+ <li>On the Installer Interface tab, fill in relevant information for the Title and Description
+ fields (I usually just grab the PCGen boiler plate from the website for the Description field).</li>
+
+ <p class="sidebar1">PCGen is a character generator for role-playing games. It currently is aimed
+ at supporting as many RPGs as is humanly possible. The project's current focus is on OGL games
+ (OGL is Wizards of the Coast's Open Gaming License). PCGen runs on Windows, Solaris, Mac OS X,
+ and Unix/Linux using Java 1.5.</p>
+
+ <li>Click the Show Installer Interface Editor, for the background choose Custom background and
+ navigate to the /mac-installer/graphics/Installer_Background.tif image.</li>
+ <li>Unstuff the mac-installer/text/Welcome.rtfd.zip file, it's stuffed because the file is really
+ a folder which holds text and graphics and Mac just treats it as a file but SVN does not handle
+ this well. Update the file if it need it. The mini splash screen graphics can all be found in
+ mac-installer/graphics. In Introduction set Custom Welcome and choose the Welcome.rtfd file.</li>
+ <li>Open the html release notes which came with the release in TextEdit and save it as an RTF file
+ with the name ReadMe.rtf In Read Me set Custom Read Me and choose the ReadMe.rtf file you just created.</li>
+ <li>In License set Custom License and choose the mac-installer/text/License.rtf file. This should
+ not be edited. You can now close the Interface Editor by clicking the red button in the upper
+ left of the window.</li>
+ <li>Create a new folder, it's name does not matter, it only matters that it is new. Move the PCGen.app
+ into it, the contents of this folder is what the installer will be installing so it should only
+ contain the app.</li>
+ <li>On the Contents tab, click on the Choose button to the right of the Root field. Navigate to the
+ folder you have the PCGen folder in. Be sure that Compress Archive folder and Remove .DS_Store
+ Files from Archive are checked.</li>
+ <li>On the Configuration tab, enter "/Applications" (without the quotes) in the Default Location field.</li>
+ <li>Set the Authorization Action to None. Set the Post-Install Action to None.</li>
+ <li>Check the boxes for Relocatable and Follow Symbolic Links. All of the other Flags checkboxes should be off.</li>
+ <li>On the Package Version tab, in the Identifier field, enter com.codemonkey.pcgen.</li>
+ <li>Enter relevant information in the Get-Info String and Short Version fields.</li>
+ <li>From the Project menu, choose Build. Save the file as PCGen XXX Installer.pkg</li>
+ <li>Test your creation, make sure it creates the PCGen app in your Applciations folder, and that all of
+ the files are installed. I would launch PCGen for additional testing, just to make sure.</li>
+ </ol>
+
+ <p class="indent0">We now have a nicely bundled installer package.</p>
+
+<hr>
+
+ <p>
+ <a href="http://validator.w3.org/check?uri=referer"><img
+ src="../../docs/images/system/valid-html401.png"
+ alt="Valid HTML 4.01 Strict" height="31" width="88"></a>
+ </p>
+
+ </body>
+
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|