Introduction to PNDs - Revision history

Edlee: /* How Do I Make .PNDs? */

2013-12-15T09:16:18Z

‎How Do I Make .PNDs?

Kingu: merged cookbook

2013-10-29T00:20:40Z

merged cookbook

Kingu: merged info from mount pnds

2013-10-25T21:07:05Z

merged info from mount pnds

Kingu at 09:04, 10 October 2013

2013-10-10T09:04:46Z

Kingu: merged PND:FAQ

2013-10-09T05:49:36Z

merged PND:FAQ

Kingu at 05:22, 9 October 2013

2013-10-09T05:22:01Z

Levi: First attempt at merging this mess

2013-09-09T16:48:26Z

First attempt at merging this mess

Show changes

Kingu at 11:41, 19 August 2013

2013-08-19T11:41:22Z

Kingu: Merged PND quickstart which will be deleted

2013-08-19T11:40:19Z

Merged PND quickstart which will be deleted

Remex: Added hint for unsquashfs

2012-05-02T13:14:19Z

Added hint for unsquashfs

@@ Line 244: / Line 244: @@
 * drop the executable and data files into this dir (say, ./mame-app/mame.bin, and ./mame-app/artwork/foo, etc.) <- note, with a PXML.xml and executable, your Pandora can now find and run your app without even bundling it into a .pnd!
