pyBrush 0.2readme
=================


This is pyBrush*, a simple drawing program for the Gamepark Holdings GP2x.

It's written in Pygame, so you'll need theoddbot's Python and Pygame package.  You can find info about that here: http://www.gp32x.com/board/index.php?showtopic=22505&hl=

This version has these new features:
- Image loading.  You can now load a picture from anywhere on the SD card or the GP2X NAND memory, then draw all over it!
- Onscreen keyboard for entering filenames when you save images
- Undo - You can now undo the last 10 changes to your picture.



Installation
------------

To install the program, make sure you have GP2x Python installed, then copy the entire 'pybrush' directory into the root directory of your SD card.  You can put it somewhere else if you want to, but then you'll have to edit the .GPE file to match the new location.


Controls
--------

To access the menu, hold down one of the shoulder buttons.  Then move the joystick to select the option you want.  The menu will disappear when you let go of the shoulder button.  I did it that way to keep the full screen size available for your creations.

L/R - Show menu while held
B - Draw/activate tool
Y - Turn curosr inertia off (explained under 'speed' below)
SELECT - Undo last action, up to ten actions.
START - Show controls help screen




Menu options
------------

Pens - Pick the shape and size of the current pen.  This setting is also used to set the line width for shapes picked from the shapes menu

Colours - Pick current pen/shape drawing colour

Shapes - Lines,rectangles, circles, ellipses, all those but filled

Speed - This setting controls the speed of the cursor.  It's in there to help make it easier to control the cursor with the joystick.  When not in the menu, you can hit button Y to turn cursor inertia on or off.  When that setting is on, the cursor will keep moving until you release the joystick.  With it off, the cursor will only move the number of pixels indicated by the speed setting, giving you better but slower control.


File Menu
---------

New - Clears the screen

Load - Takes you to the file browser, which lets you load PNG, JPG, BMP or GIF images from anywhere on the GP2X or your SD card.  If the image is too big for the screen, it'll be resized to fit.  Hit the select button to preview an image before leaving the load screen.

Save - Saves your picture into the directory /mnt/sd/pybrush/saves as a .BMP.  An onscreen keyboard will pop up so you can enter the first part (no extension) of the filename.  If you enter a filename that already exists, it'll overwrite the old file.  All saved images end up in the 'saves' directory.

Quit - Exit pyBrush.


To do list
----------

Next on the to do list is layers, transforms (rotate, flip, resize etc), cut and paste, hopefully simple animations, maybe flood fill if I find a way of doing it that's quick enough, maybe a clone tool.  I'm hoping to at least get the feature set to the stage where you can do headswaps!  :O)


If you hit any problems or have ideas for other things that could be improved, please get in touch.  

Have fun!
barnesy@juggler.net
15th December 2005


* No, he wasn't the guy in Monkey Island.