PickleLauncher - Revision history

Gruso: /* Adding a skin */ oops, forgot a thing

2011-10-12T12:08:45Z

‎Adding a skin: oops, forgot a thing

Gruso: /* Configuration File: config.txt */ add skinning info

2011-10-12T12:06:56Z

‎Configuration File: config.txt: add skinning info

ABC: /* Configuration File: config.txt */ cat

2011-04-19T15:28:01Z

‎Configuration File: config.txt: cat

Pickle: /* Summary */

2011-03-06T22:28:13Z

‎Summary

Pickle at 21:17, 28 February 2011

2011-02-28T21:17:31Z

Pickle at 20:28, 28 February 2011

2011-02-28T20:28:51Z

Pickle: /* profile.txt */

2011-02-28T20:04:31Z

‎profile.txt

Pickle: /* profile.txt */

2011-02-28T20:01:03Z

‎profile.txt

Pickle at 19:54, 28 February 2011

2011-02-28T19:54:03Z

Pickle at 19:38, 28 February 2011

2011-02-28T19:38:27Z

@@ Line 213: / Line 213: @@
 |-
 |button_cfg_item.png
-|Edit
+|Edit Item
 |-
 |-

@@ Line 190: / Line 190: @@
 ==Configuration File: config.txt==
-NOTE: picklelauncher has built in defaults, it is suggested that you use these values. But if something isnt quite the way you want, like
+NOTE: PickleLauncher has built in defaults, it is suggested that you use these values. But if something isn't quite the way you want, such as colour, use this file to customize the GUI.
 See the config.txt for details. If you do not see a config.txt run the launcher once and one will be generated.
 [[Category:Documentation]]
 [[Category:Software]]
 [[Category:Emulators]]

← Older revision		Revision as of 15:28, 19 April 2011
Line 196:		Line 196:
	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:Software]]		[[Category:Software]]
		+	[[Category:Emulators]]

@@ Line 5: / Line 5: @@
 PickleLauncher is designed to a simple but flexible frontend for autodetecting and configuring
 command line based applications that might have different input files, like emulators.
 ===How it works===

@@ Line 3: / Line 3: @@
 ==Summary==
-PickleLauncher is designed to a simple frontend for autodetecting and configuring
+PickleLauncher is designed to a simple but flexible frontend for autodetecting and configuring
 command line based applications that might have different input files, like emulators.
 ===How it works===
 PickleLauncher looks for its configuration from the config.txt and profile.txt.
-profile.txt specifies location, file types, commands, arguments, and entries.
+Profile.txt specifies location, file types, commands, arguments, and entries. Config.txt contains options for the application gui and input.
-config.txt contains options for the application gui and input.
+The launcher will use the information given and scan the current path for files that can be launched with the target application and present them to the user. The user can modify options (passed by argument flags) for all entries or for one specific entry. When an entry is selected the user can launch the file. PickleLauncher constructs a command line script which is set to trigger once the launcher is quit. Once the user quits the target application the script has execution command to reload PickleLauncher. The user can choose to select, edit, or quit PickleLauncher.
 ===Source and Project Information===
@@ Line 53: / Line 53: @@
 All devices that support it can do all controls through the screen through click-able buttons.
 The touchscreen can also select entries directly through the entry list.
 ====Buttons on Left-hand Side====
   <       : one up
@@ Line 62: / Line 61: @@
   D       : one directory level down
   Z       : switch zip mode from extraction of all files to only the selected file
 ====Buttons on Right-hand Side====
 *Mode Select Entry/Browse
   Edit Item (2) : will open a list to select an command or argument that then can be selected and the assigned value changed. Directories are highlighted in red and files are black.
   Launch    (1) : will launch the current item if an input file, if a directory is selected the selector will go down into the folder. If dirs exepath is defined then directories will become launchable and editable.
 *Mode Select Argument
   Select    (2) : selects the argument for the command or extension and reads in possible values for selection.
   Back      (1) : returns to the entry/browse selection mode
 *Mode Select Argument Value*
   Set       (3) : the selected value will be set for this entry. This will trigger a custom entry to be saved in the profile.txt. Current selected value is in red.
   Default   (2) : the selected value will be set for all entries. Current default is marked by the star character *.
   Back      (1) : Returns to the argument selection mode
 *Common
   Quit      (0) : quits the launcher