-* invoke /usr/pandora/scripts/pnd-make.sh (or on Windows, various commands in the command-line) to produce mame4all-pandora-1.0-arm.pnd or whatever you want to call it (foobearspanky.pnd, we don't care.)
+* invoke /usr/pandora/scripts/pnd_make.sh (or on Windows, various commands in the command-line) to produce mame4all-pandora-1.0-arm.pnd or whatever you want to call it (foobearspanky.pnd, we don't care.)
 * you're done, distribute it as you see fit

@@ Line 56: / Line 56: @@
 So you might put Hatari into the menu (/pandora/menu/Hatari131.pnd), or into the desktop (/pandora/desktop/Hatari131.pnd), or somewhere else. Regardless, the appdata will be (with the version I'm building now), /pandora/appdata/hatari.skeezix and thus you would put your .ST or .MSA disk images into /pandora/appdata/hatari.skeezix/disks to make them visible to the emulator. However, given it features its own UI, you can put them into /roms/atarist or /disks or whatever, and use them from there.
 = Advanced topics =
@@ Line 183: / Line 327: @@
 TBD
 ==The PND system==

@@ Line 225: / Line 225: @@
 ===How do I launch a PND application without putting it in a special location?===
 :If you open a PND file in your file manager, the first application in the PND will be launched without you having to move the PND file.
 ===How do I choose where the shortcut icons for a PND appear?===

← Older revision		Revision as of 09:04, 10 October 2013
Line 1:		Line 1:
	{{IntroNote\|For developers: [[Libpnd hub]]}}		{{IntroNote\|For developers: [[Libpnd hub]]}}
−
−	~~{{merge\|PND:FAQ}}~~

	A .pnd ("pandora") file is an application (game, word processor, emulator, whatever.) More accurately, it is a full application bundled up into a single file; think of it like a zip, with a relatively well defined internal structure.		A .pnd ("pandora") file is an application (game, word processor, emulator, whatever.) More accurately, it is a full application bundled up into a single file; think of it like a zip, with a relatively well defined internal structure.

@@ Line 184: / Line 184: @@
 TBD
 [[Category:PND]]
 [[Category:FAQ]]

@@ Line 3: / Line 3: @@
 {{merge|PND:FAQ}}
-A [[.pnd]] ("pandora") file is an application (game, word processor, emulator, whatever.) More accurately, it is a full application bundled up into a single file; think of it like a zip, with a relatively well defined internal structure.
+A .pnd ("pandora") file is an application (game, word processor, emulator, whatever.) More accurately, it is a full application bundled up into a single file; think of it like a zip, with a relatively well defined internal structure.
 The pnd-file system was designed so you could use an application without the hassle of installation or uninstallation, or even having to organize it yourself if you don't want to. You just download or obtain the pnd-file, and use it.
@@ Line 34: / Line 34: @@
 |}
-These locations are not written in stone. The [[libpnd]] config files are in /etc/pandora/conf in the [[NAND]]. Generally you will never need to alter these files, but you certainly can if you wish. In theory, obliterating the files will still leave the system working, and they are easily restored. One file, /etc/pandora/conf/desktop defines the "search paths" to look for .pnd files, and where to put ".desktop" files when they are found. The searchpaths says where to find them (such as /pandora/desktop), and where to put the application link - /usr/share/applications is where the menu items are pulled from. IF you wish to put pnd files somewhere not in the searchpath, just add the directory to the search-path and you're good to go.
+These locations are not written in stone. The libpnd config files are in /etc/pandora/conf in the [[NAND]]. Generally you will never need to alter these files, but you certainly can if you wish. In theory, obliterating the files will still leave the system working, and they are easily restored. One file, /etc/pandora/conf/desktop defines the "search paths" to look for .pnd files, and where to put ".desktop" files when they are found. The searchpaths says where to find them (such as /pandora/desktop), and where to put the application link - /usr/share/applications is where the menu items are pulled from. IF you wish to put pnd files somewhere not in the searchpath, just add the directory to the search-path and you're good to go.
 NOTE: You can actually put subdirectories into those locations above, should you wish to organize your pnd-files somehow within those larger categories.
@@ Line 63: / Line 63: @@
 == I want to override the .PND icon, name, or other settings, how is this done?  ==
-The easiest way right now is via the "override" (or "overlay") system -- [[.ovr]] files.
+The easiest way right now is via the "override" (or "overlay") system -- .ovr files.
 An [[.ovr]] is just a text file you create, with the same name as the pnd-file and in the same location, but with a different file extension. Piece of cake.
@@ Line 70: / Line 70: @@
 If you wish to provide your own icon, create it with the same location and filename, but as a .png file: /pandora/desktop/Hatari.png
-.ovr files are automatically supported by the system so should work across all pnd-application aware applications and desktops. .png icon overrides have to be handled by the menus, but are already handled by minimenu and anything using the .desktop system (such as [[xfce]] full desktop or other standard desktop environments.)
+.ovr files are automatically supported by the system so should work across all pnd-application aware applications and desktops. .png icon overrides have to be handled by the menus, but are already handled by minimenu and anything using the .desktop system (such as [[XFCE]] full desktop or other standard desktop environments.)
 An ovr-file simply looks like this:

@@ Line 107: / Line 107: @@
 You could also install 7zip on your home PC, change the .pnd's file extension to .sfs, and 7zip should be able to open it. (This is a simple way to look into a .pnd on Ubuntu: <code>unsquashfs FILE.pnd</code> needs squashfs-tools installed) [http://boards.openpandora.org/index.php?/topic/3594-pnd-criticism/page__view__findpost__p__62546] On the Pandora, you can run a PND and look at what's inside [[Basic Linux Guide|/mnt/tmp]]. To do this in a terminal (on PC or Pandora), see [http://www.gp32x.com/board/index.php?/topic/58937-how-to-mount-a-pnd-and-see-the-gooey-bits-inside/ this tutorial].
 {{IntroNote | The following is a work in progress, the instructions in here may or may not work for you. It was taken from PND quickstart.
 This page is a quickstart to packaging an existing directory tree as a PND for distribution.

← Older revision		Revision as of 11:40, 19 August 2013
Line 106:		Line 106:

	You could also install 7zip on your home PC, change the .pnd's file extension to .sfs, and 7zip should be able to open it. (This is a simple way to look into a .pnd on Ubuntu: <code>unsquashfs FILE.pnd</code> needs squashfs-tools installed) [http://boards.openpandora.org/index.php?/topic/3594-pnd-criticism/page__view__findpost__p__62546] On the Pandora, you can run a PND and look at what's inside [[Basic Linux Guide\|/mnt/tmp]]. To do this in a terminal (on PC or Pandora), see [http://www.gp32x.com/board/index.php?/topic/58937-how-to-mount-a-pnd-and-see-the-gooey-bits-inside/ this tutorial].		You could also install 7zip on your home PC, change the .pnd's file extension to .sfs, and 7zip should be able to open it. (This is a simple way to look into a .pnd on Ubuntu: <code>unsquashfs FILE.pnd</code> needs squashfs-tools installed) [http://boards.openpandora.org/index.php?/topic/3594-pnd-criticism/page__view__findpost__p__62546] On the Pandora, you can run a PND and look at what's inside [[Basic Linux Guide\|/mnt/tmp]]. To do this in a terminal (on PC or Pandora), see [http://www.gp32x.com/board/index.php?/topic/58937-how-to-mount-a-pnd-and-see-the-gooey-bits-inside/ this tutorial].
		+
		+	{{IntroNote \| The following is a work in progress, the instructions in here may or may not work for you. It was taken from PND quickstart.
		+
		+	This page is a quickstart to packaging an existing directory tree as a PND for distribution.
		+
		+	== PND generation overview ==
		+
		+	* create a directory to represent the application on SD card; i.e.: ./mame-app
		+
		+	* create a PXML.xml file and drop it into the dir (./mame-app/PXML.xml); genpxml script can be used, or do it by hand
		+
		+	* drop the executable and data files into this dir (say, ./mame-app/mame.bin, and ./mame-app/artwork/foo, etc.)''' <- note, with a PXML.xml and executable, it can now be discovered and run without even bundling into .pnd!'''
		+
		+	* invoke pnd-make.sh (or on Windows, various commands in the command-line) to produce mame4all-pandora-1.0-arm.pnd or whatever you want to call it (foobearspanky.pnd, we don't care.)
		+
		+	* you're done, distribute it as you see fit
		+
		+	== Preparations ==
		+
		+	When GUI tools get released, they may simplify these steps. However, until then you must do the following:
		+
		+	# Make a PXML.xml file (through whatever means; copy a template, or get a PXML.xml tool when they come available.) Ensure that you've got a reasonably unique-id in that field (ie: say, app-name, your name, and date/time all catenated together.) Check out the [[PXML specification]], as well as this [[PXML_archetype\|example file.]]
		+	# Put your application and all needed files into a single directory .. say "myapp"; it doesn't matter what you call it.
		+	# In your app-dir, put the PXML.xml file in the root
		+	# Put the icon in the root of that dir as well (make it a .png file)
		+	# Make sure the PXML.xml names the icon (just its filename.png), and specifies the executable (foo.bin or whatever.)
		+
		+	== Making PND files ==
		+
		+	=== Windows / DOS ===
		+
		+	==== Command-line ====
		+
		+	There should be a basic GUI along very soon, and more advanced friendlier GUIs in due time. But for now, we thought it prudent to include some basic instructions on the command line for day-zero.
		+
		+	For this command-line tutorial, I will assume you have already created a PXML.xml file; copy one of the templates and then edit it, using notepad or whatever _TEXT_ editor you see fit.
		+
		+	===== Windows specific preparations =====
		+	Get yourself mkisofs tools; for example, grab from here: http://www.student.tugraz.at/thomas.plank/ -- get cdrtools-2.01-win32-bin.zip and DLL version 1.5.25, and extract to somewhere. That lets you run 'mkisofs' to spit out .iso files
		+
		+	''If you want to make a compressed image, use squashfs tools here: ftp://ftp.slax.org/useful-binaries/win32/squashfs-tools/''
		+
		+	===== Generate the actual PND-file =====
		+
		+	Make yourself the iso; this step produces the iso, but to turn the iso into a pnd you need a couple last steps. You could also use some fancy iso-building tool.
		+	<pre>mkisofs -o foo.iso -R /path/to/folder/myapp</pre>
		+
		+	Append PXML.xml to the .iso (yes, the PXML.xml is included in the iso, but we also want to append it for performance reasons.)
		+	<pre>copy foo.iso+PXML.xml foo.step2</pre>
		+
		+	Append the icon PNG file to the .iso (if you have an icon; if not, you can leave this step out.)
		+	<pre>copy foo.step2+myicon.png foo.pnd</pre>
		+
		+	Clean up:
		+	<pre>del foo.step2 foo.iso</pre>
		+
		+	Profit!
		+
		+	==== GUI ====
		+
		+	You have a few choices here:
		+	*'''PNDTools''' by foxblock. Discussion: [http://boards.openpandora.org/index.php?/topic/3756-pndtools/ OP], [http://www.gp32x.com/board/index.php?/topic/60060-pndtools/ GP32X]. Can browse and create PNDs. Two (simple and advanced) editors for PXML creation.
		+	*'''PNDBuilder''' by StreaK. [http://www.gp32x.com/board/index.php?/topic/59862-openpandora-pnd-builder-for-windows-linux/ Discussion] [http://www.gp32x.com/board/index.php?/topic/47088-pnd-builder-for-windows/ (old)]. Can create PNDs and edit PXML files.
		+	*'''PNDManager''' by Speaker Ender. [http://boards.openpandora.org/index.php?/topic/3805-pnd-manager/ Discussion].
		+	*'''PNDbuilder''' by freedomdown. [http://www.gp32x.com/board/index.php?/topic/58587-pndbuilder/ Discussion].
		+
		+	=== Linux/BSD/Unix (including on Pandora) ===
		+
		+	==== Command-line ====
		+
		+	Tools are included in the libpnd distribution; see below for discussion, but suffice to say they are included in the [http://git.openpandora.org/cgi-bin/gitweb.cgi?p=pandora-libraries.git;a=tree;f=testdata/scripts GIT]. Look in testdata/scripts for:
		+
		+	* genpxml - spits out a template PXML.xml for you, and even includes a reasonably unique-id
		+	* pnd_make.sh - given a directory and some arguments, will spit out a .pnd file; great for use in Makefiles
		+
		+	We're working on others as well, so it should be a piece of cake under Unix and Unix-like OSes.
		+
		+	==== Command-line (alternate instructions) ====
		+
		+	For these instructions, you will first need to grab the example file, [http://www.shiranui.in/pndexample.tar.gz here].
		+
		+	* Edit ./pnds.sh. I use that script to handle multiple apps at once. Each line represents a command line for an app / game to turn the directory into a PND. If I change the app / game, I simply uncomment the line in pnds.sh so that I can easily create or update multiple PNDs by simply running one single script.
		+	* Run ./pnds.sh
		+	* Upload
		+
		+	Don't forget to check the license conditions for anything you re-distribute.
		+
		+	==== GUI ====
		+	*'''PNDbuilder''' by freedomdown. [http://www.gp32x.com/board/index.php?/topic/58587-pndbuilder/ Discussion]. [http://www.freedomdown.ca/storage/pndb.pnd Download v1.1 for Pandora].
		+
		+	=== Mac OSX ===
		+
		+	TBD
		+
		+	== Example PNDs ==
		+
		+	You can look at an example PND file to help you out if you're struggling with the above steps. Download one or several PNDs (preferably from the [http://repo.openpandora.org/ Repo], as it forces strict PXML standards), and use [http://boards.openpandora.org/index.php?/topic/3756-pndtools/ PNDTools] to open them and see how they're organised inside, what the PXML file looks like, and so on.
		+
		+	The [[PND Cookbook]] contains recipes for common PND tasks, like setting up your application's environment and configuration, locating and copying files, etc.
		+

	== More Info About .PNDs ==		== More Info About .PNDs ==

@@ Line 105: / Line 105: @@
 To open a PND, the easiest way is probably to use the [http://boards.openpandora.org/index.php?/topic/3756-pndtools/ PNDTools] or [http://boards.openpandora.org/index.php?/topic/3805-pnd-manager/ PNDManager] programs, which can browse and create PNDs. They're Windows-only, currently.
-You could also install 7zip on your home PC, change the .pnd's file extension to .sfs, and 7zip should be able to open it. [http://boards.openpandora.org/index.php?/topic/3594-pnd-criticism/page__view__findpost__p__62546] On the Pandora, you can run a PND and look at what's inside [[Basic Linux Guide|/mnt/tmp]]. To do this in a terminal (on PC or Pandora), see [http://www.gp32x.com/board/index.php?/topic/58937-how-to-mount-a-pnd-and-see-the-gooey-bits-inside/ this tutorial].
+You could also install 7zip on your home PC, change the .pnd's file extension to .sfs, and 7zip should be able to open it. (This is a simple way to look into a .pnd on Ubuntu: <code>unsquashfs FILE.pnd</code> needs squashfs-tools installed) [http://boards.openpandora.org/index.php?/topic/3594-pnd-criticism/page__view__findpost__p__62546] On the Pandora, you can run a PND and look at what's inside [[Basic Linux Guide|/mnt/tmp]]. To do this in a terminal (on PC or Pandora), see [http://www.gp32x.com/board/index.php?/topic/58937-how-to-mount-a-pnd-and-see-the-gooey-bits-inside/ this tutorial].
 == More Info About .PNDs ==