@@ Line 83: / Line 77: @@
 ==Features==
 ===Zip Support===
-Zips are treated like a folder. When selected the launcher will read the zip and display any contents that match a defined extenstion. If a file inside the zip is chosen then the launcher will extract all content from the zip into the configurable zip path. Upon quiting the launcher will delete any extracted files from the zip path. Extracted files are recorded in the ziplist.txt.
+Zips are treated like a folder. When selected the launcher will read the zip and display any contents that match a defined extenstion(s). If a file inside the zip is chosen then the launcher will extract the file(s) from the zip into the configurable zip path. Upon quiting the launcher will delete any extracted files from the zip path. Extracted files are recorded in the ziplist.txt, so if the launcher has an error on the next time PickleLauncher runs the files will be deleted.
 ==Configuration File: profile.txt==
-''profile.txt'' describes the behavior of PickleLauncher. It offers several settings that can be configured to more precisely set how the launcher should behave and interact with the user.
+''profile.txt'' describes the behavior of PickleLauncher. It offers several settings that can be configured to more precisely set how the launcher should behave and interact with the user. It must be constructed by hand before PickleLauncher can be of use.
 ====Global Settings====
@@ Line 95: / Line 89: @@
   filepath=<path>
-''<path>'' specifies the initial path where the launcher should look for the input files. A good starting point (for the Pandora) is probably ''/media''. In general it can look like this: ''filepath=/mnt/sd/roms'' or ''filepath=roms''.
+''<path>'' specifies the initial path where the launcher should look for the input files. A good starting point (for the Pandora) is probably ''/media'' or ''./''. In general it can look like this: ''filepath=/mnt/sd/roms'' or ''filepath=roms'' or ''filepath=./''
 ====Command Settings====
 Commands can be any binary or script with its own arguments (1 or more) that will be run prior to running the target application.
   <command name>
 Identifies the beginning of a command and its name for display in the GUI, i.e ''<CPU Speed>''. Inside those blocks additional things have to be listed:
   cmdpath=<path>
-This is the path to the binary command that will be run before the target application is executed. i.e ''cmdpath=/bin/to/somwhere/cpuset''
+This is the path to the binary command that will be run before the target application is executed. i.e ''cmdpath=/bin/to/somewhere/cpuset''
-  cmdarg=<argument>;<default>;<option label0>;<option value0>;<option label1>;<option value1>;...
 This defines an argument with a default value and all possible values. Here is an explanation of what the things are supposed to mean:
 * ''<argument>'': Flag string

@@ Line 3: / Line 3: @@
 ==Summary==
-PickleLauncher is meant to a simple frontend for autodetecting and configuring
+PickleLauncher is designed to a simple frontend for autodetecting and configuring
 command line based applications that might have different input files, like emulators.
 ===How it works===
 PickleLauncher looks for its configuration from the config.txt and profile.txt.
 profile.txt specifies location, file types, commands, arguments, and entries.
 config.txt contains options for the application gui and input.
 ===Source and Project Information===
-Links to the source can be found on the sf.net project page:
+PickleLauncher source code is released under gplv3 see COPYING.txt for license details. Access to a copy of the source can be found on the sf.net project page:
-https://sourceforge.net/projects/picklelauncher/
+http://sourceforge.net/projects/picklelauncher/
 If you redistribute I request (but not require) that all documentation is included. If the DejaVu font is not included
 then the license is not required.
-Patches and suggestions for improvement are welcome
+Patches and suggestions for improvement are welcome.
 ===References===
 *DejaVu font is Copyright (C) by Bitstream Vera Fonts (if included) see "DejaVu Fonts License.txt" for license details
 *Zip support uses minizip by Gilles Vollant and Mathias Svensson see "MiniZip64_info.txt" for license details
-*Portions of the exec support was based on Gmenu2x by Massimiliano Torromeo which is released under gplv2 see http://github.com/mtorromeo/gmenu2x/blob/master/COPYING for license details
+*Portions of the exec support was based on Gmenu2x by Massimiliano Torromeo which is released under gplv2 see the following link for license details:
 ===Library Dependencies===
 *zlib
@@ Line 26: / Line 29: @@
 *SDL_ttf
 *SDL_image
 ==Controls==
 ===PANDORA/PC===
-*one up          : up
+ one up          : up
-*one down        : down
+ one down        : down
-*page up         : left
+ page up         : left
-*page down       : right
+ page down       : right
-*dir up          : left shoulder
+ dir up          : left shoulder
-*dir down        : right shoulder
+ dir down        : right shoulder
-*quit            : escape
+ quit            : escape
-*launch/select   : enter
+ launch/select   : enter
 ===GP2X/WIZ/CAANOO===
-*one up          : up
+ one up          : up
-*one down        : down
+ one down        : down
-*page up         : left
+ page up         : left
-*page down       : right
+ page down       : right
-*dir up          : left shoulder
+ dir up          : left shoulder
-*dir down        : right shoulder
+ dir down        : right shoulder
-*quit            : select
+ quit            : select
-*launch/select   : start
+ launch/select   : start
 ===Mouse and Touchscreen===
-All devices that support it can do all controls through the screen.
+All devices that support it can do all controls through the screen through click-able buttons.
-The buttons on the left do the following from top to bottom:
+The touchscreen can also select entries directly through the entry list.
-*<       : one up
-*>       : one down
+====Buttons on Left-hand Side====
-*<<      : page up
+ <       : one up
-*>>      : page down
+ >       : one down
-*U       : one directory level up
+ <<      : page up
-*D       : one directory level down
+ >>      : page down
-*Z       : switch zip mode from extraction of all files to only the selected file
+ U       : one directory level up
-===Buttons on the right side from top to bottom===
+====Buttons on Right-hand Side====
 *Mode Select Entry/Browse
-*Edit Item : will open a list to select an command or argument that then can be selected and the assigned value changed. Directories are highlighted in red and files are black.
+ Edit Item (2) : will open a list to select an command or argument that then can be selected and the assigned value changed. Directories are highlighted in red and files are black.
-*Launch    : will launch the current item if an input file, if a directory is selected the selector will go down into the folder. If dirs exepath is defined then directories will become launchable and editable.
+ Launch    (1) : will launch the current item if an input file, if a directory is selected the selector will go down into the folder. If dirs exepath is defined then directories will become launchable and editable.
-*Mode Select Argument*
+*Mode Select Argument
-*Select    : selects the argument for the command or extension and reads in possible values for selection.
+ Select    (2) : selects the argument for the command or extension and reads in possible values for selection.
-*Back      : returns to the entry/browse selection mode
+ Back      (1) : returns to the entry/browse selection mode
 *Mode Select Argument Value*
-*Set       : the selected value will be set for this entry. This will trigger a custom entry to be saved in the profile.txt. Current selected value is in red.
+ Set       (3) : the selected value will be set for this entry. This will trigger a custom entry to be saved in the profile.txt. Current selected value is in red.
-*Default   : the selected value will be set for all entries. Current default is marked by the star character *.
+ Default   (2) : the selected value will be set for all entries. Current default is marked by the star character *.
-*Back      : eturns to the argument selection mode
+ Back      (1) : Returns to the argument selection mode
 ==Features==
-*Zip Support*
+===Zip Support===
 Zips are treated like a folder. When selected the launcher will read the zip and display any contents that match a defined extenstion. If a file inside the zip is chosen then the launcher will extract all content from the zip into the configurable zip path. Upon quiting the launcher will delete any extracted files from the zip path. Extracted files are recorded in the ziplist.txt.
-==Configuration Files==
-==profile.txt==
+==Configuration File: profile.txt==
 ''profile.txt'' describes the behavior of PickleLauncher. It offers several settings that can be configured to more precisely set how the launcher should behave and interact with the user.
@@ Line 175: / Line 183: @@
 </source>
-==config.txt==
+==Configuration File: config.txt==
 NOTE: picklelauncher has built in defaults, it is suggested that you use these values. But if something isnt quite the way you want, like

@@ Line 77: / Line 77: @@
 Zips are treated like a folder. When selected the launcher will read the zip and display any contents that match a defined extenstion. If a file inside the zip is chosen then the launcher will extract all content from the zip into the configurable zip path. Upon quiting the launcher will delete any extracted files from the zip path. Extracted files are recorded in the ziplist.txt.
 ==Configuration Files==
-====profile.txt====
+==profile.txt==
 ''profile.txt'' describes the behavior of PickleLauncher. It offers several settings that can be configured to more precisely set how the launcher should behave and interact with the user.
-======Global Settings======
+====Global Settings====
 These are the settings that are global and required. These must be included.
@@ Line 89: / Line 89: @@
 ''<path>'' specifies the initial path where the launcher should look for the input files. A good starting point (for the Pandora) is probably ''/media''. In general it can look like this: ''filepath=/mnt/sd/roms'' or ''filepath=roms''.
-======Command Settings======
+====Command Settings====
 Commands can be any binary or script with its own arguments (1 or more) that will be run prior to running the target application.
@@ Line 105: / Line 105: @@
 It will add the argument ''--setcpuspeed'' to the program specified by ''cmdpath'' and as default have the first entry, which has the label ''200 MHz'' and means a parameter of ''200'' selected.
-======Extension Settings======
+====Extension Settings====
    # Extension Settings
    About                   : extensions are the key component to configuring the launcher. They link
@@ Line 145: / Line 145: @@
        <new value>
      i.e argswap=./exps/are/here/,1,exp1.rom
-======Custom Entries Settings======
+====Custom Entries Settings====
    # Custom Entries Settings
    About                     : Entries are used to store custom values for any detected entry.
@@ Line 161: / Line 161: @@
        i.e entryargs=0;3;2
-======Example======
+====Examples====
 This is the profile.txt file that is used with snes9x4p to allow support for the common known rom formats. It does set the default file path to /media/ and supports the file extensions ''sfc'', ''smc'', ''7z'' as well as ''zip''. For each the script ''./snes.sh'' will be executed and the filename of the selected file added. This is just the defconfig file and will be copied into appdata to be replaced by the user config file in which the last filepath will automatically be stored when exiting the program.
 <source lang="xml">

@@ Line 11: / Line 11: @@
 ===License and Redistribution===
 PickleLauncher source code is released under gplv3 see COPYING.txt for license details.
-If you redistribute I require that all documentation is included. If the DejaVu font is not included
+If you redistribute I request (but not require) that all documentation is included. If the DejaVu font is not included
 then the license is not required.
 ===Contributions===
-Patches and suggestions for improvment are welcome
+Patches and suggestions for improvement are welcome
 ===References===
 *DejaVu font is Copyright (C) by Bitstream Vera Fonts (if included) see "DejaVu Fonts License.txt" for license details
@@ Line 112: / Line 112: @@
    [ext]                     : this identifies the file type to look for. All following options will be
-                               associated with this extension only.
+                               associated with this extension only. File types can be chained.
      exepath=<path and binary : this is the path to the target application's binary file used by this
                                 extension
@@ Line 163: / Line 163: @@
 # Extension Settings
-[sfc]
+[sfc;smc;7z;zip]
 exepath=./snes.sh
 arg=,%filename